jack.c.types

Undocumented in source.

Public Imports

jack.c.systemdeps
public import jack.c.systemdeps;
Undocumented in source.

Members

Aliases

JackBufferSizeCallback
alias JackBufferSizeCallback = int function(jack_nframes_t nframes, void* arg)

Prototype for the @a bufsize_callback that is invoked whenever the JACK engine buffer size changes. Although this function is called in the JACK process thread, the normal process cycle is suspended during its operation, causing a gap in the audio flow. So, the @a bufsize_callback can allocate storage, touch memory not previously referenced, and perform other operations that are not realtime safe.

JackClientRegistrationCallback
alias JackClientRegistrationCallback = void function(const(char)* name, int register, void* arg)

Prototype for the client supplied function that is called whenever a client is registered or unregistered.

JackFreewheelCallback
alias JackFreewheelCallback = void function(int starting, void* arg)

Prototype for the client supplied function that is called whenever jackd starts or stops freewheeling.

JackGraphOrderCallback
alias JackGraphOrderCallback = int function(void* arg)

Prototype for the client supplied function that is called whenever the processing graph is reordered.

JackInfoShutdownCallback
alias JackInfoShutdownCallback = void function(jack_status_t code, const(char)* reason, void* arg)

Prototype for the client supplied function that is called whenever jackd is shutdown. Note that after server shutdown, the client pointer is *not* deallocated by libjack, the application is responsible to properly use jack_client_close() to release client ressources. Warning: jack_client_close() cannot be safely used inside the shutdown callback and has to be called outside of the callback context.

JackLatencyCallback
alias JackLatencyCallback = void function(jack_latency_callback_mode_t mode, void* arg)

Prototype for the client supplied function that is called by the engine when port latencies need to be recalculated

JackPortConnectCallback
alias JackPortConnectCallback = void function(jack_port_id_t a, jack_port_id_t b, int connect, void* arg)

Prototype for the client supplied function that is called whenever a port is connected or disconnected.

JackPortRegistrationCallback
alias JackPortRegistrationCallback = void function(jack_port_id_t port, int register, void* arg)

Prototype for the client supplied function that is called whenever a port is registered or unregistered.

JackPortRenameCallback
alias JackPortRenameCallback = int function(jack_port_id_t port, const(char)* old_name, const(char)* new_name, void* arg)

Prototype for the client supplied function that is called whenever the port name has been changed.

JackProcessCallback
alias JackProcessCallback = int function(jack_nframes_t nframes, void* arg)

Prototype for the client supplied function that is called by the engine anytime there is work to be done.

JackSampleRateCallback
alias JackSampleRateCallback = int function(jack_nframes_t nframes, void* arg)

Prototype for the client supplied function that is called when the engine sample rate changes.

JackShutdownCallback
alias JackShutdownCallback = void function(void* arg)

Prototype for the client supplied function that is called whenever jackd is shutdown. Note that after server shutdown, the client pointer is *not* deallocated by libjack, the application is responsible to properly use jack_client_close() to release client ressources. Warning: jack_client_close() cannot be safely used inside the shutdown callback and has to be called outside of the callback context.

JackSyncCallback
alias JackSyncCallback = int function(jack_transport_state_t state, jack_position_t* pos, void* arg)

Prototype for the @a sync_callback defined by slow-sync clients. When the client is active, this callback is invoked just before process() in the same thread. This occurs once after registration, then subsequently whenever some client requests a new position, or the transport enters the ::JackTransportStarting state. This realtime function must not wait.

JackThreadCallback
alias JackThreadCallback = void* function(void* arg)

Prototype for the client thread routine called by the engine when the client is inserted in the graph.

JackThreadInitCallback
alias JackThreadInitCallback = void function(void* arg)

Prototype for the client supplied function that is called once after the creation of the thread in which other callbacks will be made. Special thread characteristics can be set from this callback, for example. This is a highly specialized callback and most clients will not and should not use it.

JackTimebaseCallback
alias JackTimebaseCallback = void function(jack_transport_state_t state, jack_nframes_t nframes, jack_position_t* pos, int new_pos, void* arg)

Prototype for the @a timebase_callback used to provide extended position information. Its output affects all of the following process cycle. This realtime function must not wait.

JackXRunCallback
alias JackXRunCallback = int function(void* arg)

Prototype for the client-supplied function that is called whenever an xrun has occured.

jack_default_audio_sample_t
alias jack_default_audio_sample_t = float

For convenience, use this typedef if you want to be able to change between float and double. You may want to typedef sample_t to jack_default_audio_sample_t in your application.

jack_intclient_t
alias jack_intclient_t = uint64_t

jack_intclient_t is an opaque type representing a loaded internal client. You may only access it using the API provided in @ref intclient.h "<jack/intclient.h>".

jack_latency_callback_mode_t
alias jack_latency_callback_mode_t = JackLatencyCallbackMode

Type of Latency Callback (Capture or Playback)

jack_nframes_t
alias jack_nframes_t = uint32_t

Type used to represent sample frame counts.

jack_options_t
alias jack_options_t = JackOptions

Options for several JACK operations, formed by OR-ing together the relevant @ref JackOptions bits.

jack_port_id_t
alias jack_port_id_t = uint32_t

Ports have unique ids. A port registration callback is the only place you ever need to know their value.

jack_port_type_id_t
alias jack_port_type_id_t = uint32_t
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
jack_shmsize_t
alias jack_shmsize_t = int32_t
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
jack_status_t
alias jack_status_t = JackStatus

Status word returned from several JACK operations, formed by OR-ing together the relevant @ref JackStatus bits.

jack_time_t
alias jack_time_t = uint64_t

Type used to represent the value of free running monotonic clock with units of microseconds.

jack_unique_t
alias jack_unique_t = uint64_t
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Enums

JackLatencyCallbackMode
enum JackLatencyCallbackMode

@ref jack_latency_callback_mode_t

JackOptions
enum JackOptions

@ref jack_options_t bits

JackPortFlags
enum JackPortFlags

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

JackStatus
enum JackStatus

@ref jack_status_t bits

jack_position_bits_t
enum jack_position_bits_t

Optional struct jack_position_t fields.

jack_transport_bits_t
enum jack_transport_bits_t

Optional struct jack_transport_info_t fields.

jack_transport_state_t
enum jack_transport_state_t

Transport states.

Manifest constants

JACK_DEFAULT_AUDIO_TYPE
enum JACK_DEFAULT_AUDIO_TYPE;

Used for the type argument of jack_port_register() for default audio ports and midi ports.

JACK_DEFAULT_MIDI_TYPE
enum JACK_DEFAULT_MIDI_TYPE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
JACK_LOAD_INIT_LIMIT
enum JACK_LOAD_INIT_LIMIT;

Maximum size of @a load_init string passed to an internal client jack_initialize() function via jack_internal_client_load().

JACK_MAX_FRAMES
enum JACK_MAX_FRAMES;

Maximum value that can be stored in jack_nframes_t

JACK_POSITION_MASK
enum JACK_POSITION_MASK;

all valid position bits

JackLoadOptions
enum JackLoadOptions;

Valid options for loading an internal client.

JackOpenOptions
enum JackOpenOptions;

Valid options for opening an external client.

Structs

jack_client_t
struct jack_client_t

jack_client_t is an opaque type. You may only access it using the API provided.

jack_latency_range_t
struct jack_latency_range_t

the new latency API operates on Ranges.

jack_port_t
struct jack_port_t

jack_port_t is an opaque type. You may only access it using the API provided.

jack_position_t
struct jack_position_t
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
jack_transport_info_t
struct jack_transport_info_t

Deprecated struct for transport position information.

Meta