|
ALSA project - the C library reference
|
Macros | |
| #define | snd_seq_client_info_alloca(ptr) __snd_alloca(ptr, snd_seq_client_info) |
| #define | snd_seq_client_pool_alloca(ptr) __snd_alloca(ptr, snd_seq_client_pool) |
Typedefs | |
| typedef struct _snd_seq_client_info | snd_seq_client_info_t |
| typedef struct _snd_seq_client_pool | snd_seq_client_pool_t |
Enumerations | |
| enum | snd_seq_client_type_t { SND_SEQ_USER_CLIENT = 1 , SND_SEQ_KERNEL_CLIENT = 2 } |
| enum | { SND_SEQ_CLIENT_LEGACY_MIDI = 0 , SND_SEQ_CLIENT_UMP_MIDI_1_0 = 1 , SND_SEQ_CLIENT_UMP_MIDI_2_0 = 2 } |
Functions | |
| size_t | snd_seq_client_info_sizeof (void) |
| get size of snd_seq_client_info_t | |
| int | snd_seq_client_info_malloc (snd_seq_client_info_t **ptr) |
| allocate an empty snd_seq_client_info_t using standard malloc | |
| void | snd_seq_client_info_free (snd_seq_client_info_t *ptr) |
| frees a previously allocated snd_seq_client_info_t | |
| void | snd_seq_client_info_copy (snd_seq_client_info_t *dst, const snd_seq_client_info_t *src) |
| copy one snd_seq_client_info_t to another | |
| int | snd_seq_client_info_get_client (const snd_seq_client_info_t *info) |
| Get client id of a client_info container. | |
| snd_seq_client_type_t | snd_seq_client_info_get_type (const snd_seq_client_info_t *info) |
| Get client type of a client_info container. | |
| const char * | snd_seq_client_info_get_name (snd_seq_client_info_t *info) |
| Get the name of a client_info container. | |
| int | snd_seq_client_info_get_broadcast_filter (const snd_seq_client_info_t *info) |
| Get the broadcast filter usage of a client_info container. | |
| int | snd_seq_client_info_get_error_bounce (const snd_seq_client_info_t *info) |
| Get the error-bounce usage of a client_info container. | |
| int | snd_seq_client_info_get_card (const snd_seq_client_info_t *info) |
| Get the sound card number. | |
| int | snd_seq_client_info_get_pid (const snd_seq_client_info_t *info) |
| Get the owning PID. | |
| const unsigned char * | snd_seq_client_info_get_event_filter (const snd_seq_client_info_t *info) |
| (DEPRECATED) Get the event filter bitmap of a client_info container | |
| int | snd_seq_client_info_get_num_ports (const snd_seq_client_info_t *info) |
| Get the number of opened ports of a client_info container. | |
| int | snd_seq_client_info_get_event_lost (const snd_seq_client_info_t *info) |
| Get the number of lost events of a client_info container. | |
| int | snd_seq_client_info_get_midi_version (const snd_seq_client_info_t *info) |
| Get the MIDI protocol version number of a client_info container. | |
| int | snd_seq_client_info_get_ump_group_enabled (const snd_seq_client_info_t *info, int group) |
| Get the UMP group filter status. | |
| int | snd_seq_client_info_get_ump_groupless_enabled (const snd_seq_client_info_t *info) |
| Get the UMP groupless message handling status. | |
| int | snd_seq_client_info_get_ump_conversion (const snd_seq_client_info_t *info) |
| Get the automatic conversion mode for UMP. | |
| void | snd_seq_client_info_set_client (snd_seq_client_info_t *info, int client) |
| Set the client id of a client_info container. | |
| void | snd_seq_client_info_set_name (snd_seq_client_info_t *info, const char *name) |
| Set the name of a client_info container. | |
| void | snd_seq_client_info_set_broadcast_filter (snd_seq_client_info_t *info, int val) |
| Set the broadcast filter usage of a client_info container. | |
| void | snd_seq_client_info_set_error_bounce (snd_seq_client_info_t *info, int val) |
| Set the error-bounce usage of a client_info container. | |
| void | snd_seq_client_info_set_event_filter (snd_seq_client_info_t *info, unsigned char *filter) |
| (DEPRECATED) Set the event filter bitmap of a client_info container | |
| void | snd_seq_client_info_set_midi_version (snd_seq_client_info_t *info, int midi_version) |
| Set the MIDI protocol version of a client_info container. | |
| void | snd_seq_client_info_set_ump_group_enabled (snd_seq_client_info_t *info, int group, int enable) |
| Set the UMP group filter status. | |
| void | snd_seq_client_info_set_ump_groupless_enabled (snd_seq_client_info_t *info, int enable) |
| Enable/disable the UMP groupless message handling. | |
| void | snd_seq_client_info_set_ump_conversion (snd_seq_client_info_t *info, int enable) |
| Set the automatic conversion mode for UMP. | |
| void | snd_seq_client_info_event_filter_clear (snd_seq_client_info_t *info) |
| Disable event filtering of a client_info container. | |
| void | snd_seq_client_info_event_filter_add (snd_seq_client_info_t *info, int event_type) |
| Add an event type to the event filtering of a client_info container. | |
| void | snd_seq_client_info_event_filter_del (snd_seq_client_info_t *info, int event_type) |
| Remove an event type from the event filtering of a client_info container. | |
| int | snd_seq_client_info_event_filter_check (snd_seq_client_info_t *info, int event_type) |
| Check if an event type is present in the event filtering of a client_info container. | |
| int | snd_seq_get_client_info (snd_seq_t *handle, snd_seq_client_info_t *info) |
| obtain the current client information | |
| int | snd_seq_get_any_client_info (snd_seq_t *handle, int client, snd_seq_client_info_t *info) |
| obtain the information of the given client | |
| int | snd_seq_set_client_info (snd_seq_t *handle, snd_seq_client_info_t *info) |
| set the current client information | |
| int | snd_seq_query_next_client (snd_seq_t *handle, snd_seq_client_info_t *info) |
| query the next client | |
| int | snd_seq_get_ump_endpoint_info (snd_seq_t *seq, int client, void *info) |
| Get UMP Endpoint information. | |
| int | snd_seq_get_ump_block_info (snd_seq_t *seq, int client, int blk, void *info) |
| Get UMP Block information. | |
| int | snd_seq_set_ump_endpoint_info (snd_seq_t *seq, const void *info) |
| Set UMP Endpoint information to the current client. | |
| int | snd_seq_set_ump_block_info (snd_seq_t *seq, int blk, const void *info) |
| Set UMP Block information to the current client. | |
| size_t | snd_seq_client_pool_sizeof (void) |
| get size of snd_seq_client_pool_t | |
| int | snd_seq_client_pool_malloc (snd_seq_client_pool_t **ptr) |
| allocate an empty snd_seq_client_pool_t using standard malloc | |
| void | snd_seq_client_pool_free (snd_seq_client_pool_t *ptr) |
| frees a previously allocated snd_seq_client_pool_t | |
| void | snd_seq_client_pool_copy (snd_seq_client_pool_t *dst, const snd_seq_client_pool_t *src) |
| copy one snd_seq_client_pool_t to another | |
| int | snd_seq_client_pool_get_client (const snd_seq_client_pool_t *info) |
| Get the client id of a queue_info container. | |
| size_t | snd_seq_client_pool_get_output_pool (const snd_seq_client_pool_t *info) |
| Get the output pool size of a queue_info container. | |
| size_t | snd_seq_client_pool_get_input_pool (const snd_seq_client_pool_t *info) |
| Get the input pool size of a queue_info container. | |
| size_t | snd_seq_client_pool_get_output_room (const snd_seq_client_pool_t *info) |
| Get the output room size of a queue_info container. | |
| size_t | snd_seq_client_pool_get_output_free (const snd_seq_client_pool_t *info) |
| Get the available size on output pool of a queue_info container. | |
| size_t | snd_seq_client_pool_get_input_free (const snd_seq_client_pool_t *info) |
| Get the available size on input pool of a queue_info container. | |
| void | snd_seq_client_pool_set_output_pool (snd_seq_client_pool_t *info, size_t size) |
| Set the output pool size of a queue_info container. | |
| void | snd_seq_client_pool_set_input_pool (snd_seq_client_pool_t *info, size_t size) |
| Set the input pool size of a queue_info container. | |
| void | snd_seq_client_pool_set_output_room (snd_seq_client_pool_t *info, size_t size) |
| Set the output room size of a queue_info container. | |
| int | snd_seq_get_client_pool (snd_seq_t *handle, snd_seq_client_pool_t *info) |
| obtain the pool information of the current client | |
| int | snd_seq_set_client_pool (snd_seq_t *handle, snd_seq_client_pool_t *info) |
| set the pool information | |
Sequencer Client Interface
| #define snd_seq_client_info_alloca | ( | ptr | ) | __snd_alloca(ptr, snd_seq_client_info) |
allocate a snd_seq_client_info_t container on stack
| #define snd_seq_client_pool_alloca | ( | ptr | ) | __snd_alloca(ptr, snd_seq_client_pool) |
allocate a snd_seq_client_pool_t container on stack
| typedef struct _snd_seq_client_info snd_seq_client_info_t |
client information container
| typedef struct _snd_seq_client_pool snd_seq_client_pool_t |
client pool information container
| anonymous enum |
| void snd_seq_client_info_copy | ( | snd_seq_client_info_t * | dst, |
| const snd_seq_client_info_t * | src ) |
copy one snd_seq_client_info_t to another
| dst | pointer to destination |
| src | pointer to source |
| void snd_seq_client_info_event_filter_add | ( | snd_seq_client_info_t * | info, |
| int | event_type ) |
Add an event type to the event filtering of a client_info container.
| info | client_info container |
| event_type | event type to be added |
Set the event filtering flag of this client_info and add the specified event type to the filter bitmap of this client_info container.
| int snd_seq_client_info_event_filter_check | ( | snd_seq_client_info_t * | info, |
| int | event_type ) |
Check if an event type is present in the event filtering of a client_info container.
| info | client_info container |
| event_type | event type to be checked |
Test if the event type is in the filter bitmap of this client_info container.
| void snd_seq_client_info_event_filter_clear | ( | snd_seq_client_info_t * | info | ) |
Disable event filtering of a client_info container.
| info | client_info container |
Remove all event types added with snd_seq_client_info_event_filter_add and clear the event filtering flag of this client_info container.
| void snd_seq_client_info_event_filter_del | ( | snd_seq_client_info_t * | info, |
| int | event_type ) |
Remove an event type from the event filtering of a client_info container.
| info | client_info container |
| event_type | event type to be removed |
Removes the specified event from the filter bitmap of this client_info container. It will not clear the event filtering flag, use snd_seq_client_info_event_filter_clear instead.
| void snd_seq_client_info_free | ( | snd_seq_client_info_t * | obj | ) |
frees a previously allocated snd_seq_client_info_t
| obj | pointer to object to free |
| int snd_seq_client_info_get_broadcast_filter | ( | const snd_seq_client_info_t * | info | ) |
Get the broadcast filter usage of a client_info container.
| info | client_info container |
| int snd_seq_client_info_get_card | ( | const snd_seq_client_info_t * | info | ) |
Get the sound card number.
| info | client_info container |
Only available for SND_SEQ_KERNEL_CLIENT clients.
The card number can be used to query state about the hardware device providing this client, by concatenating "hw:CARD=" with the card number and using it as the name parameter to snd_ctl_open().
| int snd_seq_client_info_get_client | ( | const snd_seq_client_info_t * | info | ) |
Get client id of a client_info container.
| info | client_info container |
| int snd_seq_client_info_get_error_bounce | ( | const snd_seq_client_info_t * | info | ) |
Get the error-bounce usage of a client_info container.
| info | client_info container |
| const unsigned char * snd_seq_client_info_get_event_filter | ( | const snd_seq_client_info_t * | info | ) |
(DEPRECATED) Get the event filter bitmap of a client_info container
| info | client_info container |
Use snd_seq_client_info_event_filter_check() instead.
| int snd_seq_client_info_get_event_lost | ( | const snd_seq_client_info_t * | info | ) |
Get the number of lost events of a client_info container.
| info | client_info container |
| int snd_seq_client_info_get_midi_version | ( | const snd_seq_client_info_t * | info | ) |
Get the MIDI protocol version number of a client_info container.
| info | client_info container |
| const char * snd_seq_client_info_get_name | ( | snd_seq_client_info_t * | info | ) |
Get the name of a client_info container.
| info | client_info container |
| int snd_seq_client_info_get_num_ports | ( | const snd_seq_client_info_t * | info | ) |
Get the number of opened ports of a client_info container.
| info | client_info container |
| int snd_seq_client_info_get_pid | ( | const snd_seq_client_info_t * | info | ) |
Get the owning PID.
| info | client_info container |
Only available for SND_SEQ_USER_CLIENT clients.
| snd_seq_client_type_t snd_seq_client_info_get_type | ( | const snd_seq_client_info_t * | info | ) |
Get client type of a client_info container.
| info | client_info container |
The client type is either SND_SEQ_KERNEL_CLIENT or SND_SEQ_USER_CLIENT for kernel or user client respectively.
| int snd_seq_client_info_get_ump_conversion | ( | const snd_seq_client_info_t * | info | ) |
Get the automatic conversion mode for UMP.
| info | client_info container |
| int snd_seq_client_info_get_ump_group_enabled | ( | const snd_seq_client_info_t * | info, |
| int | group ) |
Get the UMP group filter status.
| info | client_info container |
| group | 0-based group index |
| int snd_seq_client_info_get_ump_groupless_enabled | ( | const snd_seq_client_info_t * | info | ) |
Get the UMP groupless message handling status.
| info | client_info container |
| int snd_seq_client_info_malloc | ( | snd_seq_client_info_t ** | ptr | ) |
allocate an empty snd_seq_client_info_t using standard malloc
| ptr | returned pointer |
| void snd_seq_client_info_set_broadcast_filter | ( | snd_seq_client_info_t * | info, |
| int | val ) |
Set the broadcast filter usage of a client_info container.
| info | client_info container |
| val | non-zero if broadcast is accepted |
| void snd_seq_client_info_set_client | ( | snd_seq_client_info_t * | info, |
| int | client ) |
Set the client id of a client_info container.
| info | client_info container |
| client | client id |
| void snd_seq_client_info_set_error_bounce | ( | snd_seq_client_info_t * | info, |
| int | val ) |
Set the error-bounce usage of a client_info container.
| info | client_info container |
| val | non-zero if error is bounced |
| void snd_seq_client_info_set_event_filter | ( | snd_seq_client_info_t * | info, |
| unsigned char * | filter ) |
(DEPRECATED) Set the event filter bitmap of a client_info container
| info | client_info container |
| filter | event filter bitmap, pass NULL for no event filtering |
Use snd_seq_client_info_event_filter_add instead.
| void snd_seq_client_info_set_midi_version | ( | snd_seq_client_info_t * | info, |
| int | midi_version ) |
Set the MIDI protocol version of a client_info container.
| info | client_info container |
| midi_version | MIDI protocol version to set |
| void snd_seq_client_info_set_name | ( | snd_seq_client_info_t * | info, |
| const char * | name ) |
Set the name of a client_info container.
| info | client_info container |
| name | name string |
| void snd_seq_client_info_set_ump_conversion | ( | snd_seq_client_info_t * | info, |
| int | enable ) |
Set the automatic conversion mode for UMP.
| info | client_info container |
| enable | 0 or 1 for disabling/enabling the conversion |
| void snd_seq_client_info_set_ump_group_enabled | ( | snd_seq_client_info_t * | info, |
| int | group, | ||
| int | enable ) |
Set the UMP group filter status.
| info | client_info container |
| group | 0-based group index |
| enable | 0 to filter/disable the group, non-zero to enable |
| void snd_seq_client_info_set_ump_groupless_enabled | ( | snd_seq_client_info_t * | info, |
| int | enable ) |
Enable/disable the UMP groupless message handling.
| info | client_info container |
| enable | enable the UMP groupless messages |
| size_t snd_seq_client_info_sizeof | ( | void | ) |
get size of snd_seq_client_info_t
| void snd_seq_client_pool_copy | ( | snd_seq_client_pool_t * | dst, |
| const snd_seq_client_pool_t * | src ) |
copy one snd_seq_client_pool_t to another
| dst | pointer to destination |
| src | pointer to source |
| void snd_seq_client_pool_free | ( | snd_seq_client_pool_t * | obj | ) |
frees a previously allocated snd_seq_client_pool_t
| obj | pointer to object to free |
| int snd_seq_client_pool_get_client | ( | const snd_seq_client_pool_t * | info | ) |
Get the client id of a queue_info container.
| info | client_pool container |
| size_t snd_seq_client_pool_get_input_free | ( | const snd_seq_client_pool_t * | info | ) |
Get the available size on input pool of a queue_info container.
| info | client_pool container |
| size_t snd_seq_client_pool_get_input_pool | ( | const snd_seq_client_pool_t * | info | ) |
Get the input pool size of a queue_info container.
| info | client_pool container |
| size_t snd_seq_client_pool_get_output_free | ( | const snd_seq_client_pool_t * | info | ) |
Get the available size on output pool of a queue_info container.
| info | client_pool container |
| size_t snd_seq_client_pool_get_output_pool | ( | const snd_seq_client_pool_t * | info | ) |
Get the output pool size of a queue_info container.
| info | client_pool container |
| size_t snd_seq_client_pool_get_output_room | ( | const snd_seq_client_pool_t * | info | ) |
Get the output room size of a queue_info container.
| info | client_pool container |
| int snd_seq_client_pool_malloc | ( | snd_seq_client_pool_t ** | ptr | ) |
allocate an empty snd_seq_client_pool_t using standard malloc
| ptr | returned pointer |
| void snd_seq_client_pool_set_input_pool | ( | snd_seq_client_pool_t * | info, |
| size_t | size ) |
Set the input pool size of a queue_info container.
| info | client_pool container |
| size | input pool size |
| void snd_seq_client_pool_set_output_pool | ( | snd_seq_client_pool_t * | info, |
| size_t | size ) |
Set the output pool size of a queue_info container.
| info | client_pool container |
| size | output pool size |
| void snd_seq_client_pool_set_output_room | ( | snd_seq_client_pool_t * | info, |
| size_t | size ) |
Set the output room size of a queue_info container.
| info | client_pool container |
| size | output room size |
| size_t snd_seq_client_pool_sizeof | ( | void | ) |
get size of snd_seq_client_pool_t
| int snd_seq_get_any_client_info | ( | snd_seq_t * | seq, |
| int | client, | ||
| snd_seq_client_info_t * | info ) |
obtain the information of the given client
| seq | sequencer handle |
| client | client id |
| info | the pointer to be stored |
Obtains the information of the client with a client id specified by info argument. The obtained information is written on info parameter.
| int snd_seq_get_client_info | ( | snd_seq_t * | seq, |
| snd_seq_client_info_t * | info ) |
obtain the current client information
| seq | sequencer handle |
| info | the pointer to be stored |
Obtains the information of the current client stored on info. client and type fields are ignored.
| int snd_seq_get_client_pool | ( | snd_seq_t * | seq, |
| snd_seq_client_pool_t * | info ) |
obtain the pool information of the current client
| seq | sequencer handle |
| info | information to be stored |
| int snd_seq_get_ump_block_info | ( | snd_seq_t * | seq, |
| int | client, | ||
| int | blk, | ||
| void * | info ) |
Get UMP Block information.
| seq | sequencer handle |
| client | sequencer client number to query |
| blk | UMP block number (0-based) to query |
| info | the pointer to store snd_ump_block_info_t data |
| int snd_seq_get_ump_endpoint_info | ( | snd_seq_t * | seq, |
| int | client, | ||
| void * | info ) |
Get UMP Endpoint information.
| seq | sequencer handle |
| client | client number to query |
| info | the pointer to store snd_ump_endpoint_info_t data |
| int snd_seq_query_next_client | ( | snd_seq_t * | seq, |
| snd_seq_client_info_t * | info ) |
query the next client
| seq | sequencer handle |
| info | query pattern and result |
Queries the next client. The search begins at the client with an id one greater than client field in info. If a client is found, its attributes are stored in info, and zero is returned. Otherwise returns a negative error code.
| int snd_seq_set_client_info | ( | snd_seq_t * | seq, |
| snd_seq_client_info_t * | info ) |
set the current client information
| seq | sequencer handle |
| info | the client info data to set |
Obtains the information of the current client stored on info. client and type fields are ignored.
| int snd_seq_set_client_pool | ( | snd_seq_t * | seq, |
| snd_seq_client_pool_t * | info ) |
set the pool information
| seq | sequencer handle |
| info | information to update |
Sets the pool information of the current client. The client field in info is replaced automatically with the current id.
| int snd_seq_set_ump_block_info | ( | snd_seq_t * | seq, |
| int | blk, | ||
| const void * | info ) |
Set UMP Block information to the current client.
| seq | sequencer handle |
| blk | UMP block number (0-based) to send |
| info | the pointer to send snd_ump_block_info_t data |
| int snd_seq_set_ump_endpoint_info | ( | snd_seq_t * | seq, |
| const void * | info ) |
Set UMP Endpoint information to the current client.
| seq | sequencer handle |
| info | the pointer to send snd_ump_endpoint_info_t data |