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

Sequencer Client Interface
[MIDI Sequencer]


Defines

#define snd_seq_client_info_alloca(ptr)   SND_ALLOCA(snd_seq_client_info, ptr)
#define snd_seq_client_pool_alloca(ptr)   SND_ALLOCA(snd_seq_client_pool, ptr)

Typedefs

typedef _snd_seq_client_info snd_seq_client_info_t
typedef enum snd_seq_client_type snd_seq_client_type_t
typedef _snd_seq_client_pool snd_seq_client_pool_t

Enumerations

enum  snd_seq_client_type { SND_SEQ_USER_CLIENT = 1, SND_SEQ_KERNEL_CLIENT = 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.

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_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 matching 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


Detailed Description

Sequencer Client Interface

Define Documentation

#define snd_seq_client_info_alloca ptr   )     SND_ALLOCA(snd_seq_client_info, ptr)
 

allocate a snd_seq_client_info_t container on stack

#define snd_seq_client_pool_alloca ptr   )     SND_ALLOCA(snd_seq_client_pool, ptr)
 

allocate a snd_seq_client_pool_t container on stack


Typedef Documentation

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

typedef enum snd_seq_client_type snd_seq_client_type_t
 

client types


Enumeration Type Documentation

enum snd_seq_client_type
 

client types

Enumeration values:
SND_SEQ_USER_CLIENT  user client
SND_SEQ_KERNEL_CLIENT  kernel client


Function Documentation

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_set_broadcast_filter()

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_set_client(), snd_seq_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
See also:
snd_seq_get_client_info(), snd_seq_client_info_set_error_bounce()

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_set_event_filter()

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
See also:
snd_seq_get_client_info()

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_set_name()

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
See also:
snd_seq_get_client_info()

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.

See also:
snd_seq_get_client_info()

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_get_broadcast_filter()

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_get_client()

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_get_error_bounce()

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_get_event_filger(), snd_seq_set_client_event_filter()

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
See also:
snd_seq_get_client_info(), snd_seq_client_info_get_name(), snd_seq_set_client_name()

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_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.

See also:
snd_seq_get_client_info()

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.

See also:
snd_seq_get_any_client_info(), snd_seq_set_client_info(), snd_seq_query_next_client()

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

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.

See also:
snd_seq_get_any_client_info()

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.

See also:
snd_seq_get_client_info()

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.


Generated on Mon May 3 16:15:23 2004 for ALSA project - the C library reference by doxygen 1.3.6