Skip to main content

InputDevice

Struct InputDevice 

Source
pub struct InputDevice {
Show 23 fields pub key: DeviceKey, pub name: Property<String>, pub description: Property<String>, pub card_index: Property<Option<u32>>, pub owner_module: Property<Option<u32>>, pub driver: Property<String>, pub state: Property<DeviceState>, pub volume: Property<Volume>, pub base_volume: Property<Volume>, pub n_volume_steps: Property<u32>, pub muted: Property<bool>, pub properties: Property<HashMap<String, String>>, pub ports: Property<Vec<DevicePort>>, pub active_port: Property<Option<String>>, pub formats: Property<Vec<AudioFormat>>, pub sample_spec: Property<SampleSpec>, pub channel_map: Property<ChannelMap>, pub monitor_of_sink: Property<Option<u32>>, pub monitor_of_sink_name: Property<Option<String>>, pub is_monitor: Property<bool>, pub latency: Property<MicroSeconds>, pub configured_latency: Property<MicroSeconds>, pub flags: Property<u32>, /* private fields */
}
Expand description

PulseAudio source with reactive properties and control methods.

Instances from AudioService fields are live (properties auto-update). Instances from AudioService::input_device are snapshots (frozen state).

§Control Methods

Fields§

§key: DeviceKey

Device key for identification

§name: Property<String>

Device name (internal identifier)

§description: Property<String>

Human-readable description

§card_index: Property<Option<u32>>

Card index this device belongs to

§owner_module: Property<Option<u32>>

Index of the owning module

§driver: Property<String>

Driver name

§state: Property<DeviceState>

Device state

§volume: Property<Volume>

Current volume levels

§base_volume: Property<Volume>

Base volume (reference level)

§n_volume_steps: Property<u32>

Number of volume steps for devices which do not support arbitrary volumes

§muted: Property<bool>

Whether device is muted

§properties: Property<HashMap<String, String>>

Device properties from PulseAudio

§ports: Property<Vec<DevicePort>>

Available ports

§active_port: Property<Option<String>>

Currently active port

§formats: Property<Vec<AudioFormat>>

Supported audio formats

§sample_spec: Property<SampleSpec>

Sample specification

§channel_map: Property<ChannelMap>

Channel map

§monitor_of_sink: Property<Option<u32>>

Index of the sink being monitored (if this is a monitor source)

§monitor_of_sink_name: Property<Option<String>>

Name of the sink being monitored (if this is a monitor source)

§is_monitor: Property<bool>

Whether this is a monitor source

§latency: Property<MicroSeconds>

Latency in microseconds

§configured_latency: Property<MicroSeconds>

Configured latency in microseconds

§flags: Property<u32>

Device flags (raw flags from PulseAudio)

Implementations§

Source§

impl InputDevice

Source

pub async fn set_volume(&self, volume: Volume) -> Result<(), Error>

Set the volume for this input device.

§Errors

Returns error if backend communication fails or device operation fails.

Source

pub async fn set_mute(&self, muted: bool) -> Result<(), Error>

Set the mute state for this input device.

§Errors

Returns error if backend communication fails or device operation fails.

Source

pub async fn set_port(&self, port: String) -> Result<(), Error>

Set the active port for this input device.

§Errors

Returns error if backend communication fails or device operation fails.

Source

pub async fn set_as_default(&self) -> Result<(), Error>

Set this device as the default input.

§Errors

Returns error if backend communication fails or device operation fails.

Trait Implementations§

Source§

impl Clone for InputDevice

Source§

fn clone(&self) -> InputDevice

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for InputDevice

Source§

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl ModelMonitoring for InputDevice

Source§

type Error = Error

Error type for monitoring operations.
Source§

async fn start_monitoring(self: Arc<Self>) -> Result<(), Self::Error>

Starts monitoring for state changes with shared ownership. Read more
Source§

impl PartialEq for InputDevice

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Reactive for InputDevice

Source§

type Context<'a> = InputDeviceParams<'a>

Context type for static fetching.
Source§

type LiveContext<'a> = LiveInputDeviceParams<'a>

Context type for live monitoring.
Source§

type Error = Error

Error type for reactive operations.
Source§

async fn get(params: Self::Context<'_>) -> Result<Self, Self::Error>

Fetches a static snapshot without monitoring.
Source§

async fn get_live( params: Self::LiveContext<'_>, ) -> Result<Arc<Self>, Self::Error>

Fetches with live monitoring and reactive updates.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more