Struct fidl_fuchsia_virtualaudio::DeviceProxy

pub struct DeviceProxy { /* private fields */ }

Implementations

impl DeviceProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.virtualaudio/Device.

pub fn take_event_stream(&self) -> DeviceEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn get_format(&self) -> QueryResponseFut<DeviceGetFormatResult>

Returns the format selected by the client, or NO_RING_BUFFER if the client has not yet selected a ring buffer format.

pub fn get_gain(&self) -> QueryResponseFut<DeviceGetGainResult>

Returns the current gain state for this device.

pub fn get_buffer(&self) -> QueryResponseFut<DeviceGetBufferResult>

Returns details about the ring buffer. Returns NO_RING_BUFFER if the client has not yet created the ring buffer.

pub fn set_notification_frequency( &self, notifications_per_ring: u32 ) -> QueryResponseFut<DeviceSetNotificationFrequencyResult>

Overrides the position notification frequency for this stream. This affects the frequency of OnPositionNotify events only. It does not affect the frequency of notification events sent through the audio driver APIs.

pub fn get_position(&self) -> QueryResponseFut<DeviceGetPositionResult>

Returns the current position (in bytes) within the ring buffer, along with the time (per MONOTONIC clock) that corresponds with that position. This can only be called after the ring buffer is established. Returns NOT_STARTED if the device has not yet Started streaming.

pub fn change_plug_state( &self, plug_change_time: i64, plugged: bool ) -> QueryResponseFut<DeviceChangePlugStateResult>

Hot-plugs or hot-unplugs an active virtual device, at the specified time.

pub fn adjust_clock_rate( &self, ppm_from_monotonic: i32 ) -> QueryResponseFut<DeviceAdjustClockRateResult>

Immediately change the virtual device’s clock rate, as expressed in the timing and content of position notifications the driver emits. ‘ppm_monotonic’ cannot exceed [-1000,+1000]. Each rate change in rate is standalone; i.e. successive rate changes are not cumulative.

Trait Implementations

impl Clone for DeviceProxy

fn clone(&self) -> DeviceProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceProxy

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

Formats the value using the given formatter.

impl DeviceProxyInterface for DeviceProxy

type GetFormatResponseFut = QueryResponseFut<Result<(u32, u32, u32, i64), Error>>

fn get_format(&self) -> Self::GetFormatResponseFut

type GetGainResponseFut = QueryResponseFut<Result<(bool, bool, f32), Error>>

fn get_gain(&self) -> Self::GetGainResponseFut

type GetBufferResponseFut = QueryResponseFut<Result<(Vmo, u32, u32), Error>>

fn get_buffer(&self) -> Self::GetBufferResponseFut

type SetNotificationFrequencyResponseFut = QueryResponseFut<Result<(), Error>>

fn set_notification_frequency( &self, notifications_per_ring: u32 ) -> Self::SetNotificationFrequencyResponseFut

type GetPositionResponseFut = QueryResponseFut<Result<(i64, u32), Error>>

fn get_position(&self) -> Self::GetPositionResponseFut

type ChangePlugStateResponseFut = QueryResponseFut<Result<(), Error>>

fn change_plug_state( &self, plug_change_time: i64, plugged: bool ) -> Self::ChangePlugStateResponseFut

type AdjustClockRateResponseFut = QueryResponseFut<Result<(), Error>>

fn adjust_clock_rate( &self, ppm_from_monotonic: i32 ) -> Self::AdjustClockRateResponseFut

impl Proxy for DeviceProxy

type Protocol = DeviceMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.