Crate alsaseq

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.6"

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.
• ClientInfo
  A GObject-derived object to express information of client.
• ClientPool
  A GObject-derived object to express information of pool owned by client.
• Event
  A boxed structure for sequencer event.
• EventCntr
  A boxed structure for container which includes batch of events.
• EventDataConnect
  A boxed object to express data of connect event.
• EventDataCtl
  A boxed object to express data of control event.
• EventDataNote
  A boxed object to express data of note event.
• EventDataQueue
  A boxed object to express data of queue event.
• EventDataResult
  A boxed object to express data of result event.
• FilterAttrFlag
  A set of flags for attributes of event filter.
• PortAttrFlag
  A set of flags for the attributes of port.
• PortCapFlag
  A set of flags for the capabilities of port.
• PortInfo
  A GObject-derived object to express information of port.
• QueueInfo
  A GObject-derived object to express information of queue.
• QueueStatus
  A GObject-derived object to express status of queue.
• QueueTempo
  A GObject-derived object to express tempo of queue.
• QueueTimerAlsa
  An object to express queue timer specific to instance in ALSA Timer.
• QueueTimerCommon
  An interface to express common features of queue timer.
• RemoveFilter
  An object to express filter to remove scheduled event in queue.
• RemoveFilterFlag
  A set of flags of the mode of removal event.
• SubscribeData
  A GObject-derived object to express data for subscription between ports.
• SystemInfo
  A GObject-derived object to express information of ALSA Sequencer.
• UserClient
  A GObject-derived object to express user client.

Enums

• ClientType
  A set of enumerations for the type of client.
• EventError
  A set of error code for glib::Error with struct@EventError domain.
• EventLengthMode
  A set of enumeration for the mode of data length.
• EventPriorityMode
  A set of enumerations for the mode of priority.
• EventTimeMode
  A set of enumerations for the mode of time.
• EventTstampMode
  A set of enumeration for the mode of time stamp.
• EventType
  The type of event.
• QuerySubscribeType
  A set of enumerations for the type to query subscription.
• QueueTimer
  A set of timer which drives queue.
• QueueTimerType
  A set of enumerations for the type of timer source for the queue.
• SpecificAddress
  A set of enumerations for specific addresses.
• SpecificClientId
  A set of enumerations for the numerical IDs of specific clients.
• SpecificPortId
  A set of enumerations for the numerical IDs of port for specific purpose.
• SpecificQueueId
  A set of enumerations for the numerical IDs of queue for specific purpose.
• UserClientError
  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.