Struct JackClient 

pub struct JackClient { /* private fields */ }

SIM-visible JACK client with registered audio and MIDI ports.

Implementations

impl JackClient

pub fn new( name: impl Into<String>, timing: JackTiming, audio_inputs: usize, audio_outputs: usize, midi_inputs: usize, midi_outputs: usize, ) -> Result<Self>

Builds a JACK client with the given name, timing, and port counts.

The client id is derived from name as jack/<name>/client.

Errors

Returns an error when name is empty or when the client registers no audio ports (both audio counts are zero).

pub fn sim_default() -> Result<Self>

Builds the SIM default client: name SIM, JackTiming::pro_audio_default, two audio inputs and outputs, and one MIDI input and output.

Errors

Returns an error if the constructed client is rejected (it is not under the default configuration).

pub fn id(&self) -> &Symbol

Returns the client’s stable id symbol.

pub fn name(&self) -> &str

Returns the client’s display name.

pub fn timing(&self) -> JackTiming

Returns the client’s timing metadata.

pub fn audio_inputs(&self) -> usize

Returns the number of registered audio input ports.

pub fn audio_outputs(&self) -> usize

Returns the number of registered audio output ports.

pub fn midi_inputs(&self) -> usize

Returns the number of registered MIDI input ports.

pub fn midi_outputs(&self) -> usize

Returns the number of registered MIDI output ports.

pub fn direction(&self) -> HostDirection

Returns the client’s audio direction inferred from its port counts.

Both-sided clients (and the degenerate no-audio case) report HostDirection::Duplex.

pub fn is_compatible_with(&self, requested: HostDirection) -> bool

Returns whether this client can serve a stream in the requested direction.

A client matches its own direction, and a duplex client matches any request.

pub fn ports(&self) -> Vec<JackPort>

Returns the client’s routable ports: audio inputs, audio outputs, MIDI inputs, then MIDI outputs, each numbered from zero.

Trait Implementations

impl Clone for JackClient

fn clone(&self) -> JackClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JackClient

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

Formats the value using the given formatter.

impl Eq for JackClient

impl PartialEq for JackClient

fn eq(&self, other: &JackClient) -> 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 StructuralPartialEq for JackClient