pub enum PlayerControlRequest {
    Play {
        control_handle: PlayerControlControlHandle,
    },
    Pause {
        control_handle: PlayerControlControlHandle,
    },
    Stop {
        control_handle: PlayerControlControlHandle,
    },
    Seek {
        position: i64,
        control_handle: PlayerControlControlHandle,
    },
    SkipForward {
        control_handle: PlayerControlControlHandle,
    },
    SkipReverse {
        control_handle: PlayerControlControlHandle,
    },
    NextItem {
        control_handle: PlayerControlControlHandle,
    },
    PrevItem {
        control_handle: PlayerControlControlHandle,
    },
    SetPlaybackRate {
        playback_rate: f32,
        control_handle: PlayerControlControlHandle,
    },
    SetRepeatMode {
        repeat_mode: RepeatMode,
        control_handle: PlayerControlControlHandle,
    },
    SetShuffleMode {
        shuffle_on: bool,
        control_handle: PlayerControlControlHandle,
    },
    BindVolumeControl {
        volume_control_request: ServerEnd<VolumeControlMarker>,
        control_handle: PlayerControlControlHandle,
    },
}
Expand description

Controls for a media player. PlayerCapabilities expresses which of the methods in this protocol are supported by the player. Because capabilties are dynamic, and a client cannot always know what capabilities will be supported when the method call reaches the service, calling a method that is not supported is simply ignored. In general, clients should not expect methods to work unless the player indicates sustained support.

Variants§

§

Play

Fields

Plays media. If this method is not supported as indicated by the absence of the PLAY flag in PlayerCapabilities, this method does nothing.

§

Pause

Fields

Pauses playback and retains position in media. If this method is not supported as indicated by the absence of the PAUSE flag in PlayerCapabilities, this method does nothing.

§

Stop

Fields

Stops playback. The session should close.

§

Seek

Fields

§position: i64

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. If this method is not supported as indicated by the absence of the SEEK flag in PlayerCapabilities, this method does nothing.

§

SkipForward

Fields

Skips forward in media by the player’s default skip amount. If this method is not supported as indicated by the absence of the SKIP_FORWARD flag in PlayerCapabilities, this method does nothing.

§

SkipReverse

Fields

Skips in reverse in media by the player’s default skip amount. If this method is not supported as indicated by the absence of the SKIP_REVERSE flag in PlayerCapabilities, this method does nothing.

§

NextItem

Fields

Changes media to the next item (e.g. next song in playlist). If this method is not supported as indicated by the absence of the CHANGE_TO_NEXT_ITEM flag in PlayerCapabilities, this method does nothing.

§

PrevItem

Fields

Changes media to the previous item. If this method is not supported as indicated by the absence of the CHANGE_TO_PREV_ITEM flag in PlayerCapabilities, this method does nothing.

§

SetPlaybackRate

Fields

§playback_rate: f32

Sets the playback rate of the media. This will not change the playback mode. If this method is not supported as indicated by the absense of the SET_PLAYBACK_RATE flag in PlayerCapabilities, this method does nothing.

§

SetRepeatMode

Fields

§repeat_mode: RepeatMode

Sets repeat mode to any of the supported repeat modes. Whether this method takes effect depends on the PlayerCapabilities and repeat_mode:

  • [OFF] is always supported.
  • [GROUP] requires the REPEAT_GROUPS capability, and is otherwise ignored.
  • [SINGLE] requires the REPEAT_SINGLE capability, and is otherwise ignored.
§

SetShuffleMode

Fields

§shuffle_on: bool

Sets shuffle mode. If this method is not supported as indicated by the absence of the SHUFFLE flag in PlayerCapabilities, this method does nothing.

§

BindVolumeControl

Fields

§volume_control_request: ServerEnd<VolumeControlMarker>

Binds to the session’s volume control for control and notifications. If this method is not supported as indicated by the absence of the HAS_GAIN_CONTROL flag in PlayerCapabilities, the channel handle passed as volume_control_request is closed by the service.

Implementations§

Trait Implementations§

source§

impl Debug for PlayerControlRequest

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more