Struct EffectsControllerProxy

pub struct EffectsControllerProxy { /* private fields */ }

Implementations

impl EffectsControllerProxy

pub fn new(channel: AsyncChannel) -> Self

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

pub fn take_event_stream(&self) -> EffectsControllerEventStream

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

Panics

Panics if the event stream was already taken.

pub fn update_effect( &self, effect_name: &str, config: &str, ) -> QueryResponseFut<EffectsControllerUpdateEffectResult, DefaultFuchsiaResourceDialect>

Sends the config message to an audio effect named effect_name. If the server closes the EffectsController connection for any reason, that indicates that the effects have been reset and any state associated with previous UpdateEffect messages have been lost. Clients who wish to re-apply state should respond by reconnecting and resending any needed UpdateEffect messages. If a client closes the connection, no state will be lost but the client will also be unable to determine if and when any state associated with previous messages have been lost.

Returns success (empty response) if the message was accepted by an effect named effect_name.

Returns UpdateEffectError.INVALID_CONFIG if an effect with the name effect_name was found, but the config message was rejected.

Returns UpdateEffectError.NOT_FOUND if no effect with name effect_name could be located.

Trait Implementations

impl Clone for EffectsControllerProxy

fn clone(&self) -> EffectsControllerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EffectsControllerProxy

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

Formats the value using the given formatter.

impl EffectsControllerProxyInterface for EffectsControllerProxy

type UpdateEffectResponseFut = QueryResponseFut<Result<(), UpdateEffectError>>

fn update_effect( &self, effect_name: &str, config: &str, ) -> Self::UpdateEffectResponseFut

impl Proxy for EffectsControllerProxy

type Protocol = EffectsControllerMarker

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.