Struct PHASEAssetRegistry

Source

pub struct PHASEAssetRegistry { /* private fields */ }

Available on crate feature PHASEAssetRegistry only.

Expand description

Asset registry

Implementations§

Source §

pub unsafe fn registerGlobalMetaParameter_error( &self, meta_parameter_definition: &PHASEMetaParameterDefinition, ) -> Result<Retained<PHASEGlobalMetaParameterAsset>, Retained<NSError>>

Available on crate features PHASEDefinition and PHASEMetaParameter only.

Register a global metaparameter with the asset registry.

Note: This function is synchronous and thread-safe. Clients can safely run this function to register multiple global metaparameters from multiple threads, if required.

Parameter metaParameterDefinition: The metaparameter object to register.

Parameter error: The error object in case of an error.

Returns: A PHASEGlobalMetaParameterAsset object.

Source

pub unsafe fn registerSoundEventAssetWithRootNode_identifier_error( &self, root_node: &PHASESoundEventNodeDefinition, identifier: Option<&NSString>, ) -> Result<Retained<PHASESoundEventNodeAsset>, Retained<NSError>>

Available on crate features PHASEDefinition and PHASESoundEventNodes only.

Register a sound event asset with the asset registry.

Note: This function is synchronous and thread-safe. Clients can safely run this function to register multiple sound event assets from multiple threads, if required.

Parameter rootNode: The root node of the sound event asset to register.

Parameter identifier: An identifier that uniquely represents this sound event asset. Nil generates an automatic identifier.

Parameter error: The error object in case of an error

Returns: A PHASESoundEventNodeAsset object

Source

pub unsafe fn registerSoundAssetAtURL_identifier_assetType_channelLayout_normalizationMode_error( &self, url: &NSURL, identifier: Option<&NSString>, asset_type: PHASEAssetType, channel_layout: Option<&AVAudioChannelLayout>, normalization_mode: PHASENormalizationMode, ) -> Result<Retained<PHASESoundAsset>, Retained<NSError>>

Available on crate features PHASETypes and objc2-avf-audio only.

Register an audio file as a sound asset in the system.

Note: This function is synchronous and thread-safe. Clients can safely run this function to register multiple sound assets from multiple threads, if required.

Parameter url: The URL of the audio file.

Parameter identifier: An identifier that uniquely represents this sound event asset. Nil generates an automatic identifier.

Parameter assetType: The asset type for this sound asset.

Parameter channelLayout: The audio channel layout for this sound asset. If a valid channel layout definition is read from the file being registered, this will override it. If nil is passed as a value for this property, the file must either be mono or stereo, or already contain a vaild channel layout definition. This channel layout must have the same channel count as the audio file being loaded.

Parameter normalizationMode: The normalization mode.

Parameter error: The error object in case of an error

Returns: A PHASESoundAsset object

Source

pub unsafe fn registerSoundAssetWithData_identifier_format_normalizationMode_error( &self, data: &NSData, identifier: Option<&NSString>, format: &AVAudioFormat, normalization_mode: PHASENormalizationMode, ) -> Result<Retained<PHASESoundAsset>, Retained<NSError>>

Available on crate features PHASETypes and objc2-avf-audio only.

Register audio data as a sound asset in the system.

Note: This function is synchronous and thread-safe. Clients can safely run this function to register multiple sound assets from multiple threads, if required.

Parameter data: A buffer containing the audio data to register as a sound asset. Audio data must either be a single PCM buffer of interleaved channels or multiple deinterleaved PCM buffers per channel packed back to back.

Parameter identifier: The identifier to assign to this sound asset. Nil generates an automatic identifier.

Parameter format: The AVAudioFormat object that describes the audio data in the buffer.

Parameter normalizationMode: The normalization mode.

Parameter error: The error object in case of an error.

Returns: A PHASESoundAsset object.

Source

pub unsafe fn assetForIdentifier( &self, identifier: &NSString, ) -> Option<Retained<PHASEAsset>>

Finds an asset in the asset registry, given an identifier.

Parameter identifier: The identifier of this asset

Returns: A PHASEAsset object, or nil if one could not be found.

Source

pub unsafe fn globalMetaParameters( &self, ) -> Retained<NSDictionary<NSString, PHASEMetaParameter>>

Available on crate feature PHASEMetaParameter only.

A dictionary of global metaparameters

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