Struct MIDIUMPMutableEndpoint 

pub struct MIDIUMPMutableEndpoint { /* private fields */ }

Available on crate features MIDIUMPEndpoint and MIDIUMPMutableEndpoint and objc2 only.

A mutable MIDIUMPEndpoint object.

It is not necessary to create a MIDIUMPEndpoint or other MIDI endpoint in order to use UMP natively. Any standard MIDI endpoint created with a specified MIDIProtocolID is assumed to use all 16 UMP groups for the same unspecified function and to neither transmit nor receive jitter-reduction timestamps.

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

See also Apple’s documentation

Implementations

impl MIDIUMPMutableEndpoint

pub unsafe fn mutableFunctionBlocks( &self, ) -> Retained<NSArray<MIDIUMPMutableFunctionBlock>>

Available on crate features MIDIUMPFunctionBlock and MIDIUMPMutableFunctionBlock and objc2-foundation only.

The Function Blocks associated with the UMP endpoint, if any.

pub unsafe fn setMutableFunctionBlocks( &self, mutable_function_blocks: &NSArray<MIDIUMPMutableFunctionBlock>, )

Available on crate features MIDIUMPFunctionBlock and MIDIUMPMutableFunctionBlock and objc2-foundation only.

Setter for mutableFunctionBlocks.

This is copied when set.

pub unsafe fn isEnabled(&self) -> bool

The enable state of the endpoint.

pub unsafe fn initWithName_deviceInfo_productInstanceID_MIDIProtocol_destinationCallback( this: Allocated<Self>, name: &NSString, device_info: &MIDI2DeviceInfo, product_instance_id: &NSString, midi_protocol: MIDIProtocolID, destination_callback: MIDIReceiveBlock, ) -> Option<Retained<Self>>

Available on crate features MIDIServices and block2 and objc2-foundation only.

Initializer for creating a new MIDIUMPEndpoint.

Parameter name: The UMP endpoint name.

Parameter deviceInfo: The MIDI 2 device ID info for the UMP endpoint.

Parameter productInstanceID: The product instance ID, up to 42 characters.

Parameter MIDIProtocol: The MIDI protocol.

Parameter destinationCallback: The receive callback used to create the UMP endpoint’s MIDI destination associated, which can be used to observe or process incoming MIDI traffic.

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

Safety

destination_callback must be a valid pointer.

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

Available on crate feature objc2-foundation only.

Set the endpoints name.

Parameter name: A string representing the name of the endpoint.

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.

This operation will fail if the name could not be set.

pub unsafe fn registerFunctionBlocks_markAsStatic_error( &self, function_blocks: &NSArray<MIDIUMPMutableFunctionBlock>, mark_as_static: bool, ) -> Result<(), Retained<NSError>>

Available on crate features MIDIUMPFunctionBlock and MIDIUMPMutableFunctionBlock and objc2-foundation only.

Register or replace Function Blocks for a disabled client-created MIDIUMPEndpoint.

Parameter functionBlocks: A list of client-created Function Blocks to register.

Parameter markAsStatic: Whether the Function Block configuration may be updated.

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.

This operation will fail if the array contains any disabled Function Blocks but the MIDIUMPEndpoint Function Block configuration is static. Returns YES if the Function Block configuration was set successfully.

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

Available on crate feature objc2-foundation only.

Enable a mutable UMP endpoint in the system-wide UMP endpoint cache.

Parameter isEnabled: The enable state of the UMP endpoint.

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.

A MIDIUMPMutableEndpoint must be cache enabled before it is visible via API. Note that Function Blocks may only be registered to uncached MIDIUMPMutableEndpoint objects.

impl MIDIUMPMutableEndpoint

Methods declared on superclass MIDIUMPEndpoint.

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

impl MIDIUMPMutableEndpoint

Methods declared on superclass NSObject.

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

Methods from Deref<Target = MIDIUMPEndpoint>

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

Available on crate feature objc2-foundation only.

The UTF-8 encoded name of the UMP endpoint.

The name shall not be any longer than 98 bytes of UTF-8 Text.

pub unsafe fn MIDIProtocol(&self) -> MIDIProtocolID

Available on crate feature MIDIServices only.

The MIDI protocol currently used by the UMP endpoint.

pub unsafe fn supportedMIDIProtocols(&self) -> MIDIUMPProtocolOptions

Available on crate feature MIDIMessages only.

All protocols the UMP endpoint is capable of using for communication.

pub unsafe fn MIDIDestination(&self) -> MIDIEndpointRef

Available on crate feature MIDIServices only.

The MIDI destination for the UMP endpoint.

pub unsafe fn MIDISource(&self) -> MIDIEndpointRef

Available on crate feature MIDIServices only.

The MIDI source for the UMP endpoint.

pub unsafe fn deviceInfo(&self) -> Retained<MIDI2DeviceInfo>

The MIDI 2.0 Device identity information associated with the device.

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

Available on crate feature objc2-foundation only.

Serial number (or similar value) uniquely identifying this manufacturer/family/model, up to 42 bytes of ASCII Text in the ordinal range 32-126.

pub unsafe fn hasStaticFunctionBlocks(&self) -> bool

Indicates if the Function Block state will never change once discovered.

pub unsafe fn hasJRTSReceiveCapability(&self) -> bool

Jitter-reduction timestamp receive capability.

pub unsafe fn hasJRTSTransmitCapability(&self) -> bool

Jitter-reduction timestamp transmit capability

pub unsafe fn endpointType(&self) -> MIDIUMPCIObjectBackingType

Available on crate feature MIDIUMPCI only.

Indicates the type of UMP Endpoint, if known.

pub unsafe fn functionBlocks(&self) -> Retained<NSArray<MIDIUMPFunctionBlock>>

Available on crate features MIDIUMPFunctionBlock and objc2-foundation only.

The Function Blocks associated with the UMP endpoint, if any.

pub unsafe fn setFunctionBlocks( &self, function_blocks: &NSArray<MIDIUMPFunctionBlock>, )

Available on crate features MIDIUMPFunctionBlock and objc2-foundation only.

Setter for functionBlocks.

This is copied when set.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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

Trait Implementations

impl AsRef<AnyObject> for MIDIUMPMutableEndpoint

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MIDIUMPEndpoint> for MIDIUMPMutableEndpoint

fn as_ref(&self) -> &MIDIUMPEndpoint

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MIDIUMPMutableEndpoint> for MIDIUMPMutableEndpoint

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for MIDIUMPMutableEndpoint

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for MIDIUMPMutableEndpoint

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MIDIUMPEndpoint> for MIDIUMPMutableEndpoint

fn borrow(&self) -> &MIDIUMPEndpoint

Immutably borrows from an owned value.

impl Borrow<NSObject> for MIDIUMPMutableEndpoint

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MIDIUMPMutableEndpoint

const NAME: &'static str = "MIDIUMPMutableEndpoint"

The name of the Objective-C class that this type represents.

type Super = MIDIUMPEndpoint

The superclass of this class.

type ThreadKind = <<MIDIUMPMutableEndpoint as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for MIDIUMPMutableEndpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for MIDIUMPMutableEndpoint

type Target = MIDIUMPEndpoint

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for MIDIUMPMutableEndpoint

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for MIDIUMPMutableEndpoint

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MIDIUMPMutableEndpoint

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for MIDIUMPMutableEndpoint

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for MIDIUMPMutableEndpoint

const ENCODING_REF: Encoding = <MIDIUMPEndpoint as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for MIDIUMPMutableEndpoint

impl Eq for MIDIUMPMutableEndpoint