Enum PacketStreamSinkRequest 

pub enum PacketStreamSinkRequest {
    PutPacket {
        payload: PacketStreamSinkPutPacketRequest,
        responder: PacketStreamSinkPutPacketResponder,
    },
    FlushPackets {
        responder: PacketStreamSinkFlushPacketsResponder,
    },
    #[non_exhaustive]
    _UnknownMethod {
        ordinal: u64,
        control_handle: PacketStreamSinkControlHandle,
        method_type: MethodType,
    },
}

The protocol for streaming packet-based audio data. This protocol functions as a data sink. The “server” of this protocol consumes packets, and the “client” produces packets.

This protocol can be used in two directions:

1. Output (Client -> Driver): The Driver implements PacketStreamSink. The Client (App) calls PutPacket.
2. Input (Driver -> Client): The Client (App) implements PacketStreamSink. The Driver calls PutPacket.

Variants

PutPacket

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.

Fields

payload: PacketStreamSinkPutPacketRequest

responder: PacketStreamSinkPutPacketResponder

FlushPackets

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.

Fields

responder: PacketStreamSinkFlushPacketsResponder

#[non_exhaustive]

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: PacketStreamSinkControlHandle

method_type: MethodType

Implementations

impl PacketStreamSinkRequest

pub fn into_put_packet( self, ) -> Option<(PacketStreamSinkPutPacketRequest, PacketStreamSinkPutPacketResponder)>

pub fn into_flush_packets(self) -> Option<PacketStreamSinkFlushPacketsResponder>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for PacketStreamSinkRequest

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

Formats the value using the given formatter.