Struct fidl_fuchsia_audio_device::RingBufferProxy

pub struct RingBufferProxy { /* private fields */ }

Implementations

impl RingBufferProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.audio.device/RingBuffer.

pub fn take_event_stream(&self) -> RingBufferEventStream

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

Panics

Panics if the event stream was already taken.

pub fn set_active_channels( &self, payload: &RingBufferSetActiveChannelsRequest ) -> QueryResponseFut<RingBufferSetActiveChannelsResult>

Request that specific individual channels be powered down/up, if the device supports this. This is intended for idle power conservation.

Channels are specified by bitmask; the least significant bit corresponds to channel 0. Each bit not set indicates that the channel can be deactivated. SetActiveChannels does not change how a ring buffer responds to Start/Stop, specifically with regards to position.

Devices are not required to obey SetActiveChannels. For example, they are not required to zero-out an input stream’s inactive channels, and data written to inactive channels of an output stream’s ring buffer may still be played.

If not called, then by default all channels will be active.

pub fn start( &self, payload: &RingBufferStartRequest ) -> QueryResponseFut<RingBufferStartResult>

Start the ring buffer, beginning at the first frame of the ring buffer.

pub fn stop( &self, payload: &RingBufferStopRequest ) -> QueryResponseFut<RingBufferStopResult>

Stop the ring buffer.

pub fn watch_delay_info( &self ) -> QueryResponseFut<RingBufferWatchDelayInfoResult>

Request delay information via a hanging get. The RingBuffer will respond immediately to the first WatchDelayInfo call. Subsequent calls will only be completed when the delay info has changed from previously communicated values.

Trait Implementations

impl Clone for RingBufferProxy

fn clone(&self) -> RingBufferProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RingBufferProxy

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

Formats the value using the given formatter.

impl Proxy for RingBufferProxy

type Protocol = RingBufferMarker

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.

impl RingBufferProxyInterface for RingBufferProxy

type SetActiveChannelsResponseFut = QueryResponseFut<Result<RingBufferSetActiveChannelsResponse, RingBufferSetActiveChannelsError>>

fn set_active_channels( &self, payload: &RingBufferSetActiveChannelsRequest ) -> Self::SetActiveChannelsResponseFut

type StartResponseFut = QueryResponseFut<Result<RingBufferStartResponse, RingBufferStartError>>

fn start(&self, payload: &RingBufferStartRequest) -> Self::StartResponseFut

type StopResponseFut = QueryResponseFut<Result<RingBufferStopResponse, RingBufferStopError>>

fn stop(&self, payload: &RingBufferStopRequest) -> Self::StopResponseFut

type WatchDelayInfoResponseFut = QueryResponseFut<Result<RingBufferWatchDelayInfoResponse, RingBufferWatchDelayInfoError>>

fn watch_delay_info(&self) -> Self::WatchDelayInfoResponseFut