Struct MIDIUMPMutableFunctionBlock

Source

pub struct MIDIUMPMutableFunctionBlock { /* private fields */ }

Available on crate features MIDIUMPFunctionBlock and MIDIUMPMutableFunctionBlock and objc2 only.

Expand description

A mutable Function Block object created by the client process.

A Function Block created with this API may be used in the Function Block configuration of a client-created MIDIUMPMutableEndpoint.

This API is not realtime-safe, all interaction with the function block should be done on the main thread.

Implementations§

Source §

impl MIDIUMPMutableFunctionBlock

Source

pub unsafe fn UMPEndpoint(&self) -> Option<Retained<MIDIUMPMutableEndpoint>>

Available on crate features MIDIUMPEndpoint and MIDIUMPMutableEndpoint only.

The UMP Endpoint to which this Function Block is registered.

Source

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

Source

pub unsafe fn initWithName_direction_firstGroup_totalGroupsSpanned_maxSysEx8Streams_MIDI1Info_UIHint_isEnabled( this: Allocated<Self>, name: &NSString, direction: MIDIUMPFunctionBlockDirection, first_group: MIDIUMPGroupNumber, total_groups_spanned: MIDIUInteger7, max_sys_ex8_streams: MIDIUInteger7, midi1_info: MIDIUMPFunctionBlockMIDI1Info, ui_hint: MIDIUMPFunctionBlockUIHint, is_enabled: bool, ) -> Option<Retained<Self>>

Available on crate features MIDIMessages and objc2-foundation only.

The initializer for constructing a Function Block.

Parameter name: The Function Block name.

Parameter direction: The directionality of the Function Block.

Parameter firstGroup: The first UMP Group supported by the Function Block.

Parameter totalGroupsSpanned: The number of UMP groups spanned by the Function Block.

Parameter maxSysEx8Streams: The maximum number of simultaneous Sysex8 streams.

Parameter MIDI1Info: The MIDI 1.0 speed information for the Function Block.

Parameter UIHint: A UI hint for the Function Block.

Parameter isEnabled: The enable state of the Function Block.

This operation will fail if virtual MIDI endpoint creation is not allowed (for example, on iOS, if your app doesn’t list ‘audio’ in UIBackgroundModes).

Source

pub unsafe fn setEnabled_error( &self, is_enabled: bool, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-foundation only.

Set whether this Function Block is enabled or disabled.

Parameter isEnabled: The new state of the Function Block.

Parameter error: The out-error used if an error occurred.

Returns: YES for success. NO in the event of a failure, in which case the error is returned in error.

If a Function Block is registered to UMP Endpoint as part of a static configuration, the state must always be enabled and may not change. If registered to a UMP Endpoint, changes to the Function Block state are propagated to the system-wide cache.

Source

pub unsafe fn setName_error( &self, name: &NSString, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-foundation only.

Set the function block name.

Parameter name: A string representing the name of the function block.

Parameter error: The out-error used if an error occurs.

Returns: YES for success. NO in the event of a failure, in which case the error is returned in error.

The Function Block name string. Updating the name of a Function Block will cause the updated name to be propagated to all local copies of the system-wide cache.

Source

pub unsafe fn reconfigureWithFirstGroup_direction_MIDI1Info_UIHint_error( &self, first_group: MIDIUMPGroupNumber, direction: MIDIUMPFunctionBlockDirection, midi1_info: MIDIUMPFunctionBlockMIDI1Info, ui_hint: MIDIUMPFunctionBlockUIHint, ) -> Result<(), Retained<NSError>>

Available on crate features MIDIMessages and objc2-foundation only.

Reconfigure a Function Block.

Parameter firstGroup: The new first Group to use for the Function Block..

Parameter direction: The direction of the Function Block: input, output, or bidirectional.

Parameter MIDI1Info: MIDI 1.0 speed information.

Parameter UIHint: A hint for UI about the primary usage of this Function Block.

If a mutable Function Block has not been registered to a CI device or was registered in a non-static Function Block configuration, the first Group can be changed if the final Group spanned by the Function Block is valid after the Function Block has been relocated. Returns YES if the first Group of the Function Block was changed.

Source §

impl MIDIUMPMutableFunctionBlock

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = MIDIUMPFunctionBlock>§

Source

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

Available on crate feature objc2-foundation only.

A string containing the Function Block’s name.

Source

pub unsafe fn functionBlockID(&self) -> MIDIUMPFunctionBlockID

Available on crate features MIDIMessages and MIDIUMPCI only.

The device-unique ID for this Function Block.

Source

pub unsafe fn direction(&self) -> MIDIUMPFunctionBlockDirection

Available on crate feature MIDIMessages only.

The direction of the Function Block: input, output, or bidirectional.

Source

pub unsafe fn firstGroup(&self) -> MIDIUMPGroupNumber

Available on crate feature MIDIMessages only.

The first Group spanned by this Function Block.

Source

pub unsafe fn totalGroupsSpanned(&self) -> MIDIUInteger7

Available on crate feature MIDIMessages only.

The total number of groups spanned by this Function Block.

Source

pub unsafe fn maxSysEx8Streams(&self) -> u8

The maximum number of simultaneous Sysex8 streams.

Source

pub unsafe fn MIDI1Info(&self) -> MIDIUMPFunctionBlockMIDI1Info

Available on crate feature MIDIMessages only.

MIDI 1.0 speed information.

Source

pub unsafe fn UIHint(&self) -> MIDIUMPFunctionBlockUIHint

Available on crate feature MIDIMessages only.

A hint for UI about the primary usage of this Function Block.

Source

pub unsafe fn UMPEndpoint(&self) -> Option<Retained<MIDIUMPEndpoint>>

Available on crate feature MIDIUMPEndpoint only.

The UMP Endpoint to which this Function Block is registered.

If the function block does not belong to an endpoint this property will be nil.

Source

pub unsafe fn midiCIDevice(&self) -> Option<Retained<MIDICIDevice>>

Available on crate feature MIDICIDevice only.

Retrieve the MIDICIDevice class interface if the Function Block supports MIDI-CI.

If a Function Block was created as a MIDICIDevice object, this property will provide an in-place MIDICIDevice interface that may be used with MIDI-CI API. If the device was not created as a MIDICIDevice, this method returns nil.

Source

pub unsafe fn isEnabled(&self) -> bool

The enable state of this Function Block.

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