pillarbox-player/ch.srgssr.pillarbox.player

Package-level declarations

Types

object Default : PlayerConfig<Default.Builder>

Default implementation used to create simple PillarboxExoPlayer.

PillarboxBuilder

abstract class PillarboxBuilder

Builder to create a new instance of PillarboxExoPlayer.

annotation class PillarboxDsl

Marker for Pillarbox's DSL.

PillarboxExoPlayer

class PillarboxExoPlayer : PillarboxPlayer, ExoPlayer

Pillarbox player

PillarboxLoadControl

class PillarboxLoadControl(bufferDurations: PillarboxLoadControl.BufferDurations = DEFAULT_BUFFER_DURATIONS, allocator: DefaultAllocator = DefaultAllocator(true, C.DEFAULT_BUFFER_SEGMENT_SIZE)) : LoadControl

Pillarbox LoadControl implementation that optimize content loading.

PillarboxPlayer

interface PillarboxPlayer : Player

Pillarbox Player interface extension.

PillarboxPreloadManager

class PillarboxPreloadManager(context: Context, targetPreloadStatusControl: TargetPreloadStatusControl<Int>? = null, mediaSourceFactory: PillarboxMediaSourceFactory = PillarboxMediaSourceFactory(context), trackSelector: TrackSelector = PillarboxTrackSelector(context), bandwidthMeter: BandwidthMeter = PillarboxBandwidthMeter(context), rendererCapabilitiesListFactory: RendererCapabilitiesList.Factory = DefaultRendererCapabilitiesList.Factory( PillarboxRenderersFactory(context) ), val allocator: DefaultAllocator = DefaultAllocator(false, C.DEFAULT_BUFFER_SEGMENT_SIZE), playbackThread: HandlerThread = HandlerThread("PillarboxPreloadManager:Playback", Process.THREAD_PRIORITY_AUDIO))

Helper class for the Media3's DefaultPreloadManager.

interface PlayerConfig<Builder : PillarboxBuilder>

Factory used to create instances of PillarboxBuilder.

Properties

DefaultUpdateInterval

val DefaultUpdateInterval: Duration

Default update interval.

Functions

availableCommandsAsFlow

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

Available commands Player.getAvailableCommands as Flow.

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.

fun Player.durationAsFlow(): Flow<Long>

Duration Player.getDuration as Flow.

getAspectRatioAsFlow

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

Get aspect ratio of the current video as Flow.

getCurrentChapterAsFlow

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

getCurrentCreditAsFlow

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

getCurrentDefaultPositionAsFlow

fun Player.getCurrentDefaultPositionAsFlow(): Flow<Long>

getCurrentMediaItemIndexAsFlow

fun Player.getCurrentMediaItemIndexAsFlow(): Flow<Int>

Get current media item index as flow Player.getCurrentMediaItemIndex

getCurrentMediaItemsAsFlow

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

Get current media items as flow Player.getCurrentMediaItems

getCurrentTracksAsFlow

fun Player.getCurrentTracksAsFlow(): Flow<Tracks>

Get current tracks as flow Player.getCurrentTracks

getPlaybackSpeedAsFlow

fun Player.getPlaybackSpeedAsFlow(): Flow<Float>

Playback speed Player.getPlaybackSpeed as Flow.

getTrackSelectionParametersAsFlow

fun Player.getTrackSelectionParametersAsFlow(): Flow<TrackSelectionParameters>

Get track selection parameters as flow Player.getTrackSelectionParameters

isCurrentMediaItemLiveAsFlow

fun Player.isCurrentMediaItemLiveAsFlow(): Flow<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.

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.

PillarboxBandwidthMeter

fun PillarboxBandwidthMeter(context: Context): BandwidthMeter

Preconfigured BandwidthMeter for Pillarbox.

PillarboxExoPlayer

fun <Builder : PillarboxBuilder> PillarboxExoPlayer(context: Context, type: PlayerConfig<Builder>, builder: Builder.() -> Unit = {}): PillarboxExoPlayer

Create a new instance of PillarboxExoPlayer.

PillarboxRenderersFactory

fun PillarboxRenderersFactory(context: Context): RenderersFactory

Preconfigured RenderersFactory for Pillarbox.

PillarboxTrackSelector

fun PillarboxTrackSelector(context: Context): TrackSelector

Preconfigured TrackSelector for Pillarbox.

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

runOnApplicationLooper

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

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

shuffleModeEnabledAsFlow

fun Player.shuffleModeEnabledAsFlow(): Flow<Boolean>

Shuffle mode enabled Player.getShuffleModeEnabled as Flow.

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