Crate alsactl

source ·
Expand description

§alsactl crate

Rust API bindings and wrappers for alsactl library to operate ALSA Control character device.

The alsactl library version 0.3.0 is the minimum supported version for underlying library.

The alsactl crate is automatically generated by gir tool provided by gtk-rs project. ALSACtl-0.0 file from alsactl library is used for the generation. But some functions are implemented manually.

§Usage

Add the following line to your Cargo.toml file:

[dependencies]
alsactl = "0.6"

The API documentation is available in https://docs.rs/alsactl/.

§License

The alsactl crate is released under MIT license.

§Dependency

The alsactl crate depends on API crates provided by gtk-rs project for type/object system, event loop, and dispacher.

§Repository

The alsactl 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-elem-data.rs

    • demonstration to dump information and current values of elements available in a sound card.

Re-exports§

Modules§

  • prelude
    For convenience to provide auto-generated/manual traits, and their blanket implementations.
  • subclass
    For subclass implementations derived from provided class.

Structs§

  • Card
    An GObject-derived object to express sound card.
  • CardInfo
    A GObject-derived object to express information of sound card.
  • ElemAccessFlag
    A set of flags for access information of the element.
  • ElemEventMask
    A set of flags for the content of event for the element.
  • ElemId
    A boxed object to express the identifier of element.
  • ElemInfoBoolean
    An object to express information for boolean type of element.
  • ElemInfoBytes
    An object to express information for bytes type of element.
  • ElemInfoCommon
    An interface to express common features of element information.
  • ElemInfoEnumerated
    An object to express information for enumerated type of element.
  • ElemInfoIec60958
    An object to express information for iec60958 type of element.
  • ElemInfoInteger
    An object to express information for integer type of element.
  • ElemInfoInteger64
    An object to express information for integer64 type of element.
  • ElemInfoSingleArray
    An interface to express information of element which has single value array.
  • ElemValue
    A GObject-derived object to express the container of array for values specific to element type.

Enums§

  • CardError
    A set of error code for glib::Error with ALSACtl.CardError domain.
  • ElemIfaceType
    A set of enumerations for interface of element.
  • ElemInfo
    A set of information about control elements.
  • ElemType
    A set of enumerations for type of element.
  • EventType
    A set of enumerations for the type of event.

Functions§

  • card_id_list
    Get the list of numeric ID for available sound cards.
  • card_sysname
    Allocate sysname for the sound card and return it when it exists.
  • control_devnode
    Allocate string of devnode for control device of the sound card and return it if exists.
  • control_sysname
    Allocate sysname of control device for the sound card and return it if exists.