pillarbox-player/ch.srgssr.pillarbox.player.extension

Package-level declarations

Properties

chapters

val MediaMetadata.chapters: List<Chapter>?

Chapters

credits

val MediaMetadata.credits: List<Credit>?

Credits

displayName

val Format.displayName: String

Display name

isAudioTrackDisabled

val TrackSelectionParameters.isAudioTrackDisabled: Boolean

Is audio track disabled

isTextTrackDisabled

val TrackSelectionParameters.isTextTrackDisabled: Boolean

Is text track disabled

isVideoTrackDisabled

val TrackSelectionParameters.isVideoTrackDisabled: Boolean

Is video track disabled

RATIONAL_ONE

val RATIONAL_ONE: Rational

Rational One with a Rationale set to 1/1.

videoSize

val Format.videoSize: VideoSize

Video size of the format. VideoSize.UNKNOWN if no video size provided.

Functions

canGetTracks

fun Player.Commands.canGetTracks(): Boolean

Can get details of the current track selection.

canPlayPause

fun Player.Commands.canPlayPause(): Boolean

Can start, pause or resume playback.

canSeek

fun Player.Commands.canSeek(): Boolean

Can seek anywhere into the current MediaItem.

canSeekBack

fun Player.Commands.canSeekBack(): Boolean

Can seek back by a fixed increment into the current MediaItem.

canSeekForward

fun Player.Commands.canSeekForward(): Boolean

Can seek back by a fixed increment into the current MediaItem.

canSeekToNext

fun Player.Commands.canSeekToNext(): Boolean

Can seek to a later position in the current or next MediaItem.

canSeekToPrevious

fun Player.Commands.canSeekToPrevious(): Boolean

Can seek to an earlier position in the current or previous MediaItem.

canSetTrackSelectionParameters

fun Player.Commands.canSetTrackSelectionParameters(): Boolean

set the player's track selection parameters.

canSpeedAndPitch

fun Player.Commands.canSpeedAndPitch(): Boolean

Can set the playback speed and pitch.

computeAspectRatioOrNull

fun VideoSize.computeAspectRatioOrNull(): Float?

Compute the aspect ratio, return null if the aspect ratio can't be computed.

currentPositionPercentage

fun Player.currentPositionPercentage(): Float

Current position percent

defaultAudioTrack

fun TrackSelectionParameters.defaultAudioTrack(context: Context): TrackSelectionParameters

Default audio track parameters.

defaultTextTrack

fun TrackSelectionParameters.defaultTextTrack(context: Context): TrackSelectionParameters

Default text track parameters.

defaultVideoTrack

fun TrackSelectionParameters.defaultVideoTrack(): TrackSelectionParameters

Default video track parameters.

disableAudioTrack

fun TrackSelectionParameters.disableAudioTrack(): TrackSelectionParameters

Disable audio track

disableTextTrack

fun TrackSelectionParameters.disableTextTrack(): TrackSelectionParameters

Disable text track

disableVideoTrack

fun TrackSelectionParameters.disableVideoTrack(): TrackSelectionParameters

Disable video track

enableAudioTrack

fun TrackSelectionParameters.enableAudioTrack(): TrackSelectionParameters

Enable audio track.

enableTextTrack

fun TrackSelectionParameters.enableTextTrack(): TrackSelectionParameters

Enable text track.

enableVideoTrack

fun TrackSelectionParameters.enableVideoTrack(): TrackSelectionParameters

Enable video track.

getBlockedTimeRangeOrNull

fun Tracks.getBlockedTimeRangeOrNull(): List<BlockedTimeRange>?

getChapterAtPosition

fun Player.getChapterAtPosition(positionMs: Long = currentPosition): Chapter?

Get the chapter at position.

getCreditAtPosition

fun Player.getCreditAtPosition(positionMs: Long = currentPosition): Credit?

Get the credit at position.

getCurrentChapters

fun Player.getCurrentChapters(): List<Chapter>

getCurrentCredits

fun Player.getCurrentCredits(): List<Credit>

getCurrentMediaItems

fun Player.getCurrentMediaItems(): List<MediaItem>

Get a snapshot of the current media items

getLocale

fun Format.getLocale(): Locale?

Returns a locale for the specified IETF BCP 47 Format.language tag string.

getMediaItemTrackerDataOrNull

fun Tracks.getMediaItemTrackerDataOrNull(): MediaItemTrackerData?

getOverridesForTrackType

fun TrackSelectionParameters.getOverridesForTrackType(trackType: @C.TrackType Int): Map<TrackGroup, TrackSelectionOverride>

Get overrides for track type

getPlaybackSpeed

fun Player.getPlaybackSpeed(): Float

Get playback speed

hasAccessibilityRoles

fun Format.hasAccessibilityRoles(): Boolean

Has accessibility roles

hasRole

fun Format.hasRole(role: @C.RoleFlags Int): Boolean

Check if Format.roleFlags contains role

hasSelection

fun Format.hasSelection(selection: @C.SelectionFlags Int): Boolean

Check if Format.selectionFlags contains selection

hasTrackOverride

fun TrackSelectionParameters.hasTrackOverride(trackType: @C.TrackType Int): Boolean

Has track override

isAtLiveEdge

fun Player.isAtLiveEdge(positionMs: Long = currentPosition, window: Timeline.Window = Window()): Boolean

Is at live edge

isForced

fun Format.isForced(): Boolean

Is forced

roleString

fun Format.roleString(): String

Role flags as string

selectionString

fun Format.selectionString(): String

Selection flags as string

setChapters

fun MediaMetadata.Builder.setChapters(chapters: List<Chapter>): MediaMetadata.Builder

Sets the MediaMetadata.chapters. Calling MediaMetadata.Builder.setExtras after will reset this call.

setCredits

fun MediaMetadata.Builder.setCredits(credits: List<Credit>): MediaMetadata.Builder

Sets the MediaMetadata.credits Calling MediaMetadata.Builder.setExtras after will reset this call.

setHandleAudioFocus

fun Player.setHandleAudioFocus(handleAudioFocus: Boolean)

Handle audio focus with the currently set AudioAttributes.

setPreferredAudioRoleFlagsToAccessibilityManagerSettings

fun TrackSelectionParameters.Builder.setPreferredAudioRoleFlagsToAccessibilityManagerSettings(context: Context): TrackSelectionParameters.Builder

Set preferred audio role flags to accessibility manager settings.

setTrackOverride

fun Player.setTrackOverride(override: TrackSelectionOverride)

Set track override.

fun TrackSelectionParameters.setTrackOverride(override: TrackSelectionOverride): TrackSelectionParameters

Set track selection override

toRational

fun VideoSize.toRational(): Rational

Convert VideoSize to Rational that is useful for picture in picture