Struct GainControlProxy

pub struct GainControlProxy { /* private fields */ }

Implementations

impl GainControlProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.media.audio/GainControl.

pub fn take_event_stream(&self) -> GainControlEventStream

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

Panics

Panics if the event stream was already taken.

pub fn set_gain(&self, gain_db: f32) -> Result<(), Error>

Sets the gain in decibels.

pub fn set_gain_with_ramp( &self, gain_db: f32, duration: i64, ramp_type: RampType, ) -> Result<(), Error>

Smoothly changes gain from its current value to specified value, over the specified duration (in milliseconds). If ‘duration_ns’ is 0, gain changes immediately. Otherwise, gain changes only while the stream is running.

Any active or pending ramp is cancelled by subsequent call to SetGain.

There can be at most 1 active ramp at any time. Any active or pending ramp is replaced by a later call to SetGainWithRamp (even if duration is 0). In this case gain would ramps directly from its most recent (mid-ramp) value to the newly-specified one, over the new duration, using the new easing.

Usage example (using time in seconds): Time 0 SetGainWithRamp(MUTED_GAIN_DB, 0, SCALE_LINEAR) // Ramp 1 SetGainWithRamp(0.0f, ZX_SEC(4), SCALE_LINEAR) // Ramp 2 Time 3 PlayNoReply(kNoTimestamp, any_media_time) Time 4 PauseNoReply() Time 7 PlayNoReply(kNoTimestamp, any_media_time) Time 8 SetGainWithRamp(MUTED_GAIN_DB, ZX_SEC(1), SCALE_LINEAR) // Ramp 3

Time 0: Ramp 1 completes immediately, changing the gain to MUTED_GAIN_DB. Ramp 2 is pending, since we are not in playback. Time 3, Ramp 2 begins ramping from MUTED_GAIN_DB to 0 dB (scale 0.0=>1.0). Time 4: Ramp 2 pauses (3s remain). Per SCALE_LINEAR, scale is approx. 0.25. Time 7: Ramp 2 resumes from most recent value toward the target. Time 8: Ramp 3 replaces Ramp 2 and starts from current scale (approx 0.5). Time 9: Ramp 3 completes; current scale value is now 0.0 (MUTED_GAIN_DB).

pub fn set_mute(&self, muted: bool) -> Result<(), Error>

Sets the mute value. Ramping and mute are fully independent, although they both affect the scaling that is applied.

Trait Implementations

impl Clone for GainControlProxy

fn clone(&self) -> GainControlProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GainControlProxy

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

Formats the value using the given formatter.

impl GainControlProxyInterface for GainControlProxy

fn set_gain(&self, gain_db: f32) -> Result<(), Error>

fn set_gain_with_ramp( &self, gain_db: f32, duration: i64, ramp_type: RampType, ) -> Result<(), Error>

fn set_mute(&self, muted: bool) -> Result<(), Error>

impl Proxy for GainControlProxy

type Protocol = GainControlMarker

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.