Enum AudioConsumerRequest

pub enum AudioConsumerRequest {
    CreateStreamSink {
        buffers: Vec<Vmo>,
        stream_type: AudioStreamType,
        compression: Option<Box<Compression>>,
        stream_sink_request: ServerEnd<StreamSinkMarker>,
        control_handle: AudioConsumerControlHandle,
    },
    Start {
        flags: AudioConsumerStartFlags,
        reference_time: i64,
        media_time: i64,
        control_handle: AudioConsumerControlHandle,
    },
    Stop {
        control_handle: AudioConsumerControlHandle,
    },
    SetRate {
        rate: f32,
        control_handle: AudioConsumerControlHandle,
    },
    BindVolumeControl {
        volume_control_request: ServerEnd<VolumeControlMarker>,
        control_handle: AudioConsumerControlHandle,
    },
    WatchStatus {
        responder: AudioConsumerWatchStatusResponder,
    },
}

Interface for playing and controlling audio.

Variants

CreateStreamSink

Creates a StreamSink for the consumer with the indicated properties.

Multiple stream sinks may be acquired using this method, but they are intended to be used sequentially rather than concurrently. The first stream sink that’s created using this method is used as the sole source of packets incoming to the logical consumer until that stream sink is closed or the EndOfStream method is called on that sink. At that point, the second stream sink is used, and so on.

If an unsupported compression type is supplied, the stream_sink_request request will be closed with an epitaph value of ZX_ERR_INVALID_ARGS.

Fields

buffers: Vec<Vmo>

stream_type: AudioStreamType

compression: Option<Box<Compression>>

stream_sink_request: ServerEnd<StreamSinkMarker>

control_handle: AudioConsumerControlHandle

Start

Starts rendering as indicated by flags.

media_time indicates the packet timestamp that corresponds to reference_time. Typically, this is the timestamp of the first packet that will be rendered. If packets will be supplied with no timestamps, this value should be NO_TIMESTAMP. Passing a media_time value of NO_TIMESTAMP chooses the default media time, established as follows: 1. When starting for the first time, the default media time is the timestamp on the first packet sent to the stream sink. 2. When resuming after stop, the default media time is the media time at which the stream stopped.

reference_time is the monotonic system time at which rendering should be started. For supply-driven sources, this must be the time at which the first packet was (or will be) sent plus a lead time, which must be in the range indicated in the AudioConsumerStatus. For demand-driven sources, the client must ensure that the lead time requirement is met at the start time. Passing the default value of 0 for reference_time causes the consumer to choose a start time based on the availability of packets, the lead time requirements, and whether LOW_LATENCY has been specified.

The actual start time will be reflected in the updated status.

Fields

flags: AudioConsumerStartFlags

reference_time: i64

media_time: i64

control_handle: AudioConsumerControlHandle

Stop

Stops rendering as soon as possible after this method is called. The actual stop time will be reflected in the updated status.

Fields

control_handle: AudioConsumerControlHandle

SetRate

Requests to change the playback rate of the renderer. 1.0 means normal playback. Negative rates are not supported. The new rate will be reflected in the updated status. The default rate of any newly created StreamSink is 1.0.

Fields

rate: f32

control_handle: AudioConsumerControlHandle

BindVolumeControl

Binds to this AudioConsumer volume control for control and notifications.

Fields

volume_control_request: ServerEnd<VolumeControlMarker>

control_handle: AudioConsumerControlHandle

WatchStatus

Gets the current status of the consumer using the long get pattern. The consumer responds to this method when the status changes - initially with respect to the initial status value and thereafter with respect to the previously-reported status value.

Fields

responder: AudioConsumerWatchStatusResponder

Implementations

impl AudioConsumerRequest

pub fn into_create_stream_sink( self, ) -> Option<(Vec<Vmo>, AudioStreamType, Option<Box<Compression>>, ServerEnd<StreamSinkMarker>, AudioConsumerControlHandle)>

pub fn into_start( self, ) -> Option<(AudioConsumerStartFlags, i64, i64, AudioConsumerControlHandle)>

pub fn into_stop(self) -> Option<AudioConsumerControlHandle>

pub fn into_set_rate(self) -> Option<(f32, AudioConsumerControlHandle)>

pub fn into_bind_volume_control( self, ) -> Option<(ServerEnd<VolumeControlMarker>, AudioConsumerControlHandle)>

pub fn into_watch_status(self) -> Option<AudioConsumerWatchStatusResponder>

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for AudioConsumerRequest

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

Formats the value using the given formatter.