pillarbox-player/ch.srgssr.pillarbox.player/PillarboxPlayer

PillarboxPlayer

interface PillarboxPlayer : Player

Pillarbox Player interface extension.

Inheritors

PillarboxExoPlayer

PillarboxMediaController

Types

Companion

object Companion

Listener

interface Listener : Player.Listener

Listener

Properties

smoothSeekingEnabled

abstract var smoothSeekingEnabled: Boolean

Smooth seeking enabled

trackingEnabled

abstract var trackingEnabled: Boolean

Enable or disable MediaItem tracking

Functions

addListener

abstract fun addListener(p0: Player.Listener)

addMediaItem

abstract fun addMediaItem(p0: MediaItem)

abstract fun addMediaItem(p0: Int, p1: MediaItem)

addMediaItems

abstract fun addMediaItems(p0: MutableList<MediaItem>)

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

availableCommandsAsFlow

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

Available commands Player.getAvailableCommands as Flow.

canAdvertiseSession

abstract fun canAdvertiseSession(): Boolean

clearMediaItems

abstract fun clearMediaItems()

clearVideoSurface

abstract fun clearVideoSurface()

abstract fun clearVideoSurface(@Nullable p0: Surface?)

clearVideoSurfaceHolder

abstract fun clearVideoSurfaceHolder(@Nullable p0: SurfaceHolder?)

clearVideoSurfaceView

abstract fun clearVideoSurfaceView(@Nullable p0: SurfaceView?)

clearVideoTextureView

abstract fun clearVideoTextureView(@Nullable p0: TextureView?)

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

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

abstract fun ~~decreaseDeviceVolume~~()

abstract 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.

getApplicationLooper

abstract fun getApplicationLooper(): Looper

getAspectRatioAsFlow

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

Get aspect ratio of the current video as Flow.

getAudioAttributes

abstract fun getAudioAttributes(): AudioAttributes

getAvailableCommands

abstract fun getAvailableCommands(): Player.Commands

getBufferedPercentage

@IntRange(from = 0, to = 100)

abstract fun getBufferedPercentage(): Int

getBufferedPosition

abstract fun getBufferedPosition(): Long

getChapterAtPosition

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

Get the chapter at position.

getContentBufferedPosition

abstract fun getContentBufferedPosition(): Long

getContentDuration

abstract fun getContentDuration(): Long

getContentPosition

abstract fun getContentPosition(): Long

getCreditAtPosition

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

Get the credit at position.

getCurrentAdGroupIndex

abstract fun getCurrentAdGroupIndex(): Int

getCurrentAdIndexInAdGroup

abstract 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

abstract fun getCurrentCues(): CueGroup

getCurrentDefaultPositionAsFlow

fun Player.getCurrentDefaultPositionAsFlow(): Flow<Long>

getCurrentLiveOffset

abstract fun getCurrentLiveOffset(): Long

getCurrentManifest

@UnstableApi

@Nullable

abstract fun getCurrentManifest(): Any?

getCurrentMediaItem

@Nullable

abstract fun getCurrentMediaItem(): MediaItem?

getCurrentMediaItemIndex

abstract 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

getCurrentPeriodIndex

abstract fun getCurrentPeriodIndex(): Int

getCurrentPosition

abstract fun getCurrentPosition(): Long

getCurrentTimeline

abstract fun getCurrentTimeline(): Timeline

getCurrentTracks

abstract fun getCurrentTracks(): Tracks

getCurrentTracksAsFlow

fun Player.getCurrentTracksAsFlow(): Flow<Tracks>

Get current tracks as flow Player.getCurrentTracks

getCurrentWindowIndex

@UnstableApi

abstract fun ~~getCurrentWindowIndex~~(): Int

getDeviceInfo

abstract fun getDeviceInfo(): DeviceInfo

getDeviceVolume

@IntRange(from = 0)

abstract fun getDeviceVolume(): Int

getDuration

abstract fun getDuration(): Long

getMaxSeekToPreviousPosition

abstract fun getMaxSeekToPreviousPosition(): Long

getMediaItemAt

abstract fun getMediaItemAt(p0: Int): MediaItem

getMediaItemCount

abstract fun getMediaItemCount(): Int

getMediaMetadata

abstract fun getMediaMetadata(): MediaMetadata

getNextMediaItemIndex

abstract fun getNextMediaItemIndex(): Int

getNextWindowIndex

@UnstableApi

abstract fun ~~getNextWindowIndex~~(): Int

getPlaybackParameters

abstract fun getPlaybackParameters(): PlaybackParameters

getPlaybackSpeed

fun Player.getPlaybackSpeed(): Float

Get playback speed

getPlaybackSpeedAsFlow

fun Player.getPlaybackSpeedAsFlow(): Flow<Float>

Playback speed Player.getPlaybackSpeed as Flow.

getPlaybackState

abstract fun getPlaybackState(): Int

getPlaybackSuppressionReason

abstract fun getPlaybackSuppressionReason(): Int

getPlayerError

@Nullable

abstract fun getPlayerError(): PlaybackException?

getPlaylistMetadata

abstract fun getPlaylistMetadata(): MediaMetadata

getPlayWhenReady

abstract fun getPlayWhenReady(): Boolean

getPreviousMediaItemIndex

abstract fun getPreviousMediaItemIndex(): Int

getPreviousWindowIndex

@UnstableApi

abstract fun ~~getPreviousWindowIndex~~(): Int

getRepeatMode

abstract fun getRepeatMode(): Int

getSeekBackIncrement

abstract fun getSeekBackIncrement(): Long

getSeekForwardIncrement

abstract fun getSeekForwardIncrement(): Long

getShuffleModeEnabled

abstract fun getShuffleModeEnabled(): Boolean

getSurfaceSize

@UnstableApi

abstract fun getSurfaceSize(): Size

getTotalBufferedDuration

abstract fun getTotalBufferedDuration(): Long

getTrackSelectionParameters

abstract fun getTrackSelectionParameters(): TrackSelectionParameters

getTrackSelectionParametersAsFlow

fun Player.getTrackSelectionParametersAsFlow(): Flow<TrackSelectionParameters>

Get track selection parameters as flow Player.getTrackSelectionParameters

getVideoSize

abstract fun getVideoSize(): VideoSize

getVolume

@FloatRange(from = 0.0, to = 1.0)

abstract fun getVolume(): Float

hasNext

@UnstableApi

abstract operator fun ~~hasNext~~(): Boolean

hasNextMediaItem

abstract fun hasNextMediaItem(): Boolean

hasNextWindow

@UnstableApi

abstract fun ~~hasNextWindow~~(): Boolean

hasPreviousMediaItem

abstract fun hasPreviousMediaItem(): Boolean

increaseDeviceVolume

abstract fun ~~increaseDeviceVolume~~()

abstract fun increaseDeviceVolume(p0: Int)

isAtLiveEdge

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

Is at live edge

isCommandAvailable

abstract fun isCommandAvailable(p0: Int): Boolean

isCurrentMediaItemDynamic

abstract fun isCurrentMediaItemDynamic(): Boolean

isCurrentMediaItemLive

abstract fun isCurrentMediaItemLive(): Boolean

isCurrentMediaItemLiveAsFlow

fun Player.isCurrentMediaItemLiveAsFlow(): Flow<Boolean>

isCurrentMediaItemSeekable

abstract fun isCurrentMediaItemSeekable(): Boolean

isCurrentWindowDynamic

@UnstableApi

abstract fun ~~isCurrentWindowDynamic~~(): Boolean

isCurrentWindowLive

@UnstableApi

abstract fun ~~isCurrentWindowLive~~(): Boolean

isCurrentWindowSeekable

@UnstableApi

abstract fun ~~isCurrentWindowSeekable~~(): Boolean

isDeviceMuted

abstract fun isDeviceMuted(): Boolean

isLoading

abstract 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

abstract fun isPlaying(): Boolean

isPlayingAd

abstract fun isPlayingAd(): Boolean

isPlayingAsFlow

fun Player.isPlayingAsFlow(): Flow<Boolean>

Is playing Player.isPlaying as Flow.

mediaItemCountAsFlow

fun Player.mediaItemCountAsFlow(): Flow<Int>

Media item count Player.getMediaItemCount as Flow.

moveMediaItem

abstract fun moveMediaItem(p0: Int, p1: Int)

moveMediaItems

abstract fun moveMediaItems(p0: Int, p1: Int, p2: Int)

@UnstableApi

abstract operator fun ~~next~~()

pause

abstract fun pause()

play

abstract 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

abstract fun prepare()

release

abstract fun release()

removeListener

abstract fun removeListener(p0: Player.Listener)

removeMediaItem

abstract fun removeMediaItem(p0: Int)

removeMediaItems

abstract fun removeMediaItems(p0: Int, p1: Int)

replaceMediaItem

abstract fun replaceMediaItem(p0: Int, p1: MediaItem)

replaceMediaItems

abstract 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

abstract fun seekBack()

seekForward

abstract fun seekForward()

seekTo

abstract fun seekTo(p0: Long)

abstract fun seekTo(p0: Int, p1: Long)

seekToDefaultPosition

abstract fun seekToDefaultPosition()

abstract fun seekToDefaultPosition(p0: Int)

seekToNext

abstract fun seekToNext()

seekToNextMediaItem

abstract fun seekToNextMediaItem()

seekToNextWindow

@UnstableApi

abstract fun ~~seekToNextWindow~~()

seekToPrevious

abstract fun seekToPrevious()

seekToPreviousMediaItem

abstract fun seekToPreviousMediaItem()

seekToPreviousWindow

@UnstableApi

abstract fun ~~seekToPreviousWindow~~()

selectTrack

fun Player.selectTrack(track: Track)

Select the provided track.

setAudioAttributes

abstract fun setAudioAttributes(p0: AudioAttributes, p1: Boolean)

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.

setDeviceMuted

abstract fun ~~setDeviceMuted~~(p0: Boolean)

abstract fun setDeviceMuted(p0: Boolean, p1: Int)

setDeviceVolume

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

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

setHandleAudioFocus

fun Player.setHandleAudioFocus(handleAudioFocus: Boolean)

Handle audio focus with the currently set AudioAttributes.

setMediaItem

abstract fun setMediaItem(p0: MediaItem)

abstract fun setMediaItem(p0: MediaItem, p1: Boolean)

abstract fun setMediaItem(p0: MediaItem, p1: Long)

setMediaItems

abstract fun setMediaItems(p0: MutableList<MediaItem>)

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

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

setPlaybackParameters

abstract fun setPlaybackParameters(p0: PlaybackParameters)

setPlaybackSpeed

abstract fun setPlaybackSpeed(@FloatRange(from = 0.0, fromInclusive = false) p0: Float)

setPlaylistMetadata

abstract fun setPlaylistMetadata(p0: MediaMetadata)

setPlayWhenReady

abstract fun setPlayWhenReady(p0: Boolean)

setRepeatMode

abstract fun setRepeatMode(p0: Int)

setShuffleModeEnabled

abstract fun setShuffleModeEnabled(p0: Boolean)

setTrackOverride

fun Player.setTrackOverride(override: TrackSelectionOverride)

Set track override.

setTrackSelectionParameters

abstract fun setTrackSelectionParameters(p0: TrackSelectionParameters)

setVideoSurface

abstract fun setVideoSurface(@Nullable p0: Surface?)

setVideoSurfaceHolder

abstract fun setVideoSurfaceHolder(@Nullable p0: SurfaceHolder?)

setVideoSurfaceView

abstract fun setVideoSurfaceView(@Nullable p0: SurfaceView?)

setVideoTextureView

abstract fun setVideoTextureView(@Nullable p0: TextureView?)

setVolume

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

shuffleModeEnabledAsFlow

fun Player.shuffleModeEnabledAsFlow(): Flow<Boolean>

Shuffle mode enabled Player.getShuffleModeEnabled as Flow.

stop

abstract 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