Crate sqa_jack [] [src]

Reexports

pub use errors::JackResult;
pub use handler::JackCallbackContext;
pub use handler::JackControl;
pub use handler::JackHandler;
pub use handler::JackLoggingHandler;
pub use handler::set_logging_handler;
pub use port::JackPort;
pub use jack_sys::*;

Modules

errors
handler

Callback-based JACK API functions (logging, processing).

port

Structs

Activated

Type argument for activated connections.

Deactivated

Type argument for deactivated connections.

JackConnection

A connection to a JACK server (known as a "client" in the JACK docs).

JackOpenOptions

Options for opening a connection to JACK, formed by OR-ing together desired values from the consts OPEN_*.

JackPortFlags

A port has a set of flags that are formed by OR-ing together the desired values from the consts PORT_*. The flags "JackPortIsInput" and "JackPortIsOutput" are mutually exclusive and it is an error to use them both.

JackStatus

Status of an operation.

Constants

OPEN_NO_START_SERVER

Do not automatically start the JACK server when it is not already running. This option is always selected if $JACK_NO_START_SERVER is defined in the calling process environment.

OPEN_USE_EXACT_NAME

Use the exact client name requested. Otherwise, JACK automatically generates a unique one, if needed.

PORT_CAN_MONITOR

A call to jack_port_request_monitor() makes sense.

PORT_IS_INPUT

This port can receive data.

PORT_IS_OUTPUT

Data can be read from this port.

PORT_IS_PHYSICAL

The port corresponds to some kind of physical I/O connector.

PORT_IS_TERMINAL

For an input port: the data received by this port will not be passed on or made available at any other port.

STATUS_FAILURE

Overall operation failed.

STATUS_INIT_FAILURE

Unable to initialise client.

STATUS_INVALID_OPTION

The operation contained an invalid or unsupported option.

STATUS_LOAD_FAILURE

Unable to load internal client.

STATUS_NAME_NOT_UNIQUE

The desired client name was not unique. With the JackUseExactName option this situation is fatal. Otherwise, the name was modified by appending a dash and a two-digit number in the range "-01" to "-99". The jack_get_client_name() function will return the exact string that was used. If the specified client_name plus these extra characters would be too long, the open fails instead.

STATUS_NO_SUCH_CLIENT

Requested client does not exist.

STATUS_SERVER_ERROR

Communication error with the JACK server.

STATUS_SERVER_FAILED

Unable to connect to the JACK server.

STATUS_SERVER_STARTED

The JACK server was started as a result of this operation. Otherwise, it was running already. In either case the caller is now connected to jackd, so there is no race condition. When the server shuts down, the client will find out.

STATUS_SHM_FAILURE

Unable to access shared memory.

STATUS_VERSION_ERROR

Client's protocol version does not match.

Type Definitions

JackNFrames
JackPortPtr