Crate alsatimer

alsatimer crate

Rust API bindings and wrappers for alsatimer library to operate ALSA Timer character device.

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

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

Usage

Add the following line to your Cargo.toml file:

[dependencies]
alsatimer = "0.7"

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

License

The alsatimer crate is released under MIT license.

Dependency

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

Repository

The alsatimer 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.

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

DeviceId

A boxed object to express the identifier of timer device.

DeviceInfo

A GObject-derived object to express information of timer device.

DeviceInfoFlag

A set of flags for the information of timer device.

DeviceParams

A GObject-derived object to express parameter of timer device.

DeviceStatus

A GObject-derived object to express status of timer device.

InstanceInfo

A GObject-derived object to express information of user instance.

InstanceParamFlag

A set of flags for the parameters of user client.

InstanceParams

A GObject-derived object to express parameters of user instance.

InstanceStatus

A GObject-derived object to express status of user instance.

RealTimeEvent

A boxed object to express event of timer with real time.

TickTimeEvent

A boxed object to express event of timer with tick count.

UserInstance

A GObject-derived object to express user instance.

Enums

Class

A set of enumerations for the class of timer device.

EventType

A set of enumerations for the type of event.

RealTimeEventType

A set of enumerations for the type of real time event.

SlaveClass

A set of enumerations for the slave class of timer instance (not timer device).

SpecificGlobalDevice

A set of enumerations for the kind of global timer device.

UserInstanceError

A set of error code for glib::Error with ALSATimer.UserInstanceError domain.

Functions

device_id_list

Get the list of existent timer device.

device_info

Get the information of timer device.

device_status

Get the status of timer device.

devnode

Allocate string of devnode for ALSA Timer and return it if exists.

real_time_clock_id

Get clock_id for real time.

set_device_params

Set the given parameters to the timer indicated by the identifier.

sysname

Allocate sysname for ALSA Timer and return it when it exists.