Project: /_project.yaml Book: /_book.yaml

fuchsia.media.sessions2

PROTOCOLS

SessionControl {:#SessionControl}

Defined in fuchsia.media.sessions2/discovery.fidl

A protocol for clients to control sessions and view their status.

Play {:#Play}

Plays media.

Request

Pause {:#Pause}

Pauses playback and retains position in media

Request

Stop {:#Stop}

Stops playback. The session should close.

Request

Seek {:#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.

Request

SkipForward {:#SkipForward}

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

Request

SkipReverse {:#SkipReverse}

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

Request

NextItem {:#NextItem}

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

Request

PrevItem {:#PrevItem}

Changes media to the previous item.

Request

SetPlaybackRate {:#SetPlaybackRate}

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

Request

SetRepeatMode {:#SetRepeatMode}

Sets repeat mode to any of the supported repeat modes.

Request

SetShuffleMode {:#SetShuffleMode}

Sets shuffle mode.

Request

BindGainControl {:#BindGainControl}

Binds to the session's gain control for control and notifications.

Request

BindVolumeControl {:#BindVolumeControl}

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

Request

SessionsWatcher {:#SessionsWatcher}

Defined in fuchsia.media.sessions2/discovery.fidl

SessionsWatcher watches the collection of published sessions.

SessionUpdated {:#SessionUpdated}

Called by the registry service when a session is updated. On first connection, this will be called as many times as needed to communicate the state of the world.

SessionsWatchers must reply to acknlowledge receipt of the session info delta. Delinquent watchers who do not reply will eventually be disconnected.

Request

Response

SessionRemoved {:#SessionRemoved}

Called by the registry service when a session is removed from the registered collection.

SessionsWatchers must reply to acknlowledge receipt of the session removal. Delinquent watchers who do not reply will eventually be disconnected.

Request

Response

Discovery {:#Discovery}

Defined in fuchsia.media.sessions2/discovery.fidl

Discovery observes the collection of published media sessions and connects clients to them.

WatchSessions {:#WatchSessions}

Connects a session watcher configured with the given options.

Request

ConnectToSession {:#ConnectToSession}

Connects to a SessionControl for session_id if present. Drops the given channel otherwise.

Request

PlayerControl {:#PlayerControl}

Defined in fuchsia.media.sessions2/player.fidl

Controls for a media player.

Play {:#Play}

Plays media.

Request

Pause {:#Pause}

Pauses playback and retains position in media

Request

Stop {:#Stop}

Stops playback. The session should close.

Request

Seek {:#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.

Request

SkipForward {:#SkipForward}

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

Request

SkipReverse {:#SkipReverse}

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

Request

NextItem {:#NextItem}

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

Request

PrevItem {:#PrevItem}

Changes media to the previous item.

Request

SetPlaybackRate {:#SetPlaybackRate}

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

Request

SetRepeatMode {:#SetRepeatMode}

Sets repeat mode to any of the supported repeat modes.

Request

SetShuffleMode {:#SetShuffleMode}

Sets shuffle mode.

Request

BindGainControl {:#BindGainControl}

Binds to the session's gain control for control and notifications.

Request

BindVolumeControl {:#BindVolumeControl}

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

Request

Player {:#Player}

Defined in fuchsia.media.sessions2/player.fidl

Player is a handle for a media player. Unsupported commands are no-ops. Consult PlaybackCapabilities, sent by to learn which commands are supported.

Play {:#Play}

Plays media.

Request

Pause {:#Pause}

Pauses playback and retains position in media

Request

Stop {:#Stop}

Stops playback. The session should close.

Request

Seek {:#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.

Request

SkipForward {:#SkipForward}

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

Request

SkipReverse {:#SkipReverse}

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

Request

NextItem {:#NextItem}

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

Request

PrevItem {:#PrevItem}

Changes media to the previous item.

Request

SetPlaybackRate {:#SetPlaybackRate}

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

Request

SetRepeatMode {:#SetRepeatMode}

Sets repeat mode to any of the supported repeat modes.

Request

SetShuffleMode {:#SetShuffleMode}

Sets shuffle mode.

Request

BindGainControl {:#BindGainControl}

Binds to the session's gain control for control and notifications.

Request

BindVolumeControl {:#BindVolumeControl}

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

Request

WatchInfoChange {:#WatchInfoChange}

Leave hanging to receive a response when the player's status changes.

Request

Response

Publisher {:#Publisher}

Defined in fuchsia.media.sessions2/publisher.fidl

Publisher publishes media players so they may be discovered and controlled by clients who have permission to do so.

PublishPlayer {:#PublishPlayer}

Request

SessionControl {:#SessionControl}

Defined in fuchsia.media.sessions2/discovery.fidl

A protocol for clients to control sessions and view their status.

Play {:#Play}

Plays media.

Request

Pause {:#Pause}

Pauses playback and retains position in media

Request

Stop {:#Stop}

Stops playback. The session should close.

Request

Seek {:#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.

Request

SkipForward {:#SkipForward}

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

Request

SkipReverse {:#SkipReverse}

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

Request

NextItem {:#NextItem}

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

Request

PrevItem {:#PrevItem}

Changes media to the previous item.

Request

SetPlaybackRate {:#SetPlaybackRate}

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

Request

SetRepeatMode {:#SetRepeatMode}

Sets repeat mode to any of the supported repeat modes.

Request

SetShuffleMode {:#SetShuffleMode}

Sets shuffle mode.

Request

BindGainControl {:#BindGainControl}

Binds to the session's gain control for control and notifications.

Request

BindVolumeControl {:#BindVolumeControl}

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

Request

SessionsWatcher {:#SessionsWatcher}

Defined in fuchsia.media.sessions2/discovery.fidl

SessionsWatcher watches the collection of published sessions.

SessionUpdated {:#SessionUpdated}

Called by the registry service when a session is updated. On first connection, this will be called as many times as needed to communicate the state of the world.

SessionsWatchers must reply to acknlowledge receipt of the session info delta. Delinquent watchers who do not reply will eventually be disconnected.

Request

Response

SessionRemoved {:#SessionRemoved}

Called by the registry service when a session is removed from the registered collection.

SessionsWatchers must reply to acknlowledge receipt of the session removal. Delinquent watchers who do not reply will eventually be disconnected.

Request

Response

Discovery {:#Discovery}

Defined in fuchsia.media.sessions2/discovery.fidl

Discovery observes the collection of published media sessions and connects clients to them.

WatchSessions {:#WatchSessions}

Connects a session watcher configured with the given options.

Request

ConnectToSession {:#ConnectToSession}

Connects to a SessionControl for session_id if present. Drops the given channel otherwise.

Request

PlayerControl {:#PlayerControl}

Defined in fuchsia.media.sessions2/player.fidl

Controls for a media player.

Play {:#Play}

Plays media.

Request

Pause {:#Pause}

Pauses playback and retains position in media

Request

Stop {:#Stop}

Stops playback. The session should close.

Request

Seek {:#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.

Request

SkipForward {:#SkipForward}

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

Request

SkipReverse {:#SkipReverse}

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

Request

NextItem {:#NextItem}

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

Request

PrevItem {:#PrevItem}

Changes media to the previous item.

Request

SetPlaybackRate {:#SetPlaybackRate}

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

Request

SetRepeatMode {:#SetRepeatMode}

Sets repeat mode to any of the supported repeat modes.

Request

SetShuffleMode {:#SetShuffleMode}

Sets shuffle mode.

Request

BindGainControl {:#BindGainControl}

Binds to the session's gain control for control and notifications.

Request

BindVolumeControl {:#BindVolumeControl}

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

Request

Player {:#Player}

Defined in fuchsia.media.sessions2/player.fidl

Player is a handle for a media player. Unsupported commands are no-ops. Consult PlaybackCapabilities, sent by to learn which commands are supported.

Play {:#Play}

Plays media.

Request

Pause {:#Pause}

Pauses playback and retains position in media

Request

Stop {:#Stop}

Stops playback. The session should close.

Request

Seek {:#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.

Request

SkipForward {:#SkipForward}

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

Request

SkipReverse {:#SkipReverse}

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

Request

NextItem {:#NextItem}

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

Request

PrevItem {:#PrevItem}

Changes media to the previous item.

Request

SetPlaybackRate {:#SetPlaybackRate}

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

Request

SetRepeatMode {:#SetRepeatMode}

Sets repeat mode to any of the supported repeat modes.

Request

SetShuffleMode {:#SetShuffleMode}

Sets shuffle mode.

Request

BindGainControl {:#BindGainControl}

Binds to the session's gain control for control and notifications.

Request

BindVolumeControl {:#BindVolumeControl}

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

Request

WatchInfoChange {:#WatchInfoChange}

Leave hanging to receive a response when the player's status changes.

Request

Response

Publisher {:#Publisher}

Defined in fuchsia.media.sessions2/publisher.fidl

Publisher publishes media players so they may be discovered and controlled by clients who have permission to do so.

PublishPlayer {:#PublishPlayer}

Request

STRUCTS

ImageSizeVariant {:#ImageSizeVariant}

Defined in fuchsia.media.sessions2/images.fidl

A variant of an image at a specific size.

ImageSizeVariant {:#ImageSizeVariant}

Defined in fuchsia.media.sessions2/images.fidl

A variant of an image at a specific size.

ENUMS

MediaImageType {:#MediaImageType}

Type: uint32

Defined in fuchsia.media.sessions2/images.fidl

ContentType {:#ContentType}

Type: uint32

Defined in fuchsia.media.sessions2/player.fidl

The type of content playing back, which should be set to the largest applicable value.

PlayerState {:#PlayerState}

Type: uint32

Defined in fuchsia.media.sessions2/player.fidl

State of a media player.

Error {:#Error}

Type: uint32

Defined in fuchsia.media.sessions2/player.fidl

RepeatMode {:#RepeatMode}

Type: uint32

Defined in fuchsia.media.sessions2/player.fidl

Modes of repeating playback of the current media.

MediaImageType {:#MediaImageType}

Type: uint32

Defined in fuchsia.media.sessions2/images.fidl

ContentType {:#ContentType}

Type: uint32

Defined in fuchsia.media.sessions2/player.fidl

The type of content playing back, which should be set to the largest applicable value.

PlayerState {:#PlayerState}

Type: uint32

Defined in fuchsia.media.sessions2/player.fidl

State of a media player.

Error {:#Error}

Type: uint32

Defined in fuchsia.media.sessions2/player.fidl

RepeatMode {:#RepeatMode}

Type: uint32

Defined in fuchsia.media.sessions2/player.fidl

Modes of repeating playback of the current media.

TABLES

SessionInfoDelta {:#SessionInfoDelta}

Defined in fuchsia.media.sessions2/discovery.fidl

SessionInfoDelta holds a description of a given session. The first time a client receives this, it is a state of the world. On successive receipts of this table, only the changed fields will be present (this property is not recursive; top-level fields if set are snapshots).

WatchOptions {:#WatchOptions}

Defined in fuchsia.media.sessions2/discovery.fidl

MediaImage {:#MediaImage}

Defined in fuchsia.media.sessions2/images.fidl

An image for playing media.

PlayerStatus {:#PlayerStatus}

Defined in fuchsia.media.sessions2/player.fidl

Status of a media player.

PlayerCapabilities {:#PlayerCapabilities}

Defined in fuchsia.media.sessions2/player.fidl

PlaybackCapabilities enumerates the capabilities of a media player, and corresponds to the control commands it can execute.

PlayerInfoDelta {:#PlayerInfoDelta}

Defined in fuchsia.media.sessions2/player.fidl

When emitted, fields that have changed should be set. The first emission to a new client should be a snapshot.

PlayerRegistration {:#PlayerRegistration}

Defined in fuchsia.media.sessions2/publisher.fidl

All information required by the media session registry service to register a player so that clients may observe its status and control it.

An image for playing media.

PlayerStatus {:#PlayerStatus}

Defined in fuchsia.media.sessions2/player.fidl

Status of a media player.

PlayerCapabilities {:#PlayerCapabilities}

Defined in fuchsia.media.sessions2/player.fidl

PlaybackCapabilities enumerates the capabilities of a media player, and corresponds to the control commands it can execute.

PlayerInfoDelta {:#PlayerInfoDelta}

Defined in fuchsia.media.sessions2/player.fidl

When emitted, fields that have changed should be set. The first emission to a new client should be a snapshot.

PlayerRegistration {:#PlayerRegistration}

Defined in fuchsia.media.sessions2/publisher.fidl

All information required by the media session registry service to register a player so that clients may observe its status and control it.