Jack2
1.9.9
|
Functions | |
jack_port_t * | jack_port_register (jack_client_t *client, const char *port_name, const char *port_type, unsigned long flags, unsigned long buffer_size) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_unregister (jack_client_t *client, jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
void * | jack_port_get_buffer (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT |
const char * | jack_port_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
const char * | jack_port_short_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_flags (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
const char * | jack_port_type (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
jack_port_type_id_t | jack_port_type_id (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_is_mine (const jack_client_t *client, const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_connected (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_connected_to (const jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT |
const char ** | jack_port_get_connections (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
const char ** | jack_port_get_all_connections (const jack_client_t *client, const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_tie (jack_port_t *src, jack_port_t *dst) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT |
int | jack_port_untie (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT |
int | jack_port_set_name (jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_set_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_unset_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_get_aliases (const jack_port_t *port, char *const aliases[2]) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_request_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_request_monitor_by_name (jack_client_t *client, const char *port_name, int onoff) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_ensure_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_monitoring_input (jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_connect (jack_client_t *client, const char *source_port, const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_disconnect (jack_client_t *client, const char *source_port, const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_disconnect (jack_client_t *client, jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_name_size (void) JACK_OPTIONAL_WEAK_EXPORT |
int | jack_port_type_size (void) JACK_OPTIONAL_WEAK_EXPORT |
size_t | jack_port_type_get_buffer_size (jack_client_t *client, const char *port_type) JACK_WEAK_EXPORT |
jack_port_t* jack_port_register | ( | jack_client_t * | client, |
const char * | port_name, | ||
const char * | port_type, | ||
unsigned long | flags, | ||
unsigned long | buffer_size | ||
) |
Create a new port for the client. This is an object used for moving data of any type in or out of the client. Ports may be connected in various ways.
Each port has a short name. The port's full name contains the name of the client concatenated with a colon (:) followed by its short name. The jack_port_name_size() is the maximum length of this full name. Exceeding that will cause the port registration to fail and return NULL.
The port_name must be unique among all ports owned by this client. If the name is not unique, the registration will fail.
All ports have a type, which may be any non-NULL and non-zero length string, passed as an argument. Some port types are built into the JACK API, currently only JACK_DEFAULT_AUDIO_TYPE.
client | pointer to JACK client structure. |
port_name | non-empty short name for the new port (not including the leading "client_name:"). Must be unique. |
port_type | port type name. If longer than jack_port_type_size(), only that many characters are significant. |
flags | JackPortFlags bit mask. |
buffer_size | must be non-zero if this is not a built-in port_type. Otherwise, it is ignored. |
Definition at line 1045 of file JackAPI.cpp.
int jack_port_unregister | ( | jack_client_t * | client, |
jack_port_t * | port | ||
) |
Remove the port from the client, disconnecting any existing connections.
Definition at line 1061 of file JackAPI.cpp.
void* jack_port_get_buffer | ( | jack_port_t * | port, |
jack_nframes_t | |||
) |
This returns a pointer to the memory area associated with the specified port. For an output port, it will be a memory area that can be written to; for an input port, it will be an area containing the data from the port's connection(s), or zero-filled. if there are multiple inbound connections, the data will be mixed appropriately.
You may cache the value returned, but only between calls to your "blocksize" callback. For this reason alone, you should either never cache the return value or ensure you have a "blocksize" callback and be sure to invalidate the cached address from there.
Caching output ports is DEPRECATED in Jack 2.0, due to some new optimization (like "pipelining"). Port buffers have to be retrieved in each callback for proper functionning.
Definition at line 333 of file JackAPI.cpp.
const char* jack_port_name | ( | const jack_port_t * | port | ) |
Definition at line 348 of file JackAPI.cpp.
const char* jack_port_short_name | ( | const jack_port_t * | port | ) |
Definition at line 363 of file JackAPI.cpp.
int jack_port_flags | ( | const jack_port_t * | port | ) |
Definition at line 378 of file JackAPI.cpp.
const char* jack_port_type | ( | const jack_port_t * | port | ) |
Definition at line 393 of file JackAPI.cpp.
jack_port_type_id_t jack_port_type_id | ( | const jack_port_t * | port | ) |
Definition at line 408 of file JackAPI.cpp.
int jack_port_is_mine | ( | const jack_client_t * | client, |
const jack_port_t * | port | ||
) |
Definition at line 1079 of file JackAPI.cpp.
int jack_port_connected | ( | const jack_port_t * | port | ) |
Definition at line 423 of file JackAPI.cpp.
int jack_port_connected_to | ( | const jack_port_t * | port, |
const char * | port_name | ||
) |
Definition at line 439 of file JackAPI.cpp.
const char** jack_port_get_connections | ( | const jack_port_t * | port | ) |
The caller is responsible for calling jack_free() on any non-NULL returned value.
port | locally owned jack_port_t pointer. |
Definition at line 1097 of file JackAPI.cpp.
const char** jack_port_get_all_connections | ( | const jack_client_t * | client, |
const jack_port_t * | port | ||
) |
The caller is responsible for calling jack_free() on any non-NULL returned value.
This differs from jack_port_get_connections() in two important respects:
1) You may not call this function from code that is executed in response to a JACK event. For example, you cannot use it in a GraphReordered handler. 2) You need not be the owner of the port to get information about its connections.
Definition at line 1114 of file JackAPI.cpp.
int jack_port_tie | ( | jack_port_t * | src, |
jack_port_t * | dst | ||
) |
Definition at line 464 of file JackAPI.cpp.
int jack_port_untie | ( | jack_port_t * | port | ) |
Definition at line 489 of file JackAPI.cpp.
int jack_port_set_name | ( | jack_port_t * | port, |
const char * | port_name | ||
) |
Modify a port's short name. May be called at any time. If the resulting full name (including the "client_name:" prefix) is longer than jack_port_name_size(), it will be truncated.
Definition at line 601 of file JackAPI.cpp.
int jack_port_set_alias | ( | jack_port_t * | port, |
const char * | alias | ||
) |
Set alias as an alias for port. May be called at any time. If the alias is longer than jack_port_name_size(), it will be truncated.
After a successful call, and until JACK exits or jack_port_unset_alias() is called, may be used as a alternate name for the port.
Ports can have up to two aliases - if both are already set, this function will return an error.
Definition at line 625 of file JackAPI.cpp.
int jack_port_unset_alias | ( | jack_port_t * | port, |
const char * | alias | ||
) |
Remove alias as an alias for port. May be called at any time.
After a successful call, alias can no longer be used as a alternate name for the port.
Definition at line 643 of file JackAPI.cpp.
int jack_port_get_aliases | ( | const jack_port_t * | port, |
char *const | aliases[2] | ||
) |
Get any aliases known for .
Definition at line 661 of file JackAPI.cpp.
int jack_port_request_monitor | ( | jack_port_t * | port, |
int | onoff | ||
) |
If JackPortCanMonitor is set for this port, turn input monitoring on or off. Otherwise, do nothing.
Definition at line 676 of file JackAPI.cpp.
int jack_port_request_monitor_by_name | ( | jack_client_t * | client, |
const char * | port_name, | ||
int | onoff | ||
) |
If JackPortCanMonitor is set for this port_name, turn input monitoring on or off. Otherwise, do nothing.
Definition at line 691 of file JackAPI.cpp.
int jack_port_ensure_monitor | ( | jack_port_t * | port, |
int | onoff | ||
) |
If JackPortCanMonitor is set for a port, this function turns on input monitoring if it was off, and turns it off if only one request has been made to turn it on. Otherwise it does nothing.
Definition at line 713 of file JackAPI.cpp.
int jack_port_monitoring_input | ( | jack_port_t * | port | ) |
Definition at line 728 of file JackAPI.cpp.
int jack_connect | ( | jack_client_t * | client, |
const char * | source_port, | ||
const char * | destination_port | ||
) |
Establish a connection between two ports.
When a connection exists, data written to the source port will be available to be read at the destination port.
Definition at line 1163 of file JackAPI.cpp.
int jack_disconnect | ( | jack_client_t * | client, |
const char * | source_port, | ||
const char * | destination_port | ||
) |
Remove a connection between two ports.
Definition at line 1179 of file JackAPI.cpp.
int jack_port_disconnect | ( | jack_client_t * | client, |
jack_port_t * | port | ||
) |
Perform the same function as jack_disconnect() using port handles rather than names. This avoids the name lookup inherent in the name-based version.
Clients connecting their own ports are likely to use this function, while generic connection clients (e.g. patchbays) would use jack_disconnect().
Definition at line 1195 of file JackAPI.cpp.
int jack_port_name_size | ( | void | ) |
A port's full name contains the owning client name concatenated with a colon (:) followed by its short name and a NULL character.
Definition at line 1437 of file JackAPI.cpp.
int jack_port_type_size | ( | void | ) |
Definition at line 1442 of file JackAPI.cpp.
size_t jack_port_type_get_buffer_size | ( | jack_client_t * | client, |
const char * | port_type | ||
) |
Definition at line 1447 of file JackAPI.cpp.