Expand description
§alsaseq crate
Rust API bindings and wrappers for alsaseq library to operate ALSA Sequencer character device.
The alsaseq library version 0.3.0 is the minimum supported version for underlying library.
The alsaseq crate is automatically generated by gir tool provided by gtk-rs project. ALSASeq-0.0 file from alsaseq library is used for the generation. But some functions are implemented manually.
§Usage
Add the following line to your Cargo.toml file:
[dependencies]
alsaseq = "0.7"
The API documentation is available in https://docs.rs/alsaseq/.
§License
The alsaseq crate is released under MIT license.
§Dependency
The alsaseq crate depends on API crates provided by gtk-rs project for type/object system, event loop, and dispacher.
§Repository
The alsaseq crate is the part of ALSA project and maintained by ALSA gobject-introspection team. The remote repository is located in https://github.com/alsa-project/alsa-gobject-rs.
§Support
If finding issue, please file it in https://github.com/alsa-project/alsa-gobject-rs.
§Sample programs
Some programs are available under examples
directory.
-
dump-event-data.rs
- demonstration to dump events received at port registered in ALSA Sequencer.
Re-exports§
pub use ffi;
Modules§
- prelude
- For convenience to provide auto-generated/manual traits, and their blanket implementations.
- subclass
- For subclass implementations derived from provided class.
Structs§
- Addr
- A boxed object to express address in ALSA Sequencer.
- Client
Info - A GObject-derived object to express information of client.
- Client
Pool - A GObject-derived object to express information of pool owned by client.
- Event
- A boxed structure for sequencer event.
- Event
Cntr - A boxed structure for container which includes batch of events.
- Event
Data Connect - A boxed object to express data of connect event.
- Event
Data Ctl - A boxed object to express data of control event.
- Event
Data Note - A boxed object to express data of note event.
- Event
Data Queue - A boxed object to express data of queue event.
- Event
Data Result - A boxed object to express data of result event.
- Filter
Attr Flag - A set of flags for attributes of event filter.
- Port
Attr Flag - A set of flags for the attributes of port.
- Port
CapFlag - A set of flags for the capabilities of port.
- Port
Info - A GObject-derived object to express information of port.
- Queue
Info - A GObject-derived object to express information of queue.
- Queue
Status - A GObject-derived object to express status of queue.
- Queue
Tempo - A GObject-derived object to express tempo of queue.
- Queue
Timer Alsa - An object to express queue timer specific to instance in ALSA Timer.
- Queue
Timer Common - An interface to express common features of queue timer.
- Remove
Filter - An object to express filter to remove scheduled event in queue.
- Remove
Filter Flag - A set of flags of the mode of removal event.
- Subscribe
Data - A GObject-derived object to express data for subscription between ports.
- System
Info - A GObject-derived object to express information of ALSA Sequencer.
- User
Client - A GObject-derived object to express user client.
Enums§
- Client
Type - A set of enumerations for the type of client.
- Event
Error - A set of error code for
glib::Error
withstruct@EventError
domain. - Event
Length Mode - A set of enumeration for the mode of data length.
- Event
Priority Mode - A set of enumerations for the mode of priority.
- Event
Time Mode - A set of enumerations for the mode of time.
- Event
Tstamp Mode - A set of enumeration for the mode of time stamp.
- Event
Type - The type of event.
- Query
Subscribe Type - A set of enumerations for the type to query subscription.
- Queue
Timer - A set of timer which drives queue.
- Queue
Timer Type - A set of enumerations for the type of timer source for the queue.
- Specific
Address - A set of enumerations for specific addresses.
- Specific
Client Id - A set of enumerations for the numerical IDs of specific clients.
- Specific
Port Id - A set of enumerations for the numerical IDs of port for specific purpose.
- Specific
Queue Id - A set of enumerations for the numerical IDs of queue for specific purpose.
- User
Client Error - A set of error code for [structGLib.Error] with
struct@UserClientError
domain.
Functions§
- client_
id_ list - Get the list of clients as the numeric identifier.
- client_
info - Get the information of client according to the numeric ID.
- client_
pool - Get statistical information of memory pool for the given client.
- port_
id_ list - Get the list of numeric identifiers for port added by the client.
- port_
info - Get the information of port in client.
- queue_
id_ list - Get the list of queue in ALSA Sequencer.
- queue_
info_ by_ id - Get the information of queue, according to the numeric ID.
- queue_
info_ by_ name - Get the information of queue, according to the name string.
- queue_
status - Get current status of queue.
- seq_
devnode - Allocate devnode string for ALSA Sequencer and return it when exists.
- seq_
sysname - Allocate sysname string for ALSA sequencer and return it when exists.
- subscription_
list - Get the list of subscription for given address and query type.
- system_
info - Get information of ALSA Sequencer.