Struct AVSpeechSynthesizer

Source

pub struct AVSpeechSynthesizer { /* private fields */ }

Available on crate feature AVSpeechSynthesis only.

Expand description

AVSpeechSynthesizer allows speaking of speech utterances with a basic queuing mechanism.

Create an instance of AVSpeechSynthesizer to start generating synthesized speech by using AVSpeechUtterance objects.

Implementations§

Source §

impl AVSpeechSynthesizer

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn AVSpeechSynthesizerDelegate>>>

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn AVSpeechSynthesizerDelegate>>, )

Setter for delegate.

This is a weak property.

Source

pub unsafe fn writeUtterance_toBufferCallback( &self, utterance: &AVSpeechUtterance, buffer_callback: AVSpeechSynthesizerBufferCallback, )

Available on crate features AVAudioBuffer and block2 only.

§Safety

buffer_callback must be a valid pointer.

Source

pub unsafe fn writeUtterance_toBufferCallback_toMarkerCallback( &self, utterance: &AVSpeechUtterance, buffer_callback: AVSpeechSynthesizerBufferCallback, marker_callback: AVSpeechSynthesizerMarkerCallback, )

Available on crate features AVAudioBuffer and block2 only.

Use this method to receive audio buffers and associated metadata that can be used to store or further process synthesized speech. The dictionary provided by -[AVSpeechSynthesisVoice audioFileSettings] can be used to create an AVAudioFile.

§Safety

buffer_callback must be a valid pointer.
marker_callback must be a valid pointer.

Source

pub unsafe fn stopSpeakingAtBoundary(&self, boundary: AVSpeechBoundary) -> bool

Source

pub unsafe fn pauseSpeakingAtBoundary(&self, boundary: AVSpeechBoundary) -> bool

Source

pub unsafe fn continueSpeaking(&self) -> bool

Source

pub unsafe fn outputChannels( &self, ) -> Option<Retained<NSArray<AVAudioSessionChannelDescription>>>

Available on crate feature AVAudioSessionRoute only.

Source

pub unsafe fn setOutputChannels( &self, output_channels: Option<&NSArray<AVAudioSessionChannelDescription>>, )

Available on crate feature AVAudioSessionRoute only.

Setter for outputChannels.

Source

pub unsafe fn usesApplicationAudioSession(&self) -> bool

Source

pub unsafe fn setUsesApplicationAudioSession( &self, uses_application_audio_session: bool, )

Setter for usesApplicationAudioSession.

Source

pub unsafe fn mixToTelephonyUplink(&self) -> bool

Source

pub unsafe fn setMixToTelephonyUplink(&self, mix_to_telephony_uplink: bool)

Setter for mixToTelephonyUplink.

Source

pub unsafe fn requestPersonalVoiceAuthorizationWithCompletionHandler( handler: &DynBlock<dyn Fn(AVSpeechSynthesisPersonalVoiceAuthorizationStatus)>, )

Available on crate feature block2 only.

Asks the user to allow your app to use personal voices for speech synthesis

Call this method before performing any other tasks associated with speech synthesis using personal voices. This method executes asynchronously, returning shortly after you call it. At some point later, the system calls the provided handler block with the results.

When your app’s authorization status is PersonalVoiceAuthorizationStatus.notDetermined, this method causes the system to prompt the user to grant or deny permission for your app to use personal voices. The user’s response is saved so that future calls to this method do not prompt the user again.

Source

pub unsafe fn personalVoiceAuthorizationStatus() -> AVSpeechSynthesisPersonalVoiceAuthorizationStatus

Returns your app’s current authorization to use personal voices.

The user can reject your app’s request to use personal voices, but your request can also be denied if personal voices are not supported on the device. The app can also change your app’s authorization status at any time from the Settings app.

Returns: The app’s current authorization status value. For a list of values, see AVSpeechSynthesisPersonalVoiceAuthorizationStatus.

Source §

impl AVSpeechSynthesizer

Methods declared on superclass NSObject.

Source

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

Source

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

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