Struct SessionControlSynchronousProxy

pub struct SessionControlSynchronousProxy { /* private fields */ }

Implementations

impl SessionControlSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<SessionControlEvent, 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 play(&self) -> Result<(), Error>

Plays media.

pub fn pause(&self) -> Result<(), Error>

Pauses playback and retains position in media

pub fn stop(&self) -> Result<(), Error>

Stops playback. The session should close.

pub fn seek(&self, position: i64) -> Result<(), Error>

Seeks to a specific position in media. Implementations are free to enter an error state if the position is out of bounds. position is an offset from the beginning of the media.

pub fn skip_forward(&self) -> Result<(), Error>

Skips forward in media by the player’s default skip amount.

pub fn skip_reverse(&self) -> Result<(), Error>

Skips in reverse in media by the player’s default skip amount.

pub fn next_item(&self) -> Result<(), Error>

Changes media to the next item (e.g. next song in playlist).

pub fn prev_item(&self) -> Result<(), Error>

Changes media to the previous item.

pub fn set_playback_rate(&self, playback_rate: f32) -> Result<(), Error>

Sets the playback rate of the media. This will not change the playback mode.

pub fn set_repeat_mode(&self, repeat_mode: RepeatMode) -> Result<(), Error>

Sets repeat mode to any of the supported repeat modes.

pub fn set_shuffle_mode(&self, shuffle_on: bool) -> Result<(), Error>

Sets shuffle mode.

pub fn bind_volume_control( &self, volume_control_request: ServerEnd<VolumeControlMarker>, ) -> Result<(), Error>

Binds to the session’s volume control for control and notifications.

pub fn watch_status( &self, ___deadline: MonotonicInstant, ) -> Result<SessionInfoDelta, Error>

Watches the session status. Leave a request hanging to receive a reply when the session status changes. The first request will be answered immediately with the current state.

Trait Implementations

impl Debug for SessionControlSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for SessionControlSynchronousProxy

type Proxy = SessionControlProxy

The async proxy for the same protocol.

type Protocol = SessionControlMarker

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.