Struct StreamSinkProxy

pub struct StreamSinkProxy { /* private fields */ }

Implementations

impl StreamSinkProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.audio/StreamSink.

pub fn take_event_stream(&self) -> StreamSinkEventStream

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: StreamSinkPutPacketRequest, ) -> Result<(), Error>

Puts a packet to the sink.

pub fn start_segment( &self, payload: &StreamSinkStartSegmentRequest, ) -> Result<(), Error>

Starts a new segment. Packets following this request and preceding the next such request are assigned to the segment.

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

Indicates that the end of the stream has been reached. Consumers such as audio renderers signal their clients when the last packet before end-of-stream has been rendered, so the client knows when to, for example, change the UI state of a player to let the user know the content is done playing. This method is logically scoped to the current segment. A SetSegment request and (typically) more packets may follow this request.

pub fn will_close( &self, payload: &StreamSinkWillCloseRequest, ) -> Result<(), Error>

Sent immediately before the producer closes to indicate why the producer is closing the connection. After sending this request, the producer must refrain from sending any more messages and close the connection promptly.

Trait Implementations

impl Clone for StreamSinkProxy

fn clone(&self) -> StreamSinkProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamSinkProxy

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

Formats the value using the given formatter.

impl Proxy for StreamSinkProxy

type Protocol = StreamSinkMarker

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 StreamSinkProxyInterface for StreamSinkProxy

fn put_packet(&self, payload: StreamSinkPutPacketRequest) -> Result<(), Error>

fn start_segment( &self, payload: &StreamSinkStartSegmentRequest, ) -> Result<(), Error>

fn end(&self) -> Result<(), Error>

fn will_close(&self, payload: &StreamSinkWillCloseRequest) -> Result<(), Error>