Struct coremidi::Client

pub struct Client { /* fields omitted */ }

A MIDI client.

An object maintaining per-client state.

A simple example to create a Client:

let client = coremidi::Client::new("example-client").unwrap();

Implementations

impl Client

pub fn new_with_notifications<F>(
    name: &str,
    callback: F
) -> Result<Client, OSStatus> where
    F: Into<NotifyCallback>, 

Creates a new CoreMIDI client with support for notifications. See MIDIClientCreateWithBlock.

The notification callback will be called on the run loop that was current when this associated function is called.

It follows that this particular run loop needs to be running in order to actually receive notifications. The run loop can be started after the client has been created if need be. Please see the examples to know how.

pub fn new(name: &str) -> Result<Client, OSStatus>

Creates a new CoreMIDI client. See MIDIClientCreate.

pub fn output_port(&self, name: &str) -> Result<OutputPort, OSStatus>

Creates an output port through which the client may send outgoing MIDI messages to any MIDI destination. See MIDIOutputPortCreate.

pub fn input_port<F>(
    &self,
    name: &str,
    callback: F
) -> Result<InputPort, OSStatus> where
    F: FnMut(&PacketList) + Send + 'static, 

Creates an input port through which the client may receive incoming MIDI 1.0 messages from any MIDI source. See MIDIInputPortCreate.

MIDIInputPortCreate is deprecated in CoreMIDI. Please consider using input_port_with_protocol instead

pub fn input_port_with_protocol<T, F>(
    &self,
    name: &str,
    protocol: Protocol,
    callback: F
) -> Result<InputPortWithContext<T>, OSStatus> where
    F: FnMut(&EventList, &mut T) + Send + 'static, 

Creates an input port through which the client may receive incoming MIDI messages from any MIDI source. It allows to choose which MIDI Protocol to use. See MIDIInputPortCreateWithProtocol.

pub fn virtual_source(&self, name: &str) -> Result<VirtualSource, OSStatus>

Creates a virtual source in the client. See MIDISourceCreate.

pub fn virtual_destination<F>(
    &self,
    name: &str,
    callback: F
) -> Result<VirtualDestination, OSStatus> where
    F: FnMut(&PacketList) + Send + 'static, 

Creates a virtual destination in the client. See MIDIDestinationCreate.

MIDIDestinationCreate is deprecated in CoreMIDI. Please consider using virtual_destination_with_protocol instead

pub fn virtual_destination_with_protocol<F>(
    &self,
    name: &str,
    protocol: Protocol,
    callback: F
) -> Result<VirtualDestination, OSStatus> where
    F: FnMut(&EventList) + Send + 'static, 

Creates a virtual destination in the client. It allows to choose which MIDI Protocol to use. See MIDIDestinationCreate.

Methods from Deref<Target = Object>

pub fn name(&self) -> Option<String>

Get the name for the object.

pub fn unique_id(&self) -> Option<u32>

Get the unique id for the object.

pub fn display_name(&self) -> Option<String>

Get the display name for the object.

pub fn set_property_string(
    &self,
    name: &str,
    value: &str
) -> Result<(), OSStatus>

Sets an object’s string-type property.

pub fn get_property_string(&self, name: &str) -> Result<String, OSStatus>

Gets an object’s string-type property.

pub fn set_property_integer(
    &self,
    name: &str,
    value: i32
) -> Result<(), OSStatus>

Sets an object’s integer-type property.

pub fn get_property_integer(&self, name: &str) -> Result<i32, OSStatus>

Gets an object’s integer-type property.

pub fn set_property_boolean(
    &self,
    name: &str,
    value: bool
) -> Result<(), OSStatus>

Sets an object’s boolean-type property.

CoreMIDI treats booleans as integers (0/1) but this API uses native bool types

pub fn get_property_boolean(&self, name: &str) -> Result<bool, OSStatus>

Gets an object’s boolean-type property.

CoreMIDI treats booleans as integers (0/1) but this API uses native bool types

pub fn set_property<T>(
    &self,
    property: &dyn PropertySetter<T>,
    value: T
) -> Result<(), OSStatus>

pub fn get_property<T>(
    &self,
    property: &dyn PropertyGetter<T>
) -> Result<T, OSStatus>

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.

impl Deref for Client

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.