Enum PlayerControlRequest

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,
    },
}

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

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

Fields

control_handle: PlayerControlControlHandle

Pause

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.

Fields

control_handle: PlayerControlControlHandle

Stop

Stops playback. The session should close.

Fields

control_handle: PlayerControlControlHandle

Seek

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.

Fields

position: i64

control_handle: PlayerControlControlHandle

SkipForward

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.

Fields

control_handle: PlayerControlControlHandle

SkipReverse

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.

Fields

control_handle: PlayerControlControlHandle

NextItem

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.

Fields

control_handle: PlayerControlControlHandle

PrevItem

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.

Fields

control_handle: PlayerControlControlHandle

SetPlaybackRate

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.

Fields

playback_rate: f32

control_handle: PlayerControlControlHandle

SetRepeatMode

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.

Fields

repeat_mode: RepeatMode

control_handle: PlayerControlControlHandle

SetShuffleMode

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

Fields

shuffle_on: bool

control_handle: PlayerControlControlHandle

BindVolumeControl

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.

Fields

volume_control_request: ServerEnd<VolumeControlMarker>

control_handle: PlayerControlControlHandle

Implementations

impl PlayerControlRequest

pub fn into_play(self) -> Option<PlayerControlControlHandle>

pub fn into_pause(self) -> Option<PlayerControlControlHandle>

pub fn into_stop(self) -> Option<PlayerControlControlHandle>

pub fn into_seek(self) -> Option<(i64, PlayerControlControlHandle)>

pub fn into_skip_forward(self) -> Option<PlayerControlControlHandle>

pub fn into_skip_reverse(self) -> Option<PlayerControlControlHandle>

pub fn into_next_item(self) -> Option<PlayerControlControlHandle>

pub fn into_prev_item(self) -> Option<PlayerControlControlHandle>

pub fn into_set_playback_rate(self) -> Option<(f32, PlayerControlControlHandle)>

pub fn into_set_repeat_mode( self, ) -> Option<(RepeatMode, PlayerControlControlHandle)>

pub fn into_set_shuffle_mode(self) -> Option<(bool, PlayerControlControlHandle)>

pub fn into_bind_volume_control( self, ) -> Option<(ServerEnd<VolumeControlMarker>, PlayerControlControlHandle)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for PlayerControlRequest

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

Formats the value using the given formatter.