MediaPlaybackTrait.Attributes

interface MediaPlaybackTrait.Attributes

Known direct subclasses
MediaPlayback

API for the MediaPlayback trait.

Attributes for the MediaPlayback cluster.

Summary

Public properties
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
MediaPlaybackTrait.TrackStruct?
MediaPlaybackTrait.TrackStruct?
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
List<MediaPlaybackTrait.TrackStruct>?
List<MediaPlaybackTrait.TrackStruct>?
UShort

The revision of the server cluster specification supported by the cluster instance.
MediaPlaybackTrait.PlaybackStateEnum?

The current playback state of media.
ULong?

The duration, in milliseconds, of the media currently being played back.
MediaPlaybackTrait.Feature

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
Float?

The speed at which the current media is being played.
MediaPlaybackTrait.PlaybackPositionStruct?

The position of playback as of the specified time.
ULong?

The furthest forward valid position to which a client may seek, in milliseconds, relative to the start of the media.
ULong?

The earliest valid position to which a client may seek, in milliseconds, relative to the start of the media.
ULong?

The start time of the media, such as a livestream event, in UTC (ISO-8601) format.

Public properties

acceptedCommandList

val acceptedCommandList: List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

activeAudioTrack

val activeAudioTrack: MediaPlaybackTrait.TrackStruct?

activeTextTrack

val activeTextTrack: MediaPlaybackTrait.TrackStruct?

attributeList

val attributeList: List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

availableAudioTracks

val availableAudioTracks: List<MediaPlaybackTrait.TrackStruct>?

availableTextTracks

val availableTextTracks: List<MediaPlaybackTrait.TrackStruct>?

clusterRevision

val clusterRevision: UShort

The revision of the server cluster specification supported by the cluster instance.

currentState

val currentState: MediaPlaybackTrait.PlaybackStateEnum?

The current playback state of media.

Access type: Read

duration

val duration: ULong?

The duration, in milliseconds, of the media currently being played back. If no media is currently being played, this is null.

Access type: Read

featureMap

val featureMap: MediaPlaybackTrait.Feature

Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).

generatedCommandList

val generatedCommandList: List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

playbackSpeed

val playbackSpeed: Float?

The speed at which the current media is being played.

Access type: Read

sampledPosition

val sampledPosition: MediaPlaybackTrait.PlaybackPositionStruct?

The position of playback as of the specified time.

Access type: Read

seekRangeEnd

val seekRangeEnd: ULong?

The furthest forward valid position to which a client may seek, in milliseconds, relative to the start of the media.

Access type: Read

seekRangeStart

val seekRangeStart: ULong?

The earliest valid position to which a client may seek, in milliseconds, relative to the start of the media.

Access type: Read

startTime

val startTime: ULong?

The start time of the media, such as a livestream event, in UTC (ISO-8601) format. This is null when the start time doesn't apply to the current media, such as in the case of prerecorded material.

Access type: Read