jack.port

struct Port

Types 1

structPort

Lightweight D wrapper around a jack_port_t.

Fields

jack_port_t * handle

Methods

int maxPortNameSize() static @nogc nothrowGet the maximum port name size. Real-time safe.

int maxPortTypeSize() static @nogc nothrowGet the maximum port type name size. Real-time safe.

bool isNull() const nothrow @nogcCheck if a port is a null port (unset). Real-time safe.

string name() @property constGet port name. NOT real-time safe and shouldn't be called from process callback.

void name(string newName) @propertySet port name. NOT real-time safe and shouldn't be called from process callback. Params: newName = The new port name Throws: JackException on failure

string shortName() @property constGet port short name. NOT real-time safe and shouldn't be called from process callback.

string type() @property constGet port type. NOT real-time safe and shouldn't be called from process callback.

PortTypeId typeId() @property @nogc nothrowGet port type ID. Real-time safe.

JackPortFlags flags() @property const @nogc nothrowGet port flags. Real-time safe.

Uuid uuid() @property @nogc nothrowGet UUID of a JACK port. Real-time safe.

bool isInput() @property const @nogc nothrowIs input port? Real-time safe.

bool isOutput() @property const @nogc nothrowIs output port? Real-time safe.

void * getBuffer(NFrames nframes) @nogc nothrowGet the buffer associated with a port. Real-time safe. This is intended to be called in the real-time process callback and the value should not be cached between callbacks. Params: nframes = Number...

float[] getAudioBuffer(NFrames nframes) @nogc nothrowConvenience for audio ports – returns a float slice. Real-time safe. Params: nframes = Number of frames Returns: A mutable slice for writing the audio data

int connected() const @nogc nothrowCheck count of connections to a port. Real-time safe. Returns: Count of connections to this port

bool connectedTo(string portName) const nothrowCheck if a port is connected to another port by name. NOT real-time safe and shouldn't be called from process callback. Params: portName = Other port to check if this one is connected to it Returns...

string[] getConnections()Get port connections. NOT real-time safe. Returns: Array of connected port names

void requestMonitor(bool on)Request to monitor a port. NOT real-time safe and shouldn't be called from process callback. Params: on = true to request the server to monitor the port, false otherwise Throws: JackException on fa...

void ensureMonitor(bool on)If a port has JackPortCanMonitor set, calling this method turns on input monitor if it was off, or turns it off if only one request to turn it on has been made. Not real-time safe. Params: on = tru...

bool monitoringInput() @nogc nothrowCheck if monitoring has been requested for an input port. Real-time safe. Returns: true if monitoring requested, false otherwise

LatencyRange getLatencyRange(JackLatencyCallbackMode mode) @nogc nothrowGet a latency range. Real-time safe. This is intended to be called from the latency callback. Params: mode = The mode of the range to get Returns: The latency range

void setLatencyRange(JackLatencyCallbackMode mode, LatencyRange range) @nogc nothrowSet a latency range. Real-time safe. This is intended to be called from the latency callback Params: mode = The mode of the range to set range = The range to assign

void setAlias(string aliasName)Set a port alias name. Up to 2 aliases are allowed. NOT real-time safe. Throws: JackException on error (too many aliases for example)

void unsetAlias(string aliasName)Unset a port alias name. NOT real-time safe. Throws: JackException on error

string[] aliases() @propertyGet port alias names. NOT real-time safe. Returns: Array of port alias names