Struct EffectsControllerSynchronousProxy

pub struct EffectsControllerSynchronousProxy { /* private fields */ }

Implementations

impl EffectsControllerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<EffectsControllerEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn update_effect( &self, effect_name: &str, config: &str, ___deadline: MonotonicInstant, ) -> Result<EffectsControllerUpdateEffectResult, Error>

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 Debug for EffectsControllerSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for EffectsControllerSynchronousProxy

type Proxy = EffectsControllerProxy

The async proxy for the same protocol.

type Protocol = EffectsControllerMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.