Struct PacketStreamSinkProxy 

pub struct PacketStreamSinkProxy { /* private fields */ }

Implementations

impl PacketStreamSinkProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.audio/PacketStreamSink.

pub fn take_event_stream(&self) -> PacketStreamSinkEventStream

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

Panics

Panics if the event stream was already taken.

pub fn put_packet( &self, payload: PacketStreamSinkPutPacketRequest, ) -> QueryResponseFut<PacketStreamSinkPutPacketResult, DefaultFuchsiaResourceDialect>

Submits a packet to be processed by the server.

The client may queue multiple packets by calling PutPacket repeatedly. Packets are processed in the order they were submitted. This call blocks until the payload is processed. When this call returns, the buffer region is guaranteed to be available for reuse.

Returns ZX_ERR_BAD_STATE if the stream is not started or configured. Returns ZX_ERR_CANCELED if FlushPackets was called. Returns ZX_ERR_INVALID_ARGS if the packet is invalid. This includes:

• The payload is missing.
• inline_data is used but supported_buffer_types does not include INLINE.
• vmo_transfer is used but supported_buffer_types does not include CLIENT_OWNED or DRIVER_OWNED.
• vmo_id is unrecognized, or vmo_offset + payload_size exceeds the VMO size.

Note: The server is not required to detect if a VMO region is currently in use by a previous pending packet. Clients are responsible for managing buffer usage.

pub fn flush_packets( &self, ) -> QueryResponseFut<PacketStreamSinkFlushPacketsResult, DefaultFuchsiaResourceDialect>

Flushes all packets currently pending without processing them. This call waits until all pending packets are completed or canceled.

Note: A packet may be partially processed (e.g. if it contains multiple audio frames, or if the data does not align with encoded frame boundaries) before it is canceled.

Trait Implementations

impl Clone for PacketStreamSinkProxy

fn clone(&self) -> PacketStreamSinkProxy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PacketStreamSinkProxy

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

Formats the value using the given formatter.

impl PacketStreamSinkProxyInterface for PacketStreamSinkProxy

type PutPacketResponseFut = QueryResponseFut<Result<PacketStreamSinkPutPacketResponse, i32>>

type FlushPacketsResponseFut = QueryResponseFut<Result<(), i32>>

fn put_packet( &self, payload: PacketStreamSinkPutPacketRequest, ) -> Self::PutPacketResponseFut

fn flush_packets(&self) -> Self::FlushPacketsResponseFut

impl Proxy for PacketStreamSinkProxy

type Protocol = PacketStreamSinkMarker

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<'_, NullableHandle>>

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