pillarbox-player/ch.srgssr.pillarbox.player.tracks

Package-level declarations

Types

AudioTrack

class AudioTrack(group: Tracks.Group, groupIndex: Int, trackIndexInGroup: Int) : Track

Represents an audio track within a media file.

TextTrack

class TextTrack(group: Tracks.Group, groupIndex: Int, trackIndexInGroup: Int) : Track

Represents a text track within a media file.

Track

sealed class Track

Represents a generic track within a media stream.

VideoTrack

class VideoTrack(group: Tracks.Group, groupIndex: Int, trackIndexInGroup: Int) : Track

Represents a video track within a media file.

Properties

audioTracks

val Tracks.audioTracks: List<AudioTrack>

Returns a list of supported audio tracks for the currently played MediaItem.

textTracks

val Tracks.textTracks: List<TextTrack>

Returns a list of supported text tracks for the currently played MediaItem.

tracks

val Tracks.tracks: List<Track>

Returns a list of supported tracks for the currently played MediaItem.

videoTracks

val Tracks.videoTracks: List<VideoTrack>

Returns a list of supported video tracks for the currently played MediaItem.

Functions

disableAudioTrack

fun Player.disableAudioTrack()

Disables the audio track.

disableTextTrack

fun Player.disableTextTrack()

Disables the text track.

disableVideoTrack

fun Player.disableVideoTrack()

Disables the video track.

enableAudioTrack

fun Player.enableAudioTrack()

Enables the audio track.

enableTextTrack

fun Player.enableTextTrack()

Enables the text track.

enableVideoTrack

fun Player.enableVideoTrack()

Enables the video track.

isPlaybackTypeLocal

fun Player.isPlaybackTypeLocal(): Boolean

return true if the player is DeviceInfo.PLAYBACK_TYPE_LOCAL.

isPlaybackTypeRemote

fun Player.isPlaybackTypeRemote(): Boolean

return true if the player is DeviceInfo.PLAYBACK_TYPE_REMOTE.

selectTrack

fun Player.selectTrack(track: Track)

Selects the provided track for playback.

setAutoAudioTrack

fun Player.setAutoAudioTrack(context: Context? = null)

Sets the track selection to automatically select the default audio track.

setAutoTextTrack

fun Player.setAutoTextTrack()

Sets the track selection to automatically select the default text track.

setAutoVideoTrack

fun Player.setAutoVideoTrack()

Sets the track selection to automatically select the default video track.