Struct SFSpeechAudioBufferRecognitionRequest 

pub struct SFSpeechAudioBufferRecognitionRequest { /* private fields */ }

Available on crate feature SFSpeechRecognitionRequest only.

A request to recognize speech from captured audio content, such as audio from the device’s microphone.

Use an SFSpeechAudioBufferRecognitionRequest object to perform speech recognition on live audio, or on a set of existing audio buffers. For example, use this request object to route audio from a device’s microphone to the speech recognizer.

The request object contains no audio initially. As you capture audio, call append(_:) or appendAudioSampleBuffer(_:) to add audio samples to the request object. The speech recognizer continuously analyzes the audio you appended, stopping only when you call the endAudio() method. You must call endAudio() explicitly to stop the speech recognition process.

For a complete example of how to use audio buffers with speech recognition, see SpeakToMe: Using Speech Recognition with AVAudioEngine.

See also Apple’s documentation

Implementations

impl SFSpeechAudioBufferRecognitionRequest

pub unsafe fn nativeAudioFormat(&self) -> Retained<AVAudioFormat>

Available on crate feature objc2-avf-audio only.

The preferred audio format for optimal speech recognition.

Use the audio format in this property as a hint for optimal recording, but don’t depend on the value remaining unchanged.

pub unsafe fn appendAudioPCMBuffer(&self, audio_pcm_buffer: &AVAudioPCMBuffer)

Available on crate feature objc2-avf-audio only.

Appends audio in the PCM format to the end of the recognition request.

The audio must be in a native format and uncompressed.

• Parameters:
• audioPCMBuffer: An audio buffer that contains audio in the PCM format.

pub unsafe fn appendAudioSampleBuffer(&self, sample_buffer: &CMSampleBuffer)

Available on crate feature objc2-core-media only.

Appends audio to the end of the recognition request.

The audio must be in a native format.

• Parameters:
• sampleBuffer: A buffer of audio.

pub unsafe fn endAudio(&self)

Marks the end of audio input for the recognition request.

Call this method explicitly to let the speech recognizer know that no more audio input is coming.

impl SFSpeechAudioBufferRecognitionRequest

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = SFSpeechRecognitionRequest>

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.

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

Available on crate feature SFSpeechRecognitionTaskHint only.

Setter for taskHint.

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.

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

Setter for shouldReportPartialResults.

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.

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

Setter for contextualStrings.

This is copied when set.

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.

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

👎Deprecated: Not used anymore

Setter for interactionIdentifier.

This is copied when set.

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.

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

Setter for requiresOnDeviceRecognition.

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.

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

Setter for addsPunctuation.

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

Available on crate feature SFSpeechLanguageModel only.

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>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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`
    }
}

Trait Implementations

impl AsRef<AnyObject> for SFSpeechAudioBufferRecognitionRequest

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for SFSpeechAudioBufferRecognitionRequest

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<SFSpeechAudioBufferRecognitionRequest> for SFSpeechAudioBufferRecognitionRequest

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<SFSpeechRecognitionRequest> for SFSpeechAudioBufferRecognitionRequest

fn as_ref(&self) -> &SFSpeechRecognitionRequest

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for SFSpeechAudioBufferRecognitionRequest

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SFSpeechAudioBufferRecognitionRequest

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<SFSpeechRecognitionRequest> for SFSpeechAudioBufferRecognitionRequest

fn borrow(&self) -> &SFSpeechRecognitionRequest

Immutably borrows from an owned value.

impl ClassType for SFSpeechAudioBufferRecognitionRequest

const NAME: &'static str = "SFSpeechAudioBufferRecognitionRequest"

The name of the Objective-C class that this type represents.

type Super = SFSpeechRecognitionRequest

The superclass of this class.

type ThreadKind = <<SFSpeechAudioBufferRecognitionRequest as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for SFSpeechAudioBufferRecognitionRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for SFSpeechAudioBufferRecognitionRequest

type Target = SFSpeechRecognitionRequest

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for SFSpeechAudioBufferRecognitionRequest

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for SFSpeechAudioBufferRecognitionRequest

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for SFSpeechAudioBufferRecognitionRequest

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for SFSpeechAudioBufferRecognitionRequest

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for SFSpeechAudioBufferRecognitionRequest

const ENCODING_REF: Encoding = <SFSpeechRecognitionRequest as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for SFSpeechAudioBufferRecognitionRequest

impl Eq for SFSpeechAudioBufferRecognitionRequest