Struct PHASESamplerNodeDefinition

Source

pub struct PHASESamplerNodeDefinition { /* private fields */ }

Available on crate features PHASEDefinition and PHASESoundEventNodes only.

Expand description

Sampler node definition.

Sampler nodes play back registered sound assets.

Implementations§

Source §

pub unsafe fn initWithSoundAssetIdentifier_mixerDefinition_identifier( this: Allocated<Self>, sound_asset_identifier: &NSString, mixer_definition: &PHASEMixerDefinition, identifier: &NSString, ) -> Retained<Self>

Available on crate feature PHASEMixer only.

Create a sampler node definition

Parameter soundAssetIdentifier: The identifier of the registered sound asset this sampler will play

Parameter mixerDefinition: The mixer definition this sampler will be assigned to

Parameter identifier: An optional custom identifier to give to this object

Returns: A new PHASESamplerNodeDefinition object

Source

pub unsafe fn initWithSoundAssetIdentifier_mixerDefinition( this: Allocated<Self>, sound_asset_identifier: &NSString, mixer_definition: &PHASEMixerDefinition, ) -> Retained<Self>

Available on crate feature PHASEMixer only.

Create a sampler node definition

Parameter soundAssetIdentifier: The identifier of the registered sound asset this sampler will play

Parameter mixerDefinition: The mixer definition this sampler will be assigned to

Returns: A new PHASESamplerNodeDefinition object

Source

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

The identifier that uniquely represents the registered sound asset this sampler will play.

Source

pub unsafe fn cullOption(&self) -> PHASECullOption

Available on crate feature PHASETypes only.

The cull option for the sampler.

The default value is PHASECullOptionTerminate.

Source

pub unsafe fn setCullOption(&self, cull_option: PHASECullOption)

Available on crate feature PHASETypes only.

Setter for cullOption.

Source

pub unsafe fn playbackMode(&self) -> PHASEPlaybackMode

Available on crate feature PHASETypes only.

The playback mode for the sampler.

If the playback mode is set to PHASEPlaybackModeOneShot, you need to make sure the the audio data in the registered sound asset associated with this sampler begins and ends at zero crossings. Otherwise, you’ll hear a click when beginning playback and / or ending playback. If the playback mode is set to PHASEPlaybackModeLooping, you need to make sure the audio data in the registered sound asset associated with this sampler loops smoothly from the end sample to the start sample. Please verify this during authoring. Failing to do so will result in audible clicks at loop boundaries. The default value is PHASEPlaybackModeOneShot.

Source

pub unsafe fn setPlaybackMode(&self, playback_mode: PHASEPlaybackMode)

Available on crate feature PHASETypes only.

Setter for playbackMode.

Methods from Deref<Target = PHASEGeneratorNodeDefinition>§

Source

pub unsafe fn setCalibrationMode_level( &self, calibration_mode: PHASECalibrationMode, level: c_double, )

Available on crate feature PHASETypes only.

Set the generator’s calibration mode and level.

Parameter calibrationMode: The calibration mode.

Parameter level: The level.

Note: The level, including its underlying unit and range, are dependent on the calibration mode.

Source

pub unsafe fn calibrationMode(&self) -> PHASECalibrationMode

Available on crate feature PHASETypes only.

The generator’s calibration mode. The default value is PHASECalibrationModeNone.

Source

pub unsafe fn level(&self) -> c_double

The generator’s level. The default value is 1.

Note: The level’s underlying unit and range are dependent on the calibrationMode.

Source

pub unsafe fn rate(&self) -> c_double

Linear rate scalar.

Note: Values are clamped to the range [0.25, 4]. Default value is 1.

Source

pub unsafe fn setRate(&self, rate: c_double)

Setter for rate.

Source

pub unsafe fn group(&self) -> Option<Retained<PHASEGroup>>

Available on crate feature PHASEGroup only.

The PHASEGroup object this generator should be associated with for gain and rate control.

Source

pub unsafe fn setGroup(&self, group: Option<&PHASEGroup>)

Available on crate feature PHASEGroup only.

Setter for group.

This is a weak property.

Source

pub unsafe fn gainMetaParameterDefinition( &self, ) -> Option<Retained<PHASENumberMetaParameterDefinition>>

Available on crate feature PHASEMetaParameter only.

Optionally attach a metaparameter definition here to enable dynamic control of the gain during playback.

Source

pub unsafe fn setGainMetaParameterDefinition( &self, gain_meta_parameter_definition: Option<&PHASENumberMetaParameterDefinition>, )

Available on crate feature PHASEMetaParameter only.

Setter for gainMetaParameterDefinition.

Source

pub unsafe fn rateMetaParameterDefinition( &self, ) -> Option<Retained<PHASENumberMetaParameterDefinition>>

Available on crate feature PHASEMetaParameter only.

Optionally attach a metaparameter definition here to enable dynamic control of the rate during playback.

Source

pub unsafe fn setRateMetaParameterDefinition( &self, rate_meta_parameter_definition: Option<&PHASENumberMetaParameterDefinition>, )

Available on crate feature PHASEMetaParameter only.

Setter for rateMetaParameterDefinition.

Source

pub unsafe fn mixerDefinition(&self) -> Retained<PHASEMixerDefinition>

Available on crate feature PHASEMixer only.

The readonly property that returns the PHASEMixerDefinition this generator was created with and assigned to.

Methods from Deref<Target = PHASESoundEventNodeDefinition>§

Source

pub unsafe fn children( &self, ) -> Retained<NSArray<PHASESoundEventNodeDefinition>>

The children of this node definition.

Methods from Deref<Target = PHASEDefinition>§

Source

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

The identifier that uniquely represents this definition.

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