pillarbox-player/ch.srgssr.pillarbox.player/PillarboxExoPlayer

PillarboxExoPlayer

class PillarboxExoPlayer : PillarboxPlayer, ExoPlayer

Pillarbox player

Parameters

context

The context.

coroutineContext

The CoroutineContext.

exoPlayer

The underlying player.

monitoringMessageHandler

The class to handle each Monitoring message.

Properties

smoothSeekingEnabled

open override var smoothSeekingEnabled: Boolean

Smooth seeking enabled

trackingEnabled

open override var trackingEnabled: Boolean

Enable or disable analytics tracking for the current MediaItem.

Functions

addAnalyticsListener

open override fun addAnalyticsListener(p0: AnalyticsListener)

addAudioOffloadListener

@UnstableApi

open override fun addAudioOffloadListener(p0: ExoPlayer.AudioOffloadListener)

addListener

open override fun addListener(listener: Player.Listener)

addMediaItem

open override fun addMediaItem(p0: MediaItem)

open override fun addMediaItem(p0: Int, p1: MediaItem)

addMediaItems

open override fun addMediaItems(p0: MutableList<MediaItem>)

open override fun addMediaItems(p0: Int, p1: MutableList<MediaItem>)

addMediaSource

@UnstableApi

open override fun addMediaSource(p0: MediaSource)

@UnstableApi

open override fun addMediaSource(p0: Int, p1: MediaSource)

addMediaSources

@UnstableApi

open override fun addMediaSources(p0: MutableList<MediaSource>)

@UnstableApi

open override fun addMediaSources(p0: Int, p1: MutableList<MediaSource>)

availableCommandsAsFlow

fun Player.availableCommandsAsFlow(): Flow<Player.Commands>

Available commands Player.getAvailableCommands as Flow.

canAdvertiseSession

open override fun canAdvertiseSession(): Boolean

clearAuxEffectInfo

@UnstableApi

open override fun clearAuxEffectInfo()

clearCameraMotionListener

@UnstableApi

open override fun clearCameraMotionListener(p0: CameraMotionListener)

clearMediaItems

open override fun clearMediaItems()

clearVideoFrameMetadataListener

@UnstableApi

open override fun clearVideoFrameMetadataListener(p0: VideoFrameMetadataListener)

clearVideoSurface

open override fun clearVideoSurface()

open override fun clearVideoSurface(@Nullable p0: Surface?)

clearVideoSurfaceHolder

open override fun clearVideoSurfaceHolder(@Nullable p0: SurfaceHolder?)

clearVideoSurfaceView

open override fun clearVideoSurfaceView(@Nullable p0: SurfaceView?)

clearVideoTextureView

open override fun clearVideoTextureView(@Nullable p0: TextureView?)

createMessage

@UnstableApi

open override fun createMessage(p0: PlayerMessage.Target): PlayerMessage

currentBufferedPercentageAsFlow

fun Player.currentBufferedPercentageAsFlow(updateInterval: Duration = DefaultUpdateInterval): Flow<Float>

Current buffered percentage as flow Player.getBufferedPercentage

currentMediaItemAsFlow

fun Player.currentMediaItemAsFlow(): Flow<MediaItem?>

Current media metadata as flow Player.getCurrentMediaItem

currentMediaMetadataAsFlow

fun Player.currentMediaMetadataAsFlow(withPlaylistMediaMetadata: Boolean = false): Flow<MediaMetadata>

Current media metadata as flow Player.getMediaMetadata

currentMetricsAsFlow

fun PillarboxExoPlayer.currentMetricsAsFlow(): Flow<PlaybackMetrics?>

currentPositionAsFlow

fun Player.currentPositionAsFlow(updateInterval: Duration = DefaultUpdateInterval): Flow<Long>

Current position of the player updates every updateInterval when it is playing. Send current position once if not playing.

currentPositionPercentage

fun Player.currentPositionPercentage(): Float

Current position percent

decreaseDeviceVolume

open override fun ~~decreaseDeviceVolume~~()

open override fun decreaseDeviceVolume(p0: Int)

disableAudioTrack

fun Player.disableAudioTrack()

Disable the audio track.

disableTextTrack

fun Player.disableTextTrack()

Disable the text track.

disableVideoTrack

fun Player.disableVideoTrack()

Disable the video track.

durationAsFlow

fun Player.durationAsFlow(): Flow<Long>

Duration Player.getDuration as Flow.

enableAudioTrack

fun Player.enableAudioTrack()

Enable the audio track.

enableTextTrack

fun Player.enableTextTrack()

Enable the text track.

enableVideoTrack

fun Player.enableVideoTrack()

Enable the video track.

getAnalyticsCollector

@UnstableApi

open override fun getAnalyticsCollector(): AnalyticsCollector

getApplicationLooper

open override fun getApplicationLooper(): Looper

getAspectRatioAsFlow

fun Player.getAspectRatioAsFlow(defaultAspectRatio: Float): Flow<Float>

Get aspect ratio of the current video as Flow.

getAudioAttributes

open override fun getAudioAttributes(): AudioAttributes

getAudioComponent

@UnstableApi

@Nullable

open override fun ~~getAudioComponent~~(): ExoPlayer.AudioComponent?

getAudioDecoderCounters

@UnstableApi

@Nullable

open override fun getAudioDecoderCounters(): DecoderCounters?

getAudioFormat

@UnstableApi

@Nullable

open override fun getAudioFormat(): Format?

getAudioSessionId

@UnstableApi

open override fun getAudioSessionId(): Int

getAvailableCommands

open override fun getAvailableCommands(): Player.Commands

getBlockedTimeRangeOrNull

fun getBlockedTimeRangeOrNull(): List<BlockedTimeRange>?

getBufferedPercentage

@IntRange(from = 0, to = 100)

open override fun getBufferedPercentage(): Int

getBufferedPosition

open override fun getBufferedPosition(): Long

getChapterAtPosition

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

Get the chapter at position.

getClock

@UnstableApi

open override fun getClock(): Clock

getContentBufferedPosition

open override fun getContentBufferedPosition(): Long

getContentDuration

open override fun getContentDuration(): Long

getContentPosition

open override fun getContentPosition(): Long

getCreditAtPosition

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

Get the credit at position.

getCurrentAdGroupIndex

open override fun getCurrentAdGroupIndex(): Int

getCurrentAdIndexInAdGroup

open override fun getCurrentAdIndexInAdGroup(): Int

getCurrentChapterAsFlow

fun Player.getCurrentChapterAsFlow(): Flow<Chapter?>

getCurrentChapters

fun Player.getCurrentChapters(): List<Chapter>

getCurrentCreditAsFlow

fun Player.getCurrentCreditAsFlow(): Flow<Credit?>

getCurrentCredits

fun Player.getCurrentCredits(): List<Credit>

getCurrentCues

open override fun getCurrentCues(): CueGroup

getCurrentDefaultPositionAsFlow

fun Player.getCurrentDefaultPositionAsFlow(): Flow<Long>

getCurrentLiveOffset

open override fun getCurrentLiveOffset(): Long

getCurrentManifest

@UnstableApi

@Nullable

open override fun getCurrentManifest(): Any?

getCurrentMediaItem

@Nullable

open override fun getCurrentMediaItem(): MediaItem?

getCurrentMediaItemIndex

open override fun getCurrentMediaItemIndex(): Int

getCurrentMediaItemIndexAsFlow

fun Player.getCurrentMediaItemIndexAsFlow(): Flow<Int>

Get current media item index as flow Player.getCurrentMediaItemIndex

getCurrentMediaItems

fun Player.getCurrentMediaItems(): List<MediaItem>

Get a snapshot of the current media items

getCurrentMediaItemsAsFlow

fun Player.getCurrentMediaItemsAsFlow(): Flow<List<MediaItem>>

Get current media items as flow Player.getCurrentMediaItems

getCurrentMetrics

fun getCurrentMetrics(): PlaybackMetrics?

Get current metrics

getCurrentPeriodIndex

open override fun getCurrentPeriodIndex(): Int

getCurrentPlaybackSessionId

fun getCurrentPlaybackSessionId(): String?

getCurrentPosition

open override fun getCurrentPosition(): Long

getCurrentTimeline

open override fun getCurrentTimeline(): Timeline

getCurrentTrackGroups

@UnstableApi

open override fun ~~getCurrentTrackGroups~~(): TrackGroupArray

getCurrentTracks

open override fun getCurrentTracks(): Tracks

getCurrentTracksAsFlow

fun Player.getCurrentTracksAsFlow(): Flow<Tracks>

Get current tracks as flow Player.getCurrentTracks

getCurrentTrackSelections

@UnstableApi

open override fun ~~getCurrentTrackSelections~~(): TrackSelectionArray

getCurrentWindowIndex

@UnstableApi

open override fun ~~getCurrentWindowIndex~~(): Int

getDeviceComponent

@UnstableApi

@Nullable

open override fun ~~getDeviceComponent~~(): ExoPlayer.DeviceComponent?

getDeviceInfo

open override fun getDeviceInfo(): DeviceInfo

getDeviceVolume

@IntRange(from = 0)

open override fun getDeviceVolume(): Int

getDuration

open override fun getDuration(): Long

getMaxSeekToPreviousPosition

open override fun getMaxSeekToPreviousPosition(): Long

getMediaItemAt

open override fun getMediaItemAt(p0: Int): MediaItem

getMediaItemCount

open override fun getMediaItemCount(): Int

getMediaItemTrackerDataOrNull

fun getMediaItemTrackerDataOrNull(): MediaItemTrackerData?

getMediaMetadata

open override fun getMediaMetadata(): MediaMetadata

getMetricsFor

fun getMetricsFor(index: Int): PlaybackMetrics?

Get metrics for item index

getNextMediaItemIndex

open override fun getNextMediaItemIndex(): Int

getNextWindowIndex

@UnstableApi

open override fun ~~getNextWindowIndex~~(): Int

getPauseAtEndOfMediaItems

@UnstableApi

open override fun getPauseAtEndOfMediaItems(): Boolean

getPlaybackLooper

@UnstableApi

open override fun getPlaybackLooper(): Looper

getPlaybackParameters

open override fun getPlaybackParameters(): PlaybackParameters

getPlaybackSpeed

fun Player.getPlaybackSpeed(): Float

Get playback speed

getPlaybackSpeedAsFlow

fun Player.getPlaybackSpeedAsFlow(): Flow<Float>

Playback speed Player.getPlaybackSpeed as Flow.

getPlaybackState

open override fun getPlaybackState(): Int

getPlaybackSuppressionReason

open override fun getPlaybackSuppressionReason(): Int

getPlayerError

@Nullable

open override fun getPlayerError(): ExoPlaybackException?

getPlaylistMetadata

open override fun getPlaylistMetadata(): MediaMetadata

getPlayWhenReady

open override fun getPlayWhenReady(): Boolean

getPreloadConfiguration

@UnstableApi

open override fun getPreloadConfiguration(): ExoPlayer.PreloadConfiguration

getPreviousMediaItemIndex

open override fun getPreviousMediaItemIndex(): Int

getPreviousWindowIndex

@UnstableApi

open override fun ~~getPreviousWindowIndex~~(): Int

getRenderer

@UnstableApi

open override fun getRenderer(p0: Int): Renderer

getRendererCount

@UnstableApi

open override fun getRendererCount(): Int

getRendererType

@UnstableApi

open override fun getRendererType(p0: Int): Int

getRepeatMode

open override fun getRepeatMode(): Int

getSeekBackIncrement

open override fun getSeekBackIncrement(): Long

getSeekForwardIncrement

open override fun getSeekForwardIncrement(): Long

getSeekParameters

@UnstableApi

open override fun getSeekParameters(): SeekParameters

getShuffleModeEnabled

open override fun getShuffleModeEnabled(): Boolean

getSkipSilenceEnabled

@UnstableApi

open override fun getSkipSilenceEnabled(): Boolean

getSurfaceSize

@UnstableApi

open override fun getSurfaceSize(): Size

getTextComponent

@UnstableApi

@Nullable

open override fun ~~getTextComponent~~(): ExoPlayer.TextComponent?

getTotalBufferedDuration

open override fun getTotalBufferedDuration(): Long

getTrackSelectionParameters

open override fun getTrackSelectionParameters(): TrackSelectionParameters

getTrackSelectionParametersAsFlow

fun Player.getTrackSelectionParametersAsFlow(): Flow<TrackSelectionParameters>

Get track selection parameters as flow Player.getTrackSelectionParameters

getTrackSelector

@UnstableApi

@Nullable

open override fun getTrackSelector(): TrackSelector?

getVideoChangeFrameRateStrategy

@UnstableApi

open override fun getVideoChangeFrameRateStrategy(): Int

getVideoComponent

@UnstableApi

@Nullable

open override fun ~~getVideoComponent~~(): ExoPlayer.VideoComponent?

getVideoDecoderCounters

@UnstableApi

@Nullable

open override fun getVideoDecoderCounters(): DecoderCounters?

getVideoFormat

@UnstableApi

@Nullable

open override fun getVideoFormat(): Format?

getVideoScalingMode

@UnstableApi

open override fun getVideoScalingMode(): Int

getVideoSize

open override fun getVideoSize(): VideoSize

getVolume

@FloatRange(from = 0.0, to = 1.0)

open override fun getVolume(): Float

hasNext

@UnstableApi

open operator override fun ~~hasNext~~(): Boolean

hasNextMediaItem

open override fun hasNextMediaItem(): Boolean

hasNextWindow

@UnstableApi

open override fun ~~hasNextWindow~~(): Boolean

hasPrevious

@UnstableApi

open override fun ~~hasPrevious~~(): Boolean

hasPreviousMediaItem

open override fun hasPreviousMediaItem(): Boolean

hasPreviousWindow

@UnstableApi

open override fun ~~hasPreviousWindow~~(): Boolean

increaseDeviceVolume

open override fun ~~increaseDeviceVolume~~()

open override fun increaseDeviceVolume(p0: Int)

isAtLiveEdge

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

Is at live edge

isCommandAvailable

open override fun isCommandAvailable(p0: Int): Boolean

isCurrentMediaItemDynamic

open override fun isCurrentMediaItemDynamic(): Boolean

isCurrentMediaItemLive

open override fun isCurrentMediaItemLive(): Boolean

isCurrentMediaItemLiveAsFlow

fun Player.isCurrentMediaItemLiveAsFlow(): Flow<Boolean>

isCurrentMediaItemSeekable

open override fun isCurrentMediaItemSeekable(): Boolean

isCurrentWindowDynamic

@UnstableApi

open override fun ~~isCurrentWindowDynamic~~(): Boolean

isCurrentWindowLive

@UnstableApi

open override fun ~~isCurrentWindowLive~~(): Boolean

isCurrentWindowSeekable

@UnstableApi

open override fun ~~isCurrentWindowSeekable~~(): Boolean

isDeviceMuted

open override fun isDeviceMuted(): Boolean

isLoading

open override fun isLoading(): Boolean

isPlaybackSpeedPossibleAtPosition

fun Player.isPlaybackSpeedPossibleAtPosition(position: Long, speed: Float, window: Timeline.Window = Window()): Boolean

Return if the playback speed is possible at position. Always return true for none live content or if Player.getCurrentTimeline is empty.

isPlaying

open override fun isPlaying(): Boolean

isPlayingAd

open override fun isPlayingAd(): Boolean

isPlayingAsFlow

fun Player.isPlayingAsFlow(): Flow<Boolean>

Is playing Player.isPlaying as Flow.

isReleased

@UnstableApi

open override fun isReleased(): Boolean

isSleepingForOffload

@UnstableApi

open override fun isSleepingForOffload(): Boolean

isTunnelingEnabled

@UnstableApi

open override fun isTunnelingEnabled(): Boolean

mediaItemCountAsFlow

fun Player.mediaItemCountAsFlow(): Flow<Int>

Media item count Player.getMediaItemCount as Flow.

moveMediaItem

open override fun moveMediaItem(p0: Int, p1: Int)

moveMediaItems

open override fun moveMediaItems(p0: Int, p1: Int, p2: Int)

@UnstableApi

open operator override fun ~~next~~()

pause

open override fun pause()

play

open override fun play()

playbackStateAsFlow

fun Player.playbackStateAsFlow(): Flow<Int>

Playback state Player.getPlaybackState as flow.

playerErrorAsFlow

fun Player.playerErrorAsFlow(): Flow<PlaybackException?>

PlayerError Player.getPlayerError as Flow.

playWhenReadyAsFlow

fun Player.playWhenReadyAsFlow(): Flow<Boolean>

Play when ready as flow Player.getPlayWhenReady

prepare

open override fun prepare()

@UnstableApi

open override fun ~~prepare~~(p0: MediaSource)

@UnstableApi

open override fun ~~prepare~~(p0: MediaSource, p1: Boolean, p2: Boolean)

@UnstableApi

open override fun ~~previous~~()

release

open override fun release()

Releases the player. This method must be called when the player is no longer required. The player must not be used after calling this method.

removeAnalyticsListener

open override fun removeAnalyticsListener(p0: AnalyticsListener)

removeAudioOffloadListener

@UnstableApi

open override fun removeAudioOffloadListener(p0: ExoPlayer.AudioOffloadListener)

removeListener

open override fun removeListener(listener: Player.Listener)

removeMediaItem

open override fun removeMediaItem(p0: Int)

removeMediaItems

open override fun removeMediaItems(p0: Int, p1: Int)

replaceMediaItem

open override fun replaceMediaItem(p0: Int, p1: MediaItem)

replaceMediaItems

open override fun replaceMediaItems(p0: Int, p1: Int, p2: MutableList<MediaItem>)

runOnApplicationLooper

fun Player.runOnApplicationLooper(task: () -> Unit)

Run the task in the same thread as Player.getApplicationLooper if it is necessary.

seekBack

open override fun seekBack()

seekForward

open override fun seekForward()

seekTo

open override fun seekTo(positionMs: Long)

open override fun seekTo(mediaItemIndex: Int, positionMs: Long)

seekToDefaultPosition

open override fun seekToDefaultPosition()

open override fun seekToDefaultPosition(mediaItemIndex: Int)

seekToNext

open override fun seekToNext()

seekToNextMediaItem

open override fun seekToNextMediaItem()

seekToNextWindow

@UnstableApi

open override fun ~~seekToNextWindow~~()

seekToPrevious

open override fun seekToPrevious()

seekToPreviousMediaItem

open override fun seekToPreviousMediaItem()

seekToPreviousWindow

@UnstableApi

open override fun ~~seekToPreviousWindow~~()

selectTrack

fun Player.selectTrack(track: Track)

Select the provided track.

setAudioAttributes

open override fun setAudioAttributes(p0: AudioAttributes, p1: Boolean)

setAudioSessionId

@UnstableApi

open override fun setAudioSessionId(p0: Int)

setAutoAudioTrack

fun Player.setAutoAudioTrack(context: Context)

Restore the default audio track.

setAutoTextTrack

fun Player.setAutoTextTrack(context: Context)

Restore the default text track.

setAutoVideoTrack

fun Player.setAutoVideoTrack()

Restore the default video track.

setAuxEffectInfo

@UnstableApi

open override fun setAuxEffectInfo(p0: AuxEffectInfo)

setCameraMotionListener

@UnstableApi

open override fun setCameraMotionListener(p0: CameraMotionListener)

setDeviceMuted

open override fun ~~setDeviceMuted~~(p0: Boolean)

open override fun setDeviceMuted(p0: Boolean, p1: Int)

setDeviceVolume

open override fun ~~setDeviceVolume~~(@IntRange(from = 0) p0: Int)

open override fun setDeviceVolume(@IntRange(from = 0) p0: Int, p1: Int)

setForegroundMode

@UnstableApi

open override fun setForegroundMode(p0: Boolean)

setHandleAudioBecomingNoisy

open override fun setHandleAudioBecomingNoisy(p0: Boolean)

setHandleAudioFocus

fun Player.setHandleAudioFocus(handleAudioFocus: Boolean)

Handle audio focus with the currently set AudioAttributes.

setImageOutput

@UnstableApi

open override fun setImageOutput(@Nullable p0: ImageOutput?)

setMediaItem

open override fun setMediaItem(p0: MediaItem)

open override fun setMediaItem(p0: MediaItem, p1: Boolean)

open override fun setMediaItem(p0: MediaItem, p1: Long)

setMediaItems

open override fun setMediaItems(p0: MutableList<MediaItem>)

open override fun setMediaItems(p0: MutableList<MediaItem>, p1: Boolean)

open override fun setMediaItems(p0: MutableList<MediaItem>, p1: Int, p2: Long)

setMediaSource

@UnstableApi

open override fun setMediaSource(p0: MediaSource)

@UnstableApi

open override fun setMediaSource(p0: MediaSource, p1: Boolean)

@UnstableApi

open override fun setMediaSource(p0: MediaSource, p1: Long)

setMediaSources

@UnstableApi

open override fun setMediaSources(p0: MutableList<MediaSource>)

@UnstableApi

open override fun setMediaSources(p0: MutableList<MediaSource>, p1: Boolean)

@UnstableApi

open override fun setMediaSources(p0: MutableList<MediaSource>, p1: Int, p2: Long)

setPauseAtEndOfMediaItems

@UnstableApi

open override fun setPauseAtEndOfMediaItems(p0: Boolean)

setPlaybackParameters

open override fun setPlaybackParameters(playbackParameters: PlaybackParameters)

setPlaybackSpeed

open override fun setPlaybackSpeed(speed: Float)

setPlaylistMetadata

open override fun setPlaylistMetadata(p0: MediaMetadata)

setPlayWhenReady

open override fun setPlayWhenReady(p0: Boolean)

setPreferredAudioDevice

@UnstableApi

@RequiresApi(value = 23)

open override fun setPreferredAudioDevice(@Nullable p0: AudioDeviceInfo?)

setPreloadConfiguration

@UnstableApi

open override fun setPreloadConfiguration(p0: ExoPlayer.PreloadConfiguration)

setPriority

@UnstableApi

open override fun setPriority(p0: Int)

setPriorityTaskManager

@UnstableApi

open override fun setPriorityTaskManager(@Nullable p0: PriorityTaskManager?)

setRepeatMode

open override fun setRepeatMode(p0: Int)

setSeekParameters

@UnstableApi

open override fun setSeekParameters(@Nullable p0: SeekParameters?)

setShuffleModeEnabled

open override fun setShuffleModeEnabled(p0: Boolean)

setShuffleOrder

@UnstableApi

open override fun setShuffleOrder(p0: ShuffleOrder)

setSkipSilenceEnabled

@UnstableApi

open override fun setSkipSilenceEnabled(p0: Boolean)

setTrackOverride

fun Player.setTrackOverride(override: TrackSelectionOverride)

Set track override.

setTrackSelectionParameters

open override fun setTrackSelectionParameters(p0: TrackSelectionParameters)

setVideoChangeFrameRateStrategy

@UnstableApi

open override fun setVideoChangeFrameRateStrategy(p0: Int)

setVideoEffects

@UnstableApi

open override fun setVideoEffects(p0: MutableList<Effect>)

setVideoFrameMetadataListener

@UnstableApi

open override fun setVideoFrameMetadataListener(p0: VideoFrameMetadataListener)

setVideoScalingMode

@UnstableApi

open override fun setVideoScalingMode(p0: Int)

setVideoSurface

open override fun setVideoSurface(@Nullable p0: Surface?)

setVideoSurfaceHolder

open override fun setVideoSurfaceHolder(@Nullable p0: SurfaceHolder?)

setVideoSurfaceView

open override fun setVideoSurfaceView(@Nullable p0: SurfaceView?)

setVideoTextureView

open override fun setVideoTextureView(@Nullable p0: TextureView?)

setVolume

open override fun setVolume(@FloatRange(from = 0.0, to = 1.0) p0: Float)

setWakeMode

open override fun setWakeMode(p0: Int)

shuffleModeEnabledAsFlow

fun Player.shuffleModeEnabledAsFlow(): Flow<Boolean>

Shuffle mode enabled Player.getShuffleModeEnabled as Flow.

stop

open override fun stop()

tickerWhilePlayingAsFlow

fun Player.tickerWhilePlayingAsFlow(interval: Duration = DefaultUpdateInterval): Flow<Unit>

Ticker emits event every interval when Player.isPlaying is true. Emit a value once at least once.

videoSizeAsFlow

fun Player.videoSizeAsFlow(): Flow<VideoSize>

Get video size as flow Player.getVideoSize