Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages   Examples  

seq.c File Reference

Sequencer Interface. More...


Functions

const char * snd_seq_name (snd_seq_t *seq)
 get identifier of sequencer handle

snd_seq_type_t snd_seq_type (snd_seq_t *seq)
 get type of sequencer handle

int snd_seq_open (snd_seq_t **seqp, const char *name, int streams, int mode)
 Open the ALSA sequencer.

int snd_seq_open_lconf (snd_seq_t **seqp, const char *name, int streams, int mode, snd_config_t *lconf)
 Open the ALSA sequencer using local configuration.

int snd_seq_close (snd_seq_t *seq)
 Close the sequencer.

int snd_seq_poll_descriptors_count (snd_seq_t *seq, short events)
 Returns the number of poll descriptors.

int snd_seq_poll_descriptors (snd_seq_t *seq, struct pollfd *pfds, unsigned int space, short events)
 Get poll descriptors.

int snd_seq_poll_descriptors_revents (snd_seq_t *seq, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
 get returned events from poll descriptors

int snd_seq_nonblock (snd_seq_t *seq, int nonblock)
 Set nonblock mode.

int snd_seq_client_id (snd_seq_t *seq)
 Get the client id.

size_t snd_seq_get_output_buffer_size (snd_seq_t *seq)
 Return the size of output buffer.

size_t snd_seq_get_input_buffer_size (snd_seq_t *seq)
 Return the size of input buffer.

int snd_seq_set_output_buffer_size (snd_seq_t *seq, size_t size)
 Change the size of output buffer.

int snd_seq_set_input_buffer_size (snd_seq_t *seq, size_t size)
 Resize the input buffer.

size_t snd_seq_system_info_sizeof ()
 Get size of snd_seq_system_info_t.

int snd_seq_system_info_malloc (snd_seq_system_info_t **ptr)
 Allocate an empty snd_seq_system_info_t using standard malloc.

void snd_seq_system_info_free (snd_seq_system_info_t *obj)
 Frees a previously allocated snd_seq_system_info_t.

void snd_seq_system_info_copy (snd_seq_system_info_t *dst, const snd_seq_system_info_t *src)
 Copy one snd_seq_system_info_t to another.

int snd_seq_system_info_get_queues (const snd_seq_system_info_t *info)
 Get maximum number of queues.

int snd_seq_system_info_get_clients (const snd_seq_system_info_t *info)
 Get maximum number of clients.

int snd_seq_system_info_get_ports (const snd_seq_system_info_t *info)
 Get maximum number of ports.

int snd_seq_system_info_get_channels (const snd_seq_system_info_t *info)
 Get maximum number of channels.

int snd_seq_system_info_get_cur_clients (const snd_seq_system_info_t *info)
 Get the current number of clients.

int snd_seq_system_info_get_cur_queues (const snd_seq_system_info_t *info)
 Get the current number of queues.

int snd_seq_system_info (snd_seq_t *seq, snd_seq_system_info_t *info)
 obtain the sequencer system information

size_t snd_seq_client_info_sizeof ()
 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 *obj)
 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.

const unsigned char * snd_seq_client_info_get_event_filter (const snd_seq_client_info_t *info)
 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.

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)
 Set the event filter bitmap of a client_info container.

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

int snd_seq_get_client_info (snd_seq_t *seq, snd_seq_client_info_t *info)
 obtain the current client information

int snd_seq_set_client_info (snd_seq_t *seq, snd_seq_client_info_t *info)
 set the current client information

int snd_seq_query_next_client (snd_seq_t *seq, snd_seq_client_info_t *info)
 query the next matching client

size_t snd_seq_port_info_sizeof ()
 get size of snd_seq_port_info_t

int snd_seq_port_info_malloc (snd_seq_port_info_t **ptr)
 allocate an empty snd_seq_port_info_t using standard malloc

void snd_seq_port_info_free (snd_seq_port_info_t *obj)
 frees a previously allocated snd_seq_port_info_t

void snd_seq_port_info_copy (snd_seq_port_info_t *dst, const snd_seq_port_info_t *src)
 copy one snd_seq_port_info_t to another

int snd_seq_port_info_get_client (const snd_seq_port_info_t *info)
 Get client id of a port_info container.

int snd_seq_port_info_get_port (const snd_seq_port_info_t *info)
 Get port id of a port_info container.

const snd_seq_addr_tsnd_seq_port_info_get_addr (const snd_seq_port_info_t *info)
 Get client/port address of a port_info container.

const char * snd_seq_port_info_get_name (const snd_seq_port_info_t *info)
 Get the name of a port_info container.

unsigned int snd_seq_port_info_get_capability (const snd_seq_port_info_t *info)
 Get the capability bits of a port_info container.

unsigned int snd_seq_port_info_get_type (const snd_seq_port_info_t *info)
 Get the type bits of a port_info container.

int snd_seq_port_info_get_read_use (const snd_seq_port_info_t *info)
 Get the number of read subscriptions of a port_info container.

int snd_seq_port_info_get_write_use (const snd_seq_port_info_t *info)
 Get the number of write subscriptions of a port_info container.

int snd_seq_port_info_get_midi_channels (const snd_seq_port_info_t *info)
 Get the midi channels of a port_info container.

int snd_seq_port_info_get_midi_voices (const snd_seq_port_info_t *info)
 Get the midi voices of a port_info container.

int snd_seq_port_info_get_synth_voices (const snd_seq_port_info_t *info)
 Get the synth voices of a port_info container.

int snd_seq_port_info_get_port_specified (const snd_seq_port_info_t *info)
 Get the port-specified mode of a port_info container.

void snd_seq_port_info_set_client (snd_seq_port_info_t *info, int client)
 Set the client id of a port_info container.

void snd_seq_port_info_set_port (snd_seq_port_info_t *info, int port)
 Set the port id of a port_info container.

void snd_seq_port_info_set_addr (snd_seq_port_info_t *info, const snd_seq_addr_t *addr)
 Set the client/port address of a port_info container.

void snd_seq_port_info_set_name (snd_seq_port_info_t *info, const char *name)
 Set the name of a port_info container.

void snd_seq_port_info_set_capability (snd_seq_port_info_t *info, unsigned int capability)
 set the capability bits of a port_info container

void snd_seq_port_info_set_type (snd_seq_port_info_t *info, unsigned int type)
 Get the type bits of a port_info container.

void snd_seq_port_info_set_midi_channels (snd_seq_port_info_t *info, int channels)
 set the midi channels of a port_info container

void snd_seq_port_info_set_midi_voices (snd_seq_port_info_t *info, int voices)
 set the midi voices of a port_info container

void snd_seq_port_info_set_synth_voices (snd_seq_port_info_t *info, int voices)
 set the synth voices of a port_info container

void snd_seq_port_info_set_port_specified (snd_seq_port_info_t *info, int val)
 Set the port-specified mode of a port_info container.

int snd_seq_create_port (snd_seq_t *seq, snd_seq_port_info_t *port)
 create a sequencer port on the current client

int snd_seq_delete_port (snd_seq_t *seq, int port)
 delete a sequencer port on the current client

int snd_seq_get_any_port_info (snd_seq_t *seq, int client, int port, snd_seq_port_info_t *info)
 obtain the information of a port on an arbitrary client

int snd_seq_get_port_info (snd_seq_t *seq, int port, snd_seq_port_info_t *info)
 obtain the information of a port on the current client

int snd_seq_set_port_info (snd_seq_t *seq, int port, snd_seq_port_info_t *info)
 set the information of a port on the current client

int snd_seq_query_next_port (snd_seq_t *seq, snd_seq_port_info_t *info)
 query the next matching port

size_t snd_seq_port_subscribe_sizeof ()
 get size of snd_seq_port_subscribe_t

int snd_seq_port_subscribe_malloc (snd_seq_port_subscribe_t **ptr)
 allocate an empty snd_seq_port_subscribe_t using standard malloc

void snd_seq_port_subscribe_free (snd_seq_port_subscribe_t *obj)
 frees a previously allocated snd_seq_port_subscribe_t

void snd_seq_port_subscribe_copy (snd_seq_port_subscribe_t *dst, const snd_seq_port_subscribe_t *src)
 copy one snd_seq_port_subscribe_t to another

const snd_seq_addr_tsnd_seq_port_subscribe_get_sender (const snd_seq_port_subscribe_t *info)
 Get sender address of a port_subscribe container.

const snd_seq_addr_tsnd_seq_port_subscribe_get_dest (const snd_seq_port_subscribe_t *info)
 Get destination address of a port_subscribe container.

int snd_seq_port_subscribe_get_queue (const snd_seq_port_subscribe_t *info)
 Get the queue id of a port_subscribe container.

int snd_seq_port_subscribe_get_exclusive (const snd_seq_port_subscribe_t *info)
 Get the exclusive mode of a port_subscribe container.

int snd_seq_port_subscribe_get_time_update (const snd_seq_port_subscribe_t *info)
 Get the time-update mode of a port_subscribe container.

int snd_seq_port_subscribe_get_time_real (const snd_seq_port_subscribe_t *info)
 Get the real-time update mode of a port_subscribe container.

void snd_seq_port_subscribe_set_sender (snd_seq_port_subscribe_t *info, const snd_seq_addr_t *addr)
 Set sender address of a port_subscribe container.

void snd_seq_port_subscribe_set_dest (snd_seq_port_subscribe_t *info, const snd_seq_addr_t *addr)
 Set destination address of a port_subscribe container.

void snd_seq_port_subscribe_set_queue (snd_seq_port_subscribe_t *info, int q)
 Set the queue id of a port_subscribe container.

void snd_seq_port_subscribe_set_voices (snd_seq_port_subscribe_t *info, unsigned int voices)
 Set the voices of a port_subscribe container.

void snd_seq_port_subscribe_set_exclusive (snd_seq_port_subscribe_t *info, int val)
 Set the exclusive mode of a port_subscribe container.

void snd_seq_port_subscribe_set_time_update (snd_seq_port_subscribe_t *info, int val)
 Set the time-update mode of a port_subscribe container.

void snd_seq_port_subscribe_set_time_real (snd_seq_port_subscribe_t *info, int val)
 Set the real-time mode of a port_subscribe container.

int snd_seq_get_port_subscription (snd_seq_t *seq, snd_seq_port_subscribe_t *sub)
 obtain subscription information

int snd_seq_subscribe_port (snd_seq_t *seq, snd_seq_port_subscribe_t *sub)
 subscribe a port connection

int snd_seq_unsubscribe_port (snd_seq_t *seq, snd_seq_port_subscribe_t *sub)
 unsubscribe a connection between ports

size_t snd_seq_query_subscribe_sizeof ()
 get size of snd_seq_query_subscribe_t

int snd_seq_query_subscribe_malloc (snd_seq_query_subscribe_t **ptr)
 allocate an empty snd_seq_query_subscribe_t using standard malloc

void snd_seq_query_subscribe_free (snd_seq_query_subscribe_t *obj)
 frees a previously allocated snd_seq_query_subscribe_t

void snd_seq_query_subscribe_copy (snd_seq_query_subscribe_t *dst, const snd_seq_query_subscribe_t *src)
 copy one snd_seq_query_subscribe_t to another

int snd_seq_query_subscribe_get_client (const snd_seq_query_subscribe_t *info)
 Get the client id of a query_subscribe container.

int snd_seq_query_subscribe_get_port (const snd_seq_query_subscribe_t *info)
 Get the port id of a query_subscribe container.

const snd_seq_addr_tsnd_seq_query_subscribe_get_root (const snd_seq_query_subscribe_t *info)
 Get the client/port address of a query_subscribe container.

snd_seq_query_subs_type_t snd_seq_query_subscribe_get_type (const snd_seq_query_subscribe_t *info)
 Get the query type of a query_subscribe container.

int snd_seq_query_subscribe_get_index (const snd_seq_query_subscribe_t *info)
 Get the index of subscriber of a query_subscribe container.

int snd_seq_query_subscribe_get_num_subs (const snd_seq_query_subscribe_t *info)
 Get the number of subscriptions of a query_subscribe container.

const snd_seq_addr_tsnd_seq_query_subscribe_get_addr (const snd_seq_query_subscribe_t *info)
 Get the address of subscriber of a query_subscribe container.

int snd_seq_query_subscribe_get_queue (const snd_seq_query_subscribe_t *info)
 Get the queue id of subscriber of a query_subscribe container.

int snd_seq_query_subscribe_get_exclusive (const snd_seq_query_subscribe_t *info)
 Get the exclusive mode of a query_subscribe container.

int snd_seq_query_subscribe_get_time_update (const snd_seq_query_subscribe_t *info)
 Get the time-update mode of a query_subscribe container.

int snd_seq_query_subscribe_get_time_real (const snd_seq_query_subscribe_t *info)
 Get the real-time update mode of a query_subscribe container.

void snd_seq_query_subscribe_set_client (snd_seq_query_subscribe_t *info, int client)
 Set the client id of a query_subscribe container.

void snd_seq_query_subscribe_set_port (snd_seq_query_subscribe_t *info, int port)
 Set the port id of a query_subscribe container.

void snd_seq_query_subscribe_set_root (snd_seq_query_subscribe_t *info, const snd_seq_addr_t *addr)
 Set the client/port address of a query_subscribe container.

void snd_seq_query_subscribe_set_type (snd_seq_query_subscribe_t *info, snd_seq_query_subs_type_t type)
 Set the query type of a query_subscribe container.

void snd_seq_query_subscribe_set_index (snd_seq_query_subscribe_t *info, int index)
 Set the subscriber's index to be queried.

int snd_seq_query_port_subscribers (snd_seq_t *seq, snd_seq_query_subscribe_t *subs)
 query port subscriber list

size_t snd_seq_queue_info_sizeof ()
 get size of snd_seq_queue_info_t

int snd_seq_queue_info_malloc (snd_seq_queue_info_t **ptr)
 allocate an empty snd_seq_queue_info_t using standard malloc

void snd_seq_queue_info_free (snd_seq_queue_info_t *obj)
 frees a previously allocated snd_seq_queue_info_t

void snd_seq_queue_info_copy (snd_seq_queue_info_t *dst, const snd_seq_queue_info_t *src)
 copy one snd_seq_queue_info_t to another

int snd_seq_queue_info_get_queue (const snd_seq_queue_info_t *info)
 Get the queue id of a queue_info container.

const char * snd_seq_queue_info_get_name (const snd_seq_queue_info_t *info)
 Get the name of a queue_info container.

int snd_seq_queue_info_get_owner (const snd_seq_queue_info_t *info)
 Get the owner client id of a queue_info container.

int snd_seq_queue_info_get_locked (const snd_seq_queue_info_t *info)
 Get the lock status of a queue_info container.

unsigned int snd_seq_queue_info_get_flags (const snd_seq_queue_info_t *info)
 Get the conditional bit flags of a queue_info container.

void snd_seq_queue_info_set_name (snd_seq_queue_info_t *info, const char *name)
 Set the name of a queue_info container.

void snd_seq_queue_info_set_owner (snd_seq_queue_info_t *info, int owner)
 Set the owner client id of a queue_info container.

void snd_seq_queue_info_set_locked (snd_seq_queue_info_t *info, int locked)
 Set the lock status of a queue_info container.

void snd_seq_queue_info_set_flags (snd_seq_queue_info_t *info, unsigned int flags)
 Set the conditional bit flags of a queue_info container.

int snd_seq_create_queue (snd_seq_t *seq, snd_seq_queue_info_t *info)
 create a queue

int snd_seq_alloc_named_queue (snd_seq_t *seq, const char *name)
 allocate a queue with the specified name

int snd_seq_alloc_queue (snd_seq_t *seq)
 allocate a queue

int snd_seq_free_queue (snd_seq_t *seq, int q)
 delete the specified queue

int snd_seq_get_queue_info (snd_seq_t *seq, int q, snd_seq_queue_info_t *info)
 obtain queue attributes

int snd_seq_set_queue_info (snd_seq_t *seq, int q, snd_seq_queue_info_t *info)
 change the queue attributes

int snd_seq_query_named_queue (snd_seq_t *seq, const char *name)
 query the matching queue with the specified name

int snd_seq_get_queue_usage (snd_seq_t *seq, int q)
 Get the queue usage flag to the client.

int snd_seq_set_queue_usage (snd_seq_t *seq, int q, int used)
 Set the queue usage flag to the client.

size_t snd_seq_queue_status_sizeof ()
 get size of snd_seq_queue_status_t

int snd_seq_queue_status_malloc (snd_seq_queue_status_t **ptr)
 allocate an empty snd_seq_queue_status_t using standard malloc

void snd_seq_queue_status_free (snd_seq_queue_status_t *obj)
 frees a previously allocated snd_seq_queue_status_t

void snd_seq_queue_status_copy (snd_seq_queue_status_t *dst, const snd_seq_queue_status_t *src)
 copy one snd_seq_queue_status_t to another

int snd_seq_queue_status_get_queue (const snd_seq_queue_status_t *info)
 Get the queue id of a queue_status container.

int snd_seq_queue_status_get_events (const snd_seq_queue_status_t *info)
 Get the number of events of a queue_status container.

snd_seq_tick_time_t snd_seq_queue_status_get_tick_time (const snd_seq_queue_status_t *info)
 Get the tick time of a queue_status container.

const snd_seq_real_time_tsnd_seq_queue_status_get_real_time (const snd_seq_queue_status_t *info)
 Get the real time of a queue_status container.

unsigned int snd_seq_queue_status_get_status (const snd_seq_queue_status_t *info)
 Get the running status bits of a queue_status container.

int snd_seq_get_queue_status (snd_seq_t *seq, int q, snd_seq_queue_status_t *status)
 obtain the running state of the queue

size_t snd_seq_queue_tempo_sizeof ()
 get size of snd_seq_queue_tempo_t

int snd_seq_queue_tempo_malloc (snd_seq_queue_tempo_t **ptr)
 allocate an empty snd_seq_queue_tempo_t using standard malloc

void snd_seq_queue_tempo_free (snd_seq_queue_tempo_t *obj)
 frees a previously allocated snd_seq_queue_tempo_t

void snd_seq_queue_tempo_copy (snd_seq_queue_tempo_t *dst, const snd_seq_queue_tempo_t *src)
 copy one snd_seq_queue_tempo_t to another

int snd_seq_queue_tempo_get_queue (const snd_seq_queue_tempo_t *info)
 Get the queue id of a queue_status container.

unsigned int snd_seq_queue_tempo_get_tempo (const snd_seq_queue_tempo_t *info)
 Get the tempo of a queue_status container.

int snd_seq_queue_tempo_get_ppq (const snd_seq_queue_tempo_t *info)
 Get the ppq of a queue_status container.

unsigned int snd_seq_queue_tempo_get_skew (const snd_seq_queue_tempo_t *info)
 Get the timer skew value of a queue_status container.

unsigned int snd_seq_queue_tempo_get_skew_base (const snd_seq_queue_tempo_t *info)
 Get the timer skew base value of a queue_status container.

void snd_seq_queue_tempo_set_tempo (snd_seq_queue_tempo_t *info, unsigned int tempo)
 Set the tempo of a queue_status container.

void snd_seq_queue_tempo_set_ppq (snd_seq_queue_tempo_t *info, int ppq)
 Set the ppq of a queue_status container.

void snd_seq_queue_tempo_set_skew (snd_seq_queue_tempo_t *info, unsigned int skew)
 Set the timer skew value of a queue_status container.

void snd_seq_queue_tempo_set_skew_base (snd_seq_queue_tempo_t *info, unsigned int base)
 Set the timer skew base value of a queue_status container.

int snd_seq_get_queue_tempo (snd_seq_t *seq, int q, snd_seq_queue_tempo_t *tempo)
 obtain the current tempo of the queue

int snd_seq_set_queue_tempo (snd_seq_t *seq, int q, snd_seq_queue_tempo_t *tempo)
 set the tempo of the queue

size_t snd_seq_queue_timer_sizeof ()
 get size of snd_seq_queue_timer_t

int snd_seq_queue_timer_malloc (snd_seq_queue_timer_t **ptr)
 allocate an empty snd_seq_queue_timer_t using standard malloc

void snd_seq_queue_timer_free (snd_seq_queue_timer_t *obj)
 frees a previously allocated snd_seq_queue_timer_t

void snd_seq_queue_timer_copy (snd_seq_queue_timer_t *dst, const snd_seq_queue_timer_t *src)
 copy one snd_seq_queue_timer_t to another

int snd_seq_queue_timer_get_queue (const snd_seq_queue_timer_t *info)
 Get the queue id of a queue_timer container.

snd_seq_queue_timer_type_t snd_seq_queue_timer_get_type (const snd_seq_queue_timer_t *info)
 Get the timer type of a queue_timer container.

const snd_timer_id_tsnd_seq_queue_timer_get_id (const snd_seq_queue_timer_t *info)
 Get the timer id of a queue_timer container.

unsigned int snd_seq_queue_timer_get_resolution (const snd_seq_queue_timer_t *info)
 Get the timer resolution of a queue_timer container.

void snd_seq_queue_timer_set_type (snd_seq_queue_timer_t *info, snd_seq_queue_timer_type_t type)
 Set the timer type of a queue_timer container.

void snd_seq_queue_timer_set_id (snd_seq_queue_timer_t *info, const snd_timer_id_t *id)
 Set the timer id of a queue_timer container.

void snd_seq_queue_timer_set_resolution (snd_seq_queue_timer_t *info, unsigned int resolution)
 Set the timer resolution of a queue_timer container.

int snd_seq_get_queue_timer (snd_seq_t *seq, int q, snd_seq_queue_timer_t *timer)
 obtain the queue timer information

int snd_seq_set_queue_timer (snd_seq_t *seq, int q, snd_seq_queue_timer_t *timer)
 set the queue timer information

int snd_seq_free_event (snd_seq_event_t *ev)
 (DEPRECATED) free an event

ssize_t snd_seq_event_length (snd_seq_event_t *ev)
 calculates the (encoded) byte-stream size of the event

int snd_seq_event_output (snd_seq_t *seq, snd_seq_event_t *ev)
 output an event

int snd_seq_event_output_buffer (snd_seq_t *seq, snd_seq_event_t *ev)
 output an event onto the lib buffer without draining buffer

int snd_seq_event_output_direct (snd_seq_t *seq, snd_seq_event_t *ev)
 output an event directly to the sequencer NOT through output buffer

int snd_seq_event_output_pending (snd_seq_t *seq)
 return the size of pending events on output buffer

int snd_seq_drain_output (snd_seq_t *seq)
 drain output buffer to sequencer

int snd_seq_extract_output (snd_seq_t *seq, snd_seq_event_t **ev_res)
 extract the first event in output buffer

int snd_seq_event_input (snd_seq_t *seq, snd_seq_event_t **ev)
 retrieve an event from sequencer

int snd_seq_event_input_pending (snd_seq_t *seq, int fetch_sequencer)
 check events in input buffer

int snd_seq_drop_output_buffer (snd_seq_t *seq)
 remove all events on user-space output buffer

int snd_seq_drop_input_buffer (snd_seq_t *seq)
 remove all events on user-space input FIFO

int snd_seq_drop_output (snd_seq_t *seq)
 remove all events on output buffer

int snd_seq_drop_input (snd_seq_t *seq)
 clear input buffer and and remove events in sequencer queue

size_t snd_seq_remove_events_sizeof ()
 get size of snd_seq_remove_events_t

int snd_seq_remove_events_malloc (snd_seq_remove_events_t **ptr)
 allocate an empty snd_seq_remove_events_t using standard malloc

void snd_seq_remove_events_free (snd_seq_remove_events_t *obj)
 frees a previously allocated snd_seq_remove_events_t

void snd_seq_remove_events_copy (snd_seq_remove_events_t *dst, const snd_seq_remove_events_t *src)
 copy one snd_seq_remove_events_t to another

unsigned int snd_seq_remove_events_get_condition (const snd_seq_remove_events_t *info)
 Get the removal condition bits.

int snd_seq_remove_events_get_queue (const snd_seq_remove_events_t *info)
 Get the queue as removal condition.

const snd_seq_timestamp_tsnd_seq_remove_events_get_time (const snd_seq_remove_events_t *info)
 Get the event timestamp as removal condition.

const snd_seq_addr_tsnd_seq_remove_events_get_dest (const snd_seq_remove_events_t *info)
 Get the event destination address as removal condition.

int snd_seq_remove_events_get_channel (const snd_seq_remove_events_t *info)
 Get the event channel as removal condition.

int snd_seq_remove_events_get_event_type (const snd_seq_remove_events_t *info)
 Get the event type as removal condition.

int snd_seq_remove_events_get_tag (const snd_seq_remove_events_t *info)
 Get the event tag id as removal condition.

void snd_seq_remove_events_set_condition (snd_seq_remove_events_t *info, unsigned int flags)
 Set the removal condition bits.

void snd_seq_remove_events_set_queue (snd_seq_remove_events_t *info, int queue)
 Set the queue as removal condition.

void snd_seq_remove_events_set_time (snd_seq_remove_events_t *info, const snd_seq_timestamp_t *time)
 Set the timestamp as removal condition.

void snd_seq_remove_events_set_dest (snd_seq_remove_events_t *info, const snd_seq_addr_t *addr)
 Set the destination address as removal condition.

void snd_seq_remove_events_set_channel (snd_seq_remove_events_t *info, int channel)
 Set the channel as removal condition.

void snd_seq_remove_events_set_event_type (snd_seq_remove_events_t *info, int type)
 Set the event type as removal condition.

void snd_seq_remove_events_set_tag (snd_seq_remove_events_t *info, int tag)
 Set the event tag as removal condition.

int snd_seq_remove_events (snd_seq_t *seq, snd_seq_remove_events_t *rmp)
 remove events on input/output buffers

size_t snd_seq_client_pool_sizeof ()
 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 *obj)
 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 *seq, snd_seq_client_pool_t *info)
 obtain the pool information of the current client

int snd_seq_set_client_pool (snd_seq_t *seq, snd_seq_client_pool_t *info)
 set the pool information

void snd_seq_set_bit (int nr, void *array)
 set a bit flag

int snd_seq_change_bit (int nr, void *array)
 change a bit flag

int snd_seq_get_bit (int nr, void *array)
 get a bit flag state

size_t snd_instr_header_sizeof (void)
 get size of snd_instr_header_t

int snd_instr_header_malloc (snd_instr_header_t **ptr, size_t len)
 allocate an empty snd_instr_header_t using standard malloc

void snd_instr_header_free (snd_instr_header_t *obj)
 frees a previously allocated snd_instr_header_t

void snd_instr_header_copy (snd_instr_header_t *dst, const snd_instr_header_t *src)
 copy one snd_instr_header_t to another

const snd_seq_instr_tsnd_instr_header_get_id (const snd_instr_header_t *info)
 Get the instrument id of an instr_header container.

snd_seq_instr_cluster_t snd_instr_header_get_cluster (const snd_instr_header_t *info)
 Get the cluster id of an instr_header container.

unsigned int snd_instr_header_get_cmd (const snd_instr_header_t *info)
 Get the command of an instr_header container.

size_t snd_instr_header_get_len (const snd_instr_header_t *info)
 Get the length of extra data of an instr_header container.

const char * snd_instr_header_get_name (const snd_instr_header_t *info)
 Get the data name of an instr_header container.

int snd_instr_header_get_type (const snd_instr_header_t *info)
 Get the data type of an instr_header container.

const char * snd_instr_header_get_format (const snd_instr_header_t *info)
 Get the data format of an instr_header container.

const snd_seq_instr_tsnd_instr_header_get_alias (const snd_instr_header_t *info)
 Get the data alias of an instr_header container.

void * snd_instr_header_get_data (const snd_instr_header_t *info)
 Get the extra data pointer of an instr_header container.

int snd_instr_header_get_follow_alias (const snd_instr_header_t *info)
 Get the flag to follow alias of an instr_header container.

void snd_instr_header_set_id (snd_instr_header_t *info, const snd_seq_instr_t *id)
 Set the instrument id of an instr_header container.

void snd_instr_header_set_cluster (snd_instr_header_t *info, snd_seq_instr_cluster_t cluster)
 Set the cluster id of an instr_header container.

void snd_instr_header_set_cmd (snd_instr_header_t *info, unsigned int cmd)
 Set the command of an instr_header container.

void snd_instr_header_set_len (snd_instr_header_t *info, size_t len)
 Set the length of extra data of an instr_header container.

void snd_instr_header_set_name (snd_instr_header_t *info, const char *name)
 Set the data name of an instr_header container.

void snd_instr_header_set_type (snd_instr_header_t *info, int type)
 Set the data type of an instr_header container.

void snd_instr_header_set_format (snd_instr_header_t *info, const char *format)
 Set the data format of an instr_header container.

void snd_instr_header_set_alias (snd_instr_header_t *info, const snd_seq_instr_t *instr)
 Set the data alias id of an instr_header container.

void snd_instr_header_set_follow_alias (snd_instr_header_t *info, int val)
 Set the flag to follow alias of an instr_header container.


Detailed Description

Sequencer Interface.

Author:
Jaroslav Kysela <perex@suse.cz> , Abramo Bagnara <abramo@alsa-project.org> , Takashi Iwai <tiwai@suse.de>
Date:
2000-2001
See Sequencer interface page for more details.


Function Documentation

void snd_instr_header_copy snd_instr_header_t   dst,
const snd_instr_header_t   src
 

copy one snd_instr_header_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_instr_header_free snd_instr_header_t   obj
 

frees a previously allocated snd_instr_header_t

Parameters:
pointer  to object to free

const snd_seq_instr_t* snd_instr_header_get_alias const snd_instr_header_t   info
 

Get the data alias of an instr_header container.

Parameters:
info  instr_header container
Returns:
the data alias id

snd_seq_instr_cluster_t snd_instr_header_get_cluster const snd_instr_header_t   info
 

Get the cluster id of an instr_header container.

Parameters:
info  instr_header container
Returns:
cluster id

unsigned int snd_instr_header_get_cmd const snd_instr_header_t   info
 

Get the command of an instr_header container.

Parameters:
info  instr_header container
Returns:
command type

void* snd_instr_header_get_data const snd_instr_header_t   info
 

Get the extra data pointer of an instr_header container.

Parameters:
info  instr_header container
Returns:
the extra data pointer

int snd_instr_header_get_follow_alias const snd_instr_header_t   info
 

Get the flag to follow alias of an instr_header container.

Parameters:
info  instr_header container
Returns:
1 if follow alias

const char* snd_instr_header_get_format const snd_instr_header_t   info
 

Get the data format of an instr_header container.

Parameters:
info  instr_header container
Returns:
the data format string

const snd_seq_instr_t* snd_instr_header_get_id const snd_instr_header_t   info
 

Get the instrument id of an instr_header container.

Parameters:
info  instr_header container
Returns:
instrument id pointer

size_t snd_instr_header_get_len const snd_instr_header_t   info
 

Get the length of extra data of an instr_header container.

Parameters:
info  instr_header container
Returns:
the length in bytes

const char* snd_instr_header_get_name const snd_instr_header_t   info
 

Get the data name of an instr_header container.

Parameters:
info  instr_header container
Returns:
the name string

int snd_instr_header_get_type const snd_instr_header_t   info
 

Get the data type of an instr_header container.

Parameters:
info  instr_header container
Returns:
the data type

int snd_instr_header_malloc snd_instr_header_t **    ptr,
size_t    len
 

allocate an empty snd_instr_header_t using standard malloc

Parameters:
ptr  returned pointer
len  additional data length
Returns:
0 on success otherwise negative error code

void snd_instr_header_set_alias snd_instr_header_t   info,
const snd_seq_instr_t   instr
 

Set the data alias id of an instr_header container.

Parameters:
info  instr_header container
instr  alias instrument id

void snd_instr_header_set_cluster snd_instr_header_t   info,
snd_seq_instr_cluster_t    cluster
 

Set the cluster id of an instr_header container.

Parameters:
info  instr_header container
cluster  cluster id

void snd_instr_header_set_cmd snd_instr_header_t   info,
unsigned int    cmd
 

Set the command of an instr_header container.

Parameters:
info  instr_header container
cmd  command type

void snd_instr_header_set_follow_alias snd_instr_header_t   info,
int    val
 

Set the flag to follow alias of an instr_header container.

Parameters:
info  instr_header container
val  1 if follow alias

void snd_instr_header_set_format snd_instr_header_t   info,
const char *    format
 

Set the data format of an instr_header container.

Parameters:
info  instr_header container
format  the data format string

void snd_instr_header_set_id snd_instr_header_t   info,
const snd_seq_instr_t   id
 

Set the instrument id of an instr_header container.

Parameters:
info  instr_header container
id  instrument id pointer

void snd_instr_header_set_len snd_instr_header_t   info,
size_t    len
 

Set the length of extra data of an instr_header container.

Parameters:
info  instr_header container
len  size of extra data in bytes

void snd_instr_header_set_name snd_instr_header_t   info,
const char *    name
 

Set the data name of an instr_header container.

Parameters:
info  instr_header container
name  the name string

void snd_instr_header_set_type snd_instr_header_t   info,
int    type
 

Set the data type of an instr_header container.

Parameters:
info  instr_header container
type  the data type

size_t snd_instr_header_sizeof void   
 

get size of snd_instr_header_t

Returns:
size in bytes

int snd_seq_alloc_named_queue snd_seq_t   seq,
const char *    name
 

allocate a queue with the specified name

Parameters:
seq  sequencer handle
name  the name of the new queue
Returns:
the queue id (zero or positive) on success otherwise a negative error code

int snd_seq_alloc_queue snd_seq_t   seq
 

allocate a queue

Parameters:
seq  sequencer handle
Returns:
the queue id (zero or positive) on success otherwise a negative error code

int snd_seq_client_id snd_seq_t   seq
 

Get the client id.

Parameters:
seq  sequencer handle
Returns:
the client id
Returns the id of the specified client. If an error occurs, function returns the negative error code. A client id is necessary to inquiry or to set the client information. A user client is assigned from 128 to 191.

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

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_client_info_free snd_seq_client_info_t   obj
 

frees a previously allocated snd_seq_client_info_t

Parameters:
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.

Parameters:
info  client_info container
Returns:
1 if broadcast is accepted

int snd_seq_client_info_get_client const snd_seq_client_info_t   info
 

Get client id of a client_info container.

Parameters:
info  client_info container
Returns:
client id

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.

Parameters:
info  client_info container
Returns:
1 if error-bounce is enabled

const unsigned char* snd_seq_client_info_get_event_filter const snd_seq_client_info_t   info
 

Get the event filter bitmap of a client_info container.

Parameters:
info  client_info container
Returns:
NULL if no event filter, or pointer to event filter bitmap

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.

Parameters:
info  client_info container
Returns:
number of lost events

const char* snd_seq_client_info_get_name snd_seq_client_info_t   info
 

Get the name of a client_info container.

Parameters:
info  client_info container
Returns:
name string

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.

Parameters:
info  client_info container
Returns:
number of opened ports

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.

Parameters:
info  client_info container
Returns:
client type
The client type is either SEQ_CLIENT_TYPE_KERNEL or SEQ_CLIENT_TYPE_USER for kernel or user client respectively.

int snd_seq_client_info_malloc snd_seq_client_info_t **    ptr
 

allocate an empty snd_seq_client_info_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

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.

Parameters:
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.

Parameters:
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.

Parameters:
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
 

Set the event filter bitmap of a client_info container.

Parameters:
info  client_info container
filter  event filter bitmap

void snd_seq_client_info_set_name snd_seq_client_info_t   info,
const char *    name
 

Set the name of a client_info container.

Parameters:
info  client_info container
name  name string

size_t snd_seq_client_info_sizeof void   
 

get size of snd_seq_client_info_t

Returns:
size in bytes

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

Parameters:
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

Parameters:
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.

Parameters:
info  client_pool container
Returns:
client id

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.

Parameters:
info  client_pool container
Returns:
available input size

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.

Parameters:
info  client_pool container
Returns:
input pool size

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.

Parameters:
info  client_pool container
Returns:
available output size

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.

Parameters:
info  client_pool container
Returns:
output pool size

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.

Parameters:
info  client_pool container
Returns:
output room size

int snd_seq_client_pool_malloc snd_seq_client_pool_t **    ptr
 

allocate an empty snd_seq_client_pool_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

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.

Parameters:
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.

Parameters:
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.

Parameters:
info  client_pool container
size  output room size

size_t snd_seq_client_pool_sizeof void   
 

get size of snd_seq_client_pool_t

Returns:
size in bytes

int snd_seq_close snd_seq_t   seq
 

Close the sequencer.

Parameters:
handle  Handle returned from snd_seq_open()
Returns:
0 on success otherwise a negative error code
Closes the sequencer client and releases its resources. After a client is closed, an event with SND_SEQ_EVENT_CLIENT_EXIT is broadcast to announce port. The connection between other clients are disconnected. Call this just before exiting your program.

int snd_seq_create_port snd_seq_t   seq,
snd_seq_port_info_t   port
 

create a sequencer port on the current client

Parameters:
seq  sequencer handle
port  port information for the new port
Returns:
0 on success otherwise a negative error code
Creates a sequencer port on the current client. The attributes of created port is specified in info argument.

The client field in info argument is overwritten with the current client id. The port id to be created can be specified via snd_seq_port_info_set_port_specified. You can get the created port id by reading the port pointer via snd_seq_port_info_get_port.

Each port has the capability bit-masks to specify the access capability of the port from other clients. The capability bit flags are defined as follows:

Each port has also the type bitmasks defined as follows: A port may contain specific midi channels, midi voices and synth voices. These values could be zero as default.

int snd_seq_create_queue snd_seq_t   seq,
snd_seq_queue_info_t   info
 

create a queue

Parameters:
seq  sequencer handle
info  queue information to initialize
Returns:
the queue id (zero or positive) on success otherwise a negative error code

int snd_seq_delete_port snd_seq_t   seq,
int    port
 

delete a sequencer port on the current client

Parameters:
seq  sequencer handle
port  port to be deleted
Returns:
0 on success otherwise a negative error code
Deletes the existing sequencer port on the current client.

int snd_seq_drain_output snd_seq_t   seq
 

drain output buffer to sequencer

Parameters:
seq  sequencer handle
Returns:
0 when all events are drained and sent to sequencer. When events still remain on the buffer, the byte size of remaining events are returned. On error a negative error code is returned.

int snd_seq_drop_input snd_seq_t   seq
 

clear input buffer and and remove events in sequencer queue

Parameters:
seq  sequencer handle

int snd_seq_drop_input_buffer snd_seq_t   seq
 

remove all events on user-space input FIFO

Parameters:
seq  sequencer handle

int snd_seq_drop_output snd_seq_t   seq
 

remove all events on output buffer

Parameters:
seq  sequencer handle
Removes all events on both user-space output buffer and output memory pool on kernel.

int snd_seq_drop_output_buffer snd_seq_t   seq
 

remove all events on user-space output buffer

Parameters:
seq  sequencer handle
Removes all events on user-space output buffer. Unlike snd_seq_drain_output(), this function doesn't remove events on output memory pool of sequencer.

int snd_seq_event_input snd_seq_t   seq,
snd_seq_event_t **    ev
 

retrieve an event from sequencer

Parameters:
seq  sequencer handle
ev  event pointer to be stored
Returns:
Obtains an input event from sequencer. The event is created via snd_seq_create_event(), and its pointer is stored on ev argument.
This function firstly receives the event byte-stream data from sequencer as much as possible at once. Then it retrieves the first event record and store the pointer on ev. By calling this function sequentially, events are extracted from the input buffer.

If there is no input from sequencer, function falls into sleep in blocking mode until an event is received, or returns -EAGAIN error in non-blocking mode. Occasionally, this function may return -ENOSPC error. This means that the input FIFO of sequencer overran, and some events are lost. Once this error is returned, the input FIFO is cleared automatically.

Function returns the byte size of remaining events on the input buffer if an event is successfully received. Application can determine from the returned value whether to call input once more or not.

int snd_seq_event_input_pending snd_seq_t   seq,
int    fetch_sequencer
 

check events in input buffer

Returns:
the byte size of remaining input events on input buffer.
If events remain on the input buffer of user-space, function returns the total byte size of events on it. If fetch_sequencer argument is non-zero, this function checks the presence of events on sequencer FIFO When events exist, they are transferred to the input buffer, and the number of received events are returned. If fetch_sequencer argument is zero and no events remain on the input buffer, function simply returns zero.

ssize_t snd_seq_event_length snd_seq_event_t   ev
 

calculates the (encoded) byte-stream size of the event

Parameters:
ev  the event
Returns:
the size of decoded bytes

int snd_seq_event_output snd_seq_t   seq,
snd_seq_event_t   ev
 

output an event

Parameters:
seq  sequencer handle
ev  event to be output
Returns:
the number of remaining events or a negative error code
An event is once expanded on the output buffer. The output buffer will be drained automatically if it becomes full.

If events remain unprocessed on output buffer before drained, the size of total byte data on output buffer is returned. If the output buffer is empty, this returns zero.

int snd_seq_event_output_buffer snd_seq_t   seq,
snd_seq_event_t   ev
 

output an event onto the lib buffer without draining buffer

Parameters:
seq  sequencer handle
ev  event to be output
Returns:
the byte size of remaining events. -EAGAIN if the buffer becomes full.
This function doesn't drain buffer unlike snd_seq_event_output().

int snd_seq_event_output_direct snd_seq_t   seq,
snd_seq_event_t   ev
 

output an event directly to the sequencer NOT through output buffer

Parameters:
seq  sequencer handle
ev  event to be output
Returns:
the byte size sent to sequencer or a negative error code
This function sends an event to the sequencer directly not through the output buffer. When the event is a variable length event, a temporary buffer is allocated inside alsa-lib and the data is copied there before actually sent.

int snd_seq_event_output_pending snd_seq_t   seq
 

return the size of pending events on output buffer

Parameters:
seq  sequencer handle
Returns:
the byte size of total of pending events

int snd_seq_extract_output snd_seq_t   seq,
snd_seq_event_t **    ev_res
 

extract the first event in output buffer

Parameters:
seq  sequencer handle
ev_res  event pointer to be extracted
Returns:
0 on success otherwise a negative error code
Extracts the first event in output buffer. If ev_res is NULL, just remove the event.

int snd_seq_free_event snd_seq_event_t   ev
 

(DEPRECATED) free an event

releases the event pointer which was allocated by snd_seq_event_input(). this function is obsolete and does nothing inside actually. used only for compatibility with the older version.

int snd_seq_free_queue snd_seq_t   seq,
int    q
 

delete the specified queue

Parameters:
seq  sequencer handle
q  queue id to delete
Returns:
0 on success otherwise a negative error code

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

Parameters:
seq  sequencer handle
client  client id
info  the pointer to be stored
Returns:
0 on success otherwise a negative error code
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_any_port_info snd_seq_t   seq,
int    client,
int    port,
snd_seq_port_info_t   info
 

obtain the information of a port on an arbitrary client

Parameters:
seq  sequencer handle
client  client id to get
port  port id to get
info  pointer information returns
Returns:
0 on success otherwise a negative error code

int snd_seq_get_client_info snd_seq_t   seq,
snd_seq_client_info_t   info
 

obtain the current client information

Parameters:
seq  sequencer handle
info  the pointer to be stored
Returns:
0 on success otherwise a negative error code
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

Parameters:
seq  sequencer handle
info  information to be stored

size_t snd_seq_get_input_buffer_size snd_seq_t   seq
 

Return the size of input buffer.

Parameters:
seq  sequencer handle
Returns:
the size of input buffer in bytes
Obtains the size of input buffer. This buffer is used to read byte-stream of input events from sequencer.

size_t snd_seq_get_output_buffer_size snd_seq_t   seq
 

Return the size of output buffer.

Parameters:
seq  sequencer handle
Returns:
the size of output buffer in bytes
Obtains the size of output buffer. This buffer is used to store decoded byte-stream of output events before transferring to sequencer.

int snd_seq_get_port_info snd_seq_t   seq,
int    port,
snd_seq_port_info_t   info
 

obtain the information of a port on the current client

Parameters:
seq  sequencer handle
port  port id to get
info  pointer information returns
Returns:
0 on success otherwise a negative error code

int snd_seq_get_port_subscription snd_seq_t   seq,
snd_seq_port_subscribe_t   sub
 

obtain subscription information

Parameters:
seq  sequencer handle
sub  pointer to return the subscription information
Returns:
0 on success otherwise a negative error code

int snd_seq_get_queue_info snd_seq_t   seq,
int    q,
snd_seq_queue_info_t   info
 

obtain queue attributes

Parameters:
seq  sequencer handle
q  queue id to query
info  information returned
Returns:
0 on success otherwise a negative error code

int snd_seq_get_queue_status snd_seq_t   seq,
int    q,
snd_seq_queue_status_t   status
 

obtain the running state of the queue

Parameters:
seq  sequencer handle
q  queue id to query
status  pointer to store the current status
Returns:
0 on success otherwise a negative error code
Obtains the running state of the specified queue q.

int snd_seq_get_queue_tempo snd_seq_t   seq,
int    q,
snd_seq_queue_tempo_t   tempo
 

obtain the current tempo of the queue

Parameters:
seq  sequencer handle
q  queue id to be queried
tempo  pointer to store the current tempo
Returns:
0 on success otherwise a negative error code

int snd_seq_get_queue_timer snd_seq_t   seq,
int    q,
snd_seq_queue_timer_t   timer
 

obtain the queue timer information

Parameters:
seq  sequencer handle
q  queue id to query
timer  pointer to store the timer information
Returns:
0 on success otherwise a negative error code

int snd_seq_get_queue_usage snd_seq_t   seq,
int    q
 

Get the queue usage flag to the client.

Parameters:
seq  sequencer handle
q  queue id
client  client id
Returns:
1 = client is allowed to access the queue, 0 = not allowed, otherwise a negative error code

const char* snd_seq_name snd_seq_t   seq
 

get identifier of sequencer handle

Parameters:
seq  sequencer handle
Returns:
ascii identifier of sequencer handle
Returns the ASCII identifier of the given sequencer handle. It's the same identifier specified in snd_seq_open().

int snd_seq_nonblock snd_seq_t   seq,
int    nonblock
 

Set nonblock mode.

Parameters:
seq  sequencer handle
nonblock  0 = block, 1 = nonblock mode
Returns:
0 on success otherwise a negative error code
Change the blocking mode of the given client. In block mode, the client falls into sleep when it fills the output memory pool with full events. The client will be woken up after a certain amount of free space becomes available.

int snd_seq_open snd_seq_t **    seqp,
const char *    name,
int    streams,
int    mode
 

Open the ALSA sequencer.

Parameters:
seqp  Pointer to a snd_seq_t pointer. This pointer must be kept and passed to most of the other sequencer functions.
name  The sequencer's "name". This is not a name you make up for your own purposes; it has special significance to the ALSA library. Usually you need to pass "default" here.
streams  The read/write mode of the sequencer. Can be one of three values:
Note:
Internally, these are translated to O_WRONLY, O_RDONLY and \O_RDWR respectively and used as the second argument to the C library open() call.
Parameters:
mode  Optional modifier. Can be either 0, or SND_SEQ_NONBLOCK, which will make read/write operations non-blocking. This can also be set later using snd_seq_nonblock().
Returns:
0 on success otherwise a negative error code
Creates a new handle and opens a connection to the kernel sequencer interface. After a client is created successfully, an event with SND_SEQ_EVENT_CLIENT_START is broadcast to announce port.

int snd_seq_open_lconf snd_seq_t **    seqp,
const char *    name,
int    streams,
int    mode,
snd_config_t   lconf
 

Open the ALSA sequencer using local configuration.

Parameters:
seqp  Pointer to a snd_seq_t pointer.
streams  The read/write mode of the sequencer.
mode  Optional modifier
lconf  Local configuration
Returns:
0 on success otherwise a negative error code
See the snd_seq_open() function for further details. The extension is that the given configuration is used to resolve abstract name.

int snd_seq_poll_descriptors snd_seq_t   seq,
struct pollfd *    pfds,
unsigned int    space,
short    events
 

Get poll descriptors.

Parameters:
seq  sequencer handle
pfds  array of poll descriptors
space  space in the poll descriptor array
events  polling events to be checked (POLLIN and POLLOUT)
Returns:
count of filled descriptors
Get poll descriptors assigned to the sequencer handle.

int snd_seq_poll_descriptors_count snd_seq_t   seq,
short    events
 

Returns the number of poll descriptors.

Parameters:
seq  sequencer handle
events  the poll events to be checked (POLLIN and POLLOUT)
Returns:
the number of poll descriptors.
Get the number of poll descriptors. The polling events to be checked can be specified by the second argument. When both input and output are checked, pass POLLIN|POLLOUT

int snd_seq_poll_descriptors_revents snd_seq_t   seq,
struct pollfd *    pfds,
unsigned int    nfds,
unsigned short *    revents
 

get returned events from poll descriptors

Parameters:
seq  sequencer handle
pfds  array of poll descriptors
nfds  count of poll descriptors
revents  returned events
Returns:
zero if success, otherwise a negative error code

void snd_seq_port_info_copy snd_seq_port_info_t   dst,
const snd_seq_port_info_t   src
 

copy one snd_seq_port_info_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_port_info_free snd_seq_port_info_t   obj
 

frees a previously allocated snd_seq_port_info_t

Parameters:
pointer  to object to free

const snd_seq_addr_t* snd_seq_port_info_get_addr const snd_seq_port_info_t   info
 

Get client/port address of a port_info container.

Parameters:
info  port_info container
Returns:
client/port address pointer

unsigned int snd_seq_port_info_get_capability const snd_seq_port_info_t   info
 

Get the capability bits of a port_info container.

Parameters:
info  port_info container
Returns:
capability bits

int snd_seq_port_info_get_client const snd_seq_port_info_t   info
 

Get client id of a port_info container.

Parameters:
info  port_info container
Returns:
client id

int snd_seq_port_info_get_midi_channels const snd_seq_port_info_t   info
 

Get the midi channels of a port_info container.

Parameters:
info  port_info container
Returns:
number of midi channels (default 0)

int snd_seq_port_info_get_midi_voices const snd_seq_port_info_t   info
 

Get the midi voices of a port_info container.

Parameters:
info  port_info container
Returns:
number of midi voices (default 0)

const char* snd_seq_port_info_get_name const snd_seq_port_info_t   info
 

Get the name of a port_info container.

Parameters:
info  port_info container
Returns:
name string

int snd_seq_port_info_get_port const snd_seq_port_info_t   info
 

Get port id of a port_info container.

Parameters:
info  port_info container
Returns:
port id

int snd_seq_port_info_get_port_specified const snd_seq_port_info_t   info
 

Get the port-specified mode of a port_info container.

Parameters:
info  port_info container
Returns:
1 if port id is specified at creation

int snd_seq_port_info_get_read_use const snd_seq_port_info_t   info
 

Get the number of read subscriptions of a port_info container.

Parameters:
info  port_info container
Returns:
number of read subscriptions

int snd_seq_port_info_get_synth_voices const snd_seq_port_info_t   info
 

Get the synth voices of a port_info container.

Parameters:
info  port_info container
Returns:
number of synth voices (default 0)

unsigned int snd_seq_port_info_get_type const snd_seq_port_info_t   info
 

Get the type bits of a port_info container.

Parameters:
info  port_info container
Returns:
port type bits

int snd_seq_port_info_get_write_use const snd_seq_port_info_t   info
 

Get the number of write subscriptions of a port_info container.

Parameters:
info  port_info container
Returns:
number of write subscriptions

int snd_seq_port_info_malloc snd_seq_port_info_t **    ptr
 

allocate an empty snd_seq_port_info_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_port_info_set_addr snd_seq_port_info_t   info,
const snd_seq_addr_t   addr
 

Set the client/port address of a port_info container.

Parameters:
info  port_info container
addr  client/port address

void snd_seq_port_info_set_capability snd_seq_port_info_t   info,
unsigned int    capability
 

set the capability bits of a port_info container

Parameters:
info  port_info container
capability  capability bits

void snd_seq_port_info_set_client snd_seq_port_info_t   info,
int    client
 

Set the client id of a port_info container.

Parameters:
info  port_info container
client  client id

void snd_seq_port_info_set_midi_channels snd_seq_port_info_t   info,
int    channels
 

set the midi channels of a port_info container

Parameters:
info  port_info container
channels  midi channels (default 0)

void snd_seq_port_info_set_midi_voices snd_seq_port_info_t   info,
int    voices
 

set the midi voices of a port_info container

Parameters:
info  port_info container
voices  midi voices (default 0)

void snd_seq_port_info_set_name snd_seq_port_info_t   info,
const char *    name
 

Set the name of a port_info container.

Parameters:
info  port_info container
name  name string

void snd_seq_port_info_set_port snd_seq_port_info_t   info,
int    port
 

Set the port id of a port_info container.

Parameters:
info  port_info container
port  port id

void snd_seq_port_info_set_port_specified snd_seq_port_info_t   info,
int    val
 

Set the port-specified mode of a port_info container.

Parameters:
info  port_info container
val  non-zero if specifying the port id at creation

void snd_seq_port_info_set_synth_voices snd_seq_port_info_t   info,
int    voices
 

set the synth voices of a port_info container

Parameters:
info  port_info container
voices  synth voices (default 0)

void snd_seq_port_info_set_type snd_seq_port_info_t   info,
unsigned int    type
 

Get the type bits of a port_info container.

Parameters:
info  port_info container
Returns:
port type bits

size_t snd_seq_port_info_sizeof void   
 

get size of snd_seq_port_info_t

Returns:
size in bytes

void snd_seq_port_subscribe_copy snd_seq_port_subscribe_t   dst,
const snd_seq_port_subscribe_t   src
 

copy one snd_seq_port_subscribe_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_port_subscribe_free snd_seq_port_subscribe_t   obj
 

frees a previously allocated snd_seq_port_subscribe_t

Parameters:
pointer  to object to free

const snd_seq_addr_t* snd_seq_port_subscribe_get_dest const snd_seq_port_subscribe_t   info
 

Get destination address of a port_subscribe container.

Parameters:
info  port_subscribe container
addr  destination address

int snd_seq_port_subscribe_get_exclusive const snd_seq_port_subscribe_t   info
 

Get the exclusive mode of a port_subscribe container.

Parameters:
info  port_subscribe container
Returns:
1 if exclusive mode

int snd_seq_port_subscribe_get_queue const snd_seq_port_subscribe_t   info
 

Get the queue id of a port_subscribe container.

Parameters:
info  port_subscribe container
Returns:
queue id

const snd_seq_addr_t* snd_seq_port_subscribe_get_sender const snd_seq_port_subscribe_t   info
 

Get sender address of a port_subscribe container.

Parameters:
info  port_subscribe container
addr  sender address

int snd_seq_port_subscribe_get_time_real const snd_seq_port_subscribe_t   info
 

Get the real-time update mode of a port_subscribe container.

Parameters:
info  port_subscribe container
Returns:
1 if real-time update mode

int snd_seq_port_subscribe_get_time_update const snd_seq_port_subscribe_t   info
 

Get the time-update mode of a port_subscribe container.

Parameters:
info  port_subscribe container
Returns:
1 if update timestamp

int snd_seq_port_subscribe_malloc snd_seq_port_subscribe_t **    ptr
 

allocate an empty snd_seq_port_subscribe_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_port_subscribe_set_dest snd_seq_port_subscribe_t   info,
const snd_seq_addr_t   addr
 

Set destination address of a port_subscribe container.

Parameters:
info  port_subscribe container
addr  destination address

void snd_seq_port_subscribe_set_exclusive snd_seq_port_subscribe_t   info,
int    val
 

Set the exclusive mode of a port_subscribe container.

Parameters:
info  port_subscribe container
val  non-zero to enable

void snd_seq_port_subscribe_set_queue snd_seq_port_subscribe_t   info,
int    q
 

Set the queue id of a port_subscribe container.

Parameters:
info  port_subscribe container
q  queue id

void snd_seq_port_subscribe_set_sender snd_seq_port_subscribe_t   info,
const snd_seq_addr_t   addr
 

Set sender address of a port_subscribe container.

Parameters:
info  port_subscribe container
addr  sender address

void snd_seq_port_subscribe_set_time_real snd_seq_port_subscribe_t   info,
int    val
 

Set the real-time mode of a port_subscribe container.

Parameters:
info  port_subscribe container
val  non-zero to enable

void snd_seq_port_subscribe_set_time_update snd_seq_port_subscribe_t   info,
int    val
 

Set the time-update mode of a port_subscribe container.

Parameters:
info  port_subscribe container
val  non-zero to enable

void snd_seq_port_subscribe_set_voices snd_seq_port_subscribe_t   info,
unsigned int    voices
 

Set the voices of a port_subscribe container.

Parameters:
info  port_subscribe container
voices  voices to be allocated (0 = don't care)

size_t snd_seq_port_subscribe_sizeof void   
 

get size of snd_seq_port_subscribe_t

Returns:
size in bytes

int snd_seq_query_named_queue snd_seq_t   seq,
const char *    name
 

query the matching queue with the specified name

Parameters:
seq  sequencer handle
name  the name string to query
Returns:
the queue id if found or negative error code
Searches the matching queue with the specified name string.

int snd_seq_query_next_client snd_seq_t   seq,
snd_seq_client_info_t   info
 

query the next matching client

Parameters:
seq  sequencer handle
info  query pattern and result
Queries the next matching client with the given condition in info argument. The search begins at the client with an id one greater than client field in info. If name field in info is not empty, the client name is compared. If a matching client is found, its attributes are stored o info and returns zero. Otherwise returns a negative error code.

int snd_seq_query_next_port snd_seq_t   seq,
snd_seq_port_info_t   info
 

query the next matching port

Parameters:
seq  sequencer handle
info  query pattern and result
Queries the next matching port on the client specified in info argument. The search begins at the next port specified in port field of info argument. For finding the first port at a certain client, give -1.

If a matching port is found, its attributes are stored on info and function returns zero. Otherwise, a negative error code is returned.

int snd_seq_query_port_subscribers snd_seq_t   seq,
snd_seq_query_subscribe_t   subs
 

query port subscriber list

Parameters:
seq  sequencer handle
subs  subscription to query
Returns:
0 on success otherwise a negative error code
Queries the subscribers accessing to a port. The query information is specified in subs argument.

void snd_seq_query_subscribe_copy snd_seq_query_subscribe_t   dst,
const snd_seq_query_subscribe_t   src
 

copy one snd_seq_query_subscribe_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_query_subscribe_free snd_seq_query_subscribe_t   obj
 

frees a previously allocated snd_seq_query_subscribe_t

Parameters:
pointer  to object to free

const snd_seq_addr_t* snd_seq_query_subscribe_get_addr const snd_seq_query_subscribe_t   info
 

Get the address of subscriber of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
subscriber's address pointer

int snd_seq_query_subscribe_get_client const snd_seq_query_subscribe_t   info
 

Get the client id of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
client id

int snd_seq_query_subscribe_get_exclusive const snd_seq_query_subscribe_t   info
 

Get the exclusive mode of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
1 if exclusive mode

int snd_seq_query_subscribe_get_index const snd_seq_query_subscribe_t   info
 

Get the index of subscriber of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
subscriber's index

int snd_seq_query_subscribe_get_num_subs const snd_seq_query_subscribe_t   info
 

Get the number of subscriptions of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
number of subscriptions

int snd_seq_query_subscribe_get_port const snd_seq_query_subscribe_t   info
 

Get the port id of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
port id

int snd_seq_query_subscribe_get_queue const snd_seq_query_subscribe_t   info
 

Get the queue id of subscriber of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
subscriber's queue id

const snd_seq_addr_t* snd_seq_query_subscribe_get_root const snd_seq_query_subscribe_t   info
 

Get the client/port address of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
client/port address pointer

int snd_seq_query_subscribe_get_time_real const snd_seq_query_subscribe_t   info
 

Get the real-time update mode of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
1 if real-time update mode

int snd_seq_query_subscribe_get_time_update const snd_seq_query_subscribe_t   info
 

Get the time-update mode of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
1 if update timestamp

snd_seq_query_subs_type_t snd_seq_query_subscribe_get_type const snd_seq_query_subscribe_t   info
 

Get the query type of a query_subscribe container.

Parameters:
info  query_subscribe container
Returns:
query type

int snd_seq_query_subscribe_malloc snd_seq_query_subscribe_t **    ptr
 

allocate an empty snd_seq_query_subscribe_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_query_subscribe_set_client snd_seq_query_subscribe_t   info,
int    client
 

Set the client id of a query_subscribe container.

Parameters:
info  query_subscribe container
client  client id

void snd_seq_query_subscribe_set_index snd_seq_query_subscribe_t   info,
int    index
 

Set the subscriber's index to be queried.

Parameters:
info  query_subscribe container
index  index to be queried

void snd_seq_query_subscribe_set_port snd_seq_query_subscribe_t   info,
int    port
 

Set the port id of a query_subscribe container.

Parameters:
info  query_subscribe container
port  port id

void snd_seq_query_subscribe_set_root snd_seq_query_subscribe_t   info,
const snd_seq_addr_t   addr
 

Set the client/port address of a query_subscribe container.

Parameters:
info  query_subscribe container
addr  client/port address pointer

void snd_seq_query_subscribe_set_type snd_seq_query_subscribe_t   info,
snd_seq_query_subs_type_t    type
 

Set the query type of a query_subscribe container.

Parameters:
info  query_subscribe container
type  query type

size_t snd_seq_query_subscribe_sizeof void   
 

get size of snd_seq_query_subscribe_t

Returns:
size in bytes

void snd_seq_queue_info_copy snd_seq_queue_info_t   dst,
const snd_seq_queue_info_t   src
 

copy one snd_seq_queue_info_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_queue_info_free snd_seq_queue_info_t   obj
 

frees a previously allocated snd_seq_queue_info_t

Parameters:
pointer  to object to free

unsigned int snd_seq_queue_info_get_flags const snd_seq_queue_info_t   info
 

Get the conditional bit flags of a queue_info container.

Parameters:
info  queue_info container
Returns:
conditional bit flags

int snd_seq_queue_info_get_locked const snd_seq_queue_info_t   info
 

Get the lock status of a queue_info container.

Parameters:
info  queue_info container
Returns:
lock status --- non-zero = locked

const char* snd_seq_queue_info_get_name const snd_seq_queue_info_t   info
 

Get the name of a queue_info container.

Parameters:
info  queue_info container
Returns:
name string

int snd_seq_queue_info_get_owner const snd_seq_queue_info_t   info
 

Get the owner client id of a queue_info container.

Parameters:
info  queue_info container
Returns:
owner client id

int snd_seq_queue_info_get_queue const snd_seq_queue_info_t   info
 

Get the queue id of a queue_info container.

Parameters:
info  queue_info container
Returns:
queue id

int snd_seq_queue_info_malloc snd_seq_queue_info_t **    ptr
 

allocate an empty snd_seq_queue_info_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_queue_info_set_flags snd_seq_queue_info_t   info,
unsigned int    flags
 

Set the conditional bit flags of a queue_info container.

Parameters:
info  queue_info container
flags  conditional bit flags

void snd_seq_queue_info_set_locked snd_seq_queue_info_t   info,
int    locked
 

Set the lock status of a queue_info container.

Parameters:
info  queue_info container
locked  lock status

void snd_seq_queue_info_set_name snd_seq_queue_info_t   info,
const char *    name
 

Set the name of a queue_info container.

Parameters:
info  queue_info container
name  name string

void snd_seq_queue_info_set_owner snd_seq_queue_info_t   info,
int    owner
 

Set the owner client id of a queue_info container.

Parameters:
info  queue_info container
owner  client id

size_t snd_seq_queue_info_sizeof void   
 

get size of snd_seq_queue_info_t

Returns:
size in bytes

void snd_seq_queue_status_copy snd_seq_queue_status_t   dst,
const snd_seq_queue_status_t   src
 

copy one snd_seq_queue_status_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_queue_status_free snd_seq_queue_status_t   obj
 

frees a previously allocated snd_seq_queue_status_t

Parameters:
pointer  to object to free

int snd_seq_queue_status_get_events const snd_seq_queue_status_t   info
 

Get the number of events of a queue_status container.

Parameters:
info  queue_status container
Returns:
number of events

int snd_seq_queue_status_get_queue const snd_seq_queue_status_t   info
 

Get the queue id of a queue_status container.

Parameters:
info  queue_status container
Returns:
queue id

const snd_seq_real_time_t* snd_seq_queue_status_get_real_time const snd_seq_queue_status_t   info
 

Get the real time of a queue_status container.

Parameters:
info  queue_status container
time  real time

unsigned int snd_seq_queue_status_get_status const snd_seq_queue_status_t   info
 

Get the running status bits of a queue_status container.

Parameters:
info  queue_status container
Returns:
running status bits

snd_seq_tick_time_t snd_seq_queue_status_get_tick_time const snd_seq_queue_status_t   info
 

Get the tick time of a queue_status container.

Parameters:
info  queue_status container
Returns:
tick time

int snd_seq_queue_status_malloc snd_seq_queue_status_t **    ptr
 

allocate an empty snd_seq_queue_status_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

size_t snd_seq_queue_status_sizeof void   
 

get size of snd_seq_queue_status_t

Returns:
size in bytes

void snd_seq_queue_tempo_copy snd_seq_queue_tempo_t   dst,
const snd_seq_queue_tempo_t   src
 

copy one snd_seq_queue_tempo_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_queue_tempo_free snd_seq_queue_tempo_t   obj
 

frees a previously allocated snd_seq_queue_tempo_t

Parameters:
pointer  to object to free

int snd_seq_queue_tempo_get_ppq const snd_seq_queue_tempo_t   info
 

Get the ppq of a queue_status container.

Parameters:
info  queue_status container
Returns:
ppq value

int snd_seq_queue_tempo_get_queue const snd_seq_queue_tempo_t   info
 

Get the queue id of a queue_status container.

Parameters:
info  queue_status container
Returns:
queue id

unsigned int snd_seq_queue_tempo_get_skew const snd_seq_queue_tempo_t   info
 

Get the timer skew value of a queue_status container.

Parameters:
info  queue_status container
Returns:
timer skew value

unsigned int snd_seq_queue_tempo_get_skew_base const snd_seq_queue_tempo_t   info
 

Get the timer skew base value of a queue_status container.

Parameters:
info  queue_status container
Returns:
timer skew base value

unsigned int snd_seq_queue_tempo_get_tempo const snd_seq_queue_tempo_t   info
 

Get the tempo of a queue_status container.

Parameters:
info  queue_status container
Returns:
tempo value

int snd_seq_queue_tempo_malloc snd_seq_queue_tempo_t **    ptr
 

allocate an empty snd_seq_queue_tempo_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_queue_tempo_set_ppq snd_seq_queue_tempo_t   info,
int    ppq
 

Set the ppq of a queue_status container.

Parameters:
info  queue_status container
ppq  ppq value

void snd_seq_queue_tempo_set_skew snd_seq_queue_tempo_t   info,
unsigned int    skew
 

Set the timer skew value of a queue_status container.

Parameters:
info  queue_status container
skew  timer skew value
The skew of timer is calculated as skew / base. For example, to play with double speed, pass base * 2 as the skew value.

void snd_seq_queue_tempo_set_skew_base snd_seq_queue_tempo_t   info,
unsigned int    base
 

Set the timer skew base value of a queue_status container.

Parameters:
info  queue_status container
base  timer skew base value

void snd_seq_queue_tempo_set_tempo snd_seq_queue_tempo_t   info,
unsigned int    tempo
 

Set the tempo of a queue_status container.

Parameters:
info  queue_status container
tempo  tempo value

size_t snd_seq_queue_tempo_sizeof void   
 

get size of snd_seq_queue_tempo_t

Returns:
size in bytes

void snd_seq_queue_timer_copy snd_seq_queue_timer_t   dst,
const snd_seq_queue_timer_t   src
 

copy one snd_seq_queue_timer_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_queue_timer_free snd_seq_queue_timer_t   obj
 

frees a previously allocated snd_seq_queue_timer_t

Parameters:
pointer  to object to free

const snd_timer_id_t* snd_seq_queue_timer_get_id const snd_seq_queue_timer_t   info
 

Get the timer id of a queue_timer container.

Parameters:
info  queue_timer container
Returns:
timer id pointer

int snd_seq_queue_timer_get_queue const snd_seq_queue_timer_t   info
 

Get the queue id of a queue_timer container.

Parameters:
info  queue_timer container
Returns:
queue id

unsigned int snd_seq_queue_timer_get_resolution const snd_seq_queue_timer_t   info
 

Get the timer resolution of a queue_timer container.

Parameters:
info  queue_timer container
Returns:
timer resolution

snd_seq_queue_timer_type_t snd_seq_queue_timer_get_type const snd_seq_queue_timer_t   info
 

Get the timer type of a queue_timer container.

Parameters:
info  queue_timer container
Returns:
timer type

int snd_seq_queue_timer_malloc snd_seq_queue_timer_t **    ptr
 

allocate an empty snd_seq_queue_timer_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_queue_timer_set_id snd_seq_queue_timer_t   info,
const snd_timer_id_t   id
 

Set the timer id of a queue_timer container.

Parameters:
info  queue_timer container
id  timer id pointer

void snd_seq_queue_timer_set_resolution snd_seq_queue_timer_t   info,
unsigned int    resolution
 

Set the timer resolution of a queue_timer container.

Parameters:
info  queue_timer container
resolution  timer resolution

void snd_seq_queue_timer_set_type snd_seq_queue_timer_t   info,
snd_seq_queue_timer_type_t    type
 

Set the timer type of a queue_timer container.

Parameters:
info  queue_timer container
type  timer type

size_t snd_seq_queue_timer_sizeof void   
 

get size of snd_seq_queue_timer_t

Returns:
size in bytes

int snd_seq_remove_events snd_seq_t   seq,
snd_seq_remove_events_t   rmp
 

remove events on input/output buffers

Parameters:
seq  sequencer handle
rmp  remove event container
Removes matching events with the given condition from input/output buffers. The removal condition is specified in rmp argument.

void snd_seq_remove_events_copy snd_seq_remove_events_t   dst,
const snd_seq_remove_events_t   src
 

copy one snd_seq_remove_events_t to another

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_remove_events_free snd_seq_remove_events_t   obj
 

frees a previously allocated snd_seq_remove_events_t

Parameters:
pointer  to object to free

int snd_seq_remove_events_get_channel const snd_seq_remove_events_t   info
 

Get the event channel as removal condition.

Parameters:
info  remove_events container
Returns:
channel number

unsigned int snd_seq_remove_events_get_condition const snd_seq_remove_events_t   info
 

Get the removal condition bits.

Parameters:
info  remove_events container
Returns:
removal condition bits

const snd_seq_addr_t* snd_seq_remove_events_get_dest const snd_seq_remove_events_t   info
 

Get the event destination address as removal condition.

Parameters:
info  remove_events container
Returns:
destination address

int snd_seq_remove_events_get_event_type const snd_seq_remove_events_t   info
 

Get the event type as removal condition.

Parameters:
info  remove_events container
Returns:
event type

int snd_seq_remove_events_get_queue const snd_seq_remove_events_t   info
 

Get the queue as removal condition.

Parameters:
info  remove_events container
Returns:
queue id

int snd_seq_remove_events_get_tag const snd_seq_remove_events_t   info
 

Get the event tag id as removal condition.

Parameters:
info  remove_events container
Returns:
tag id

const snd_seq_timestamp_t* snd_seq_remove_events_get_time const snd_seq_remove_events_t   info
 

Get the event timestamp as removal condition.

Parameters:
info  remove_events container
Returns:
time stamp

int snd_seq_remove_events_malloc snd_seq_remove_events_t **    ptr
 

allocate an empty snd_seq_remove_events_t using standard malloc

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

void snd_seq_remove_events_set_channel snd_seq_remove_events_t   info,
int    channel
 

Set the channel as removal condition.

Parameters:
info  remove_events container
channel  channel number

void snd_seq_remove_events_set_condition snd_seq_remove_events_t   info,
unsigned int    flags
 

Set the removal condition bits.

Parameters:
info  remove_events container
flags  removal condition bits

void snd_seq_remove_events_set_dest snd_seq_remove_events_t   info,
const snd_seq_addr_t   addr
 

Set the destination address as removal condition.

Parameters:
info  remove_events container
addr  destination address

void snd_seq_remove_events_set_event_type snd_seq_remove_events_t   info,
int    type
 

Set the event type as removal condition.

Parameters:
info  remove_events container
type  event type

void snd_seq_remove_events_set_queue snd_seq_remove_events_t   info,
int    queue
 

Set the queue as removal condition.

Parameters:
info  remove_events container
queue  queue id

void snd_seq_remove_events_set_tag snd_seq_remove_events_t   info,
int    tag
 

Set the event tag as removal condition.

Parameters:
info  remove_events container
tag  tag id

void snd_seq_remove_events_set_time snd_seq_remove_events_t   info,
const snd_seq_timestamp_t   time
 

Set the timestamp as removal condition.

Parameters:
info  remove_events container
time  timestamp pointer

size_t snd_seq_remove_events_sizeof void   
 

get size of snd_seq_remove_events_t

Returns:
size in bytes

int snd_seq_set_client_info snd_seq_t   seq,
snd_seq_client_info_t   info
 

set the current client information

Parameters:
seq  sequencer handle
info  the client info data to set
Returns:
0 on success otherwise a negative error code
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

Parameters:
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_input_buffer_size snd_seq_t   seq,
size_t    size
 

Resize the input buffer.

Parameters:
seq  sequencer handle
size  the size of input buffer to be changed in bytes
Returns:
0 on success otherwise a negative error code
Changes the size of input buffer.

int snd_seq_set_output_buffer_size snd_seq_t   seq,
size_t    size
 

Change the size of output buffer.

Parameters:
seq  sequencer handle
size  the size of output buffer to be changed in bytes
Returns:
0 on success otherwise a negative error code
Changes the size of output buffer.

int snd_seq_set_port_info snd_seq_t   seq,
int    port,
snd_seq_port_info_t   info
 

set the information of a port on the current client

Parameters:
seq  sequencer handle
port  port to be set
info  port information to be set
Returns:
0 on success otherwise a negative error code

int snd_seq_set_queue_info snd_seq_t   seq,
int    q,
snd_seq_queue_info_t   info
 

change the queue attributes

Parameters:
seq  sequencer handle
q  queue id to change
info  information changed
Returns:
0 on success otherwise a negative error code

int snd_seq_set_queue_tempo snd_seq_t   seq,
int    q,
snd_seq_queue_tempo_t   tempo
 

set the tempo of the queue

Parameters:
seq  sequencer handle
q  queue id to change the tempo
tempo  tempo information
Returns:
0 on success otherwise a negative error code

int snd_seq_set_queue_timer snd_seq_t   seq,
int    q,
snd_seq_queue_timer_t   timer
 

set the queue timer information

Parameters:
seq  sequencer handle
q  queue id to change the timer
timer  timer information
Returns:
0 on success otherwise a negative error code

int snd_seq_set_queue_usage snd_seq_t   seq,
int    q,
int    used
 

Set the queue usage flag to the client.

Parameters:
seq  sequencer handle
q  queue id
client  client id
used  non-zero if the client is allowed
Returns:
0 on success otherwise a negative error code

int snd_seq_subscribe_port snd_seq_t   seq,
snd_seq_port_subscribe_t   sub
 

subscribe a port connection

Parameters:
seq  sequencer handle
sub  subscription information
Returns:
0 on success otherwise a negative error code
Subscribes a connection between two ports. The subscription information is stored in sub argument.

int snd_seq_system_info snd_seq_t   seq,
snd_seq_system_info_t   info
 

obtain the sequencer system information

Parameters:
seq  sequencer handle
info  the pointer to be stored
Returns:
0 on success otherwise a negative error code
Stores the global system information of ALSA sequencer system. The returned data contains the maximum available numbers of queues, clients, ports and channels.

void snd_seq_system_info_copy snd_seq_system_info_t   dst,
const snd_seq_system_info_t   src
 

Copy one snd_seq_system_info_t to another.

Parameters:
dst  pointer to destination
src  pointer to source

void snd_seq_system_info_free snd_seq_system_info_t   obj
 

Frees a previously allocated snd_seq_system_info_t.

Parameters:
pointer  to object to free

int snd_seq_system_info_get_channels const snd_seq_system_info_t   info
 

Get maximum number of channels.

Parameters:
info  snd_seq_system_info_t container
Returns:
maximum number of channels

int snd_seq_system_info_get_clients const snd_seq_system_info_t   info
 

Get maximum number of clients.

Parameters:
info  snd_seq_system_info_t container
Returns:
maximum number of clients

int snd_seq_system_info_get_cur_clients const snd_seq_system_info_t   info
 

Get the current number of clients.

Parameters:
info  snd_seq_system_info_t container
Returns:
current number of clients

int snd_seq_system_info_get_cur_queues const snd_seq_system_info_t   info
 

Get the current number of queues.

Parameters:
info  snd_seq_system_info_t container
Returns:
current number of queues

int snd_seq_system_info_get_ports const snd_seq_system_info_t   info
 

Get maximum number of ports.

Parameters:
info  snd_seq_system_info_t container
Returns:
maximum number of ports

int snd_seq_system_info_get_queues const snd_seq_system_info_t   info
 

Get maximum number of queues.

Parameters:
info  snd_seq_system_info_t container
Returns:
maximum number of queues

int snd_seq_system_info_malloc snd_seq_system_info_t **    ptr
 

Allocate an empty snd_seq_system_info_t using standard malloc.

Parameters:
ptr  returned pointer
Returns:
0 on success otherwise negative error code

size_t snd_seq_system_info_sizeof void   
 

Get size of snd_seq_system_info_t.

Returns:
size in bytes

snd_seq_type_t snd_seq_type snd_seq_t   seq
 

get type of sequencer handle

Parameters:
seq  sequencer handle
Returns:
type of sequencer handle
Returns the type snd_seq_type_t of the given sequencer handle.

int snd_seq_unsubscribe_port snd_seq_t   seq,
snd_seq_port_subscribe_t   sub
 

unsubscribe a connection between ports

Parameters:
seq  sequencer handle
sub  subscription information to disconnect
Returns:
0 on success otherwise a negative error code
Unsubscribes a connection between two ports, described in sender and dest fields in sub argument.


Generated on Thu Jun 12 17:17:10 2003 for ALSA project - the C library reference by doxygen1.2.18