Struct SFSpeechURLRecognitionRequest

Source

pub struct SFSpeechURLRecognitionRequest { /* private fields */ }

Available on crate feature SFSpeechRecognitionRequest only.

Expand description

A request to recognize speech in a recorded audio file.

Use this object to perform speech recognition on the contents of an audio file.

The following example shows a method that performs recognition on an audio file based on the user’s default language and prints out the transcription.

Listing 1. Getting a speech recognizer and making a recognition request

func recognizeFile(url: URL) {
// Create a speech recognizer associated with the user's default language.
guard let myRecognizer = SFSpeechRecognizer() else {
// The system doesn't support the user's default language.
return
}

guard myRecognizer.isAvailable else {
// The recognizer isn't available.
return
}

// Create and execute a speech recognition request for the audio file at the URL.
let request = SFSpeechURLRecognitionRequest(url: url)
myRecognizer.recognitionTask(with: request) { (result, error) in
guard let result else {
// Recognition failed, so check the error for details and handle it.
return
}

// Print the speech transcription with the highest confidence that the
// system recognized.
if result.isFinal {
print(result.bestTranscription.formattedString)
}
}
}

Implementations§

Source §

impl SFSpeechURLRecognitionRequest

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn initWithURL(this: Allocated<Self>, url: &NSURL) -> Retained<Self>

Creates a speech recognition request, initialized with the specified URL.

Use this method to create a request to recognize speech in a recorded audio file that resides at the specified URL. Pass the request to the recognizer’s SFSpeechRecognizer/recognitionTask(with:delegate:) method to start recognition.

Source

pub unsafe fn URL(&self) -> Retained<NSURL>

The URL of the audio file.

Source §

impl SFSpeechURLRecognitionRequest

Methods declared on superclass NSObject.

Source

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = SFSpeechRecognitionRequest>§

Source

pub unsafe fn taskHint(&self) -> SFSpeechRecognitionTaskHint

Available on crate feature SFSpeechRecognitionTaskHint only.

A value that indicates the type of speech recognition being performed.

The default value of this property is SFSpeechRecognitionTaskHint/unspecified. For a valid list of values, see SFSpeechRecognitionTaskHint.

Source

pub unsafe fn setTaskHint(&self, task_hint: SFSpeechRecognitionTaskHint)

Available on crate feature SFSpeechRecognitionTaskHint only.

Setter for taskHint.

Source

pub unsafe fn shouldReportPartialResults(&self) -> bool

A Boolean value that indicates whether you want intermediate results returned for each utterance.

The default value of this property is true. If you want only final results (and you don’t care about intermediate results), set this property to false to prevent the system from doing extra work.

Source

pub unsafe fn setShouldReportPartialResults( &self, should_report_partial_results: bool, )

Setter for shouldReportPartialResults.

Source

pub unsafe fn contextualStrings(&self) -> Retained<NSArray<NSString>>

An array of phrases that should be recognized, even if they are not in the system vocabulary.

Use this property to specify short custom phrases that are unique to your app. You might include phrases with the names of characters, products, or places that are specific to your app. You might also include domain-specific terminology or unusual or made-up words. Assigning custom phrases to this property improves the likelihood of those phrases being recognized.

Keep phrases relatively brief, limiting them to one or two words whenever possible. Lengthy phrases are less likely to be recognized. In addition, try to limit each phrase to something the user can say without pausing.

Limit the total number of phrases to no more than 100.

Source

pub unsafe fn setContextualStrings( &self, contextual_strings: &NSArray<NSString>, )

Setter for contextualStrings.

This is copied when set.

Source

pub unsafe fn interactionIdentifier(&self) -> Option<Retained<NSString>>

👎Deprecated: Not used anymore

An identifier string that you use to describe the type of interaction associated with the speech recognition request.

If different parts of your app have different speech recognition needs, you can use this property to identify the part of your app that is making each request. For example, if one part of your app lets users speak phone numbers and another part lets users speak street addresses, consistently identifying the part of the app that makes a recognition request may help improve the accuracy of the results.

Source

pub unsafe fn setInteractionIdentifier( &self, interaction_identifier: Option<&NSString>, )

👎Deprecated: Not used anymore

Setter for interactionIdentifier.

This is copied when set.

Source

pub unsafe fn requiresOnDeviceRecognition(&self) -> bool

A Boolean value that determines whether a request must keep its audio data on the device.

Set this property to true to prevent an SFSpeechRecognitionRequest from sending audio over the network. However, on-device requests won’t be as accurate.

Note: The request only honors this setting if the SFSpeechRecognizer/supportsOnDeviceRecognition (SFSpeechRecognizer) property is also true.

Source

pub unsafe fn setRequiresOnDeviceRecognition( &self, requires_on_device_recognition: bool, )

Setter for requiresOnDeviceRecognition.

Source

pub unsafe fn addsPunctuation(&self) -> bool

A Boolean value that indicates whether to add punctuation to speech recognition results.

Set this property to true for the speech framework to automatically include punctuation in the recognition results. Punctuation includes a period or question mark at the end of a sentence, and a comma within a sentence.

Source

pub unsafe fn setAddsPunctuation(&self, adds_punctuation: bool)

Setter for addsPunctuation.

Source

pub unsafe fn customizedLanguageModel( &self, ) -> Option<Retained<SFSpeechLanguageModelConfiguration>>

Available on crate feature SFSpeechLanguageModel only.

Source

pub unsafe fn setCustomizedLanguageModel( &self, customized_language_model: Option<&SFSpeechLanguageModelConfiguration>, )

Available on crate feature SFSpeechLanguageModel only.

Setter for customizedLanguageModel.

This is copied when set.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}