Struct SCNAudioPlayer

Source

#[repr(C)]
pub struct SCNAudioPlayer { /* private fields */ }

Available on crate feature SCNAudioSource only.

Expand description

Apple’s documentation

Implementations§

Source §

impl SCNAudioPlayer

Source

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

Source

pub unsafe fn initWithSource( this: Allocated<Self>, source: &SCNAudioSource, ) -> Retained<Self>

Init an audio player with a source. Most people should use audioPlayerWithSource as it permits to recycle previous players instead of creating new ones for each instance.

Source

pub unsafe fn initWithAVAudioNode( this: Allocated<Self>, audio_node: &AVAudioNode, ) -> Retained<Self>

Available on crate feature objc2-avf-audio only.

Init an audio player with an AVAudioNode. Most people should use audioPlayerWithAVAudioNode as it permits to recycle previous players instead of creating new ones for each instance.

Source

pub unsafe fn audioPlayerWithSource(source: &SCNAudioSource) -> Retained<Self>

Create an audio player with a source.

Source

pub unsafe fn audioPlayerWithAVAudioNode( audio_node: &AVAudioNode, ) -> Retained<Self>

Available on crate feature objc2-avf-audio only.

Create an audio player with a custom AVAudioNode instance.

Source

pub unsafe fn willStartPlayback(&self) -> *mut Block<dyn Fn()>

Available on crate feature block2 only.

This block is called when the playback starts in case a valid audio source is present.

Source

pub unsafe fn setWillStartPlayback( &self, will_start_playback: Option<&Block<dyn Fn()>>, )

Available on crate feature block2 only.

Setter for willStartPlayback.

Source

pub unsafe fn didFinishPlayback(&self) -> *mut Block<dyn Fn()>

Available on crate feature block2 only.

This block is called when the playback stops in case a valid audio source is present.

Source

pub unsafe fn setDidFinishPlayback( &self, did_finish_playback: Option<&Block<dyn Fn()>>, )

Available on crate feature block2 only.

Setter for didFinishPlayback.

Source

pub unsafe fn audioNode(&self) -> Option<Retained<AVAudioNode>>

Available on crate feature objc2-avf-audio only.

The audioNode. If this player was not initialised with a custom AVAudioNode this contains the internal audio player node used by scene kit internally.

Source

pub unsafe fn audioSource(&self) -> Option<Retained<SCNAudioSource>>

The audioSource if there is one.

Source §

impl SCNAudioPlayer

Methods declared on superclass NSObject.

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.

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