4.0.0-TEST

pillarbox-player/ch.srgssr.pillarbox.player

Package-level declarations

Types

object Default : PlayerConfig<Default.Builder>

Default configuration for creating a PillarboxExoPlayer, which closely matches an ExoPlayer.

PillarboxBuilder

abstract class PillarboxBuilder

A builder class for creating instances of PillarboxExoPlayer.

annotation class PillarboxDsl

Marks a class or function as part of the Pillarbox DSL (Domain Specific Language).

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

A LoadControl implementation tailored for Pillarbox, optimizing 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), renderersFactory: RenderersFactory = PillarboxRenderersFactory(context), loadControl: LoadControl = PillarboxLoadControl(), playbackThread: HandlerThread = HandlerThread("PillarboxPreloadManager:Playback", Process.THREAD_PRIORITY_AUDIO))

Helper class for Media3's DefaultPreloadManager that simplifies preloading of media items for PillarboxExoPlayer.

interface PlayerConfig<Builder : PillarboxBuilder>

Defines a factory for creating instances of PillarboxBuilder.

Properties

DefaultUpdateInterval

val DefaultUpdateInterval: Duration

The default interval between Flow emissions.

Functions

availableCommandsAsFlow

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

Collects the available commands as a Flow.

currentBufferedPercentageAsFlow

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

Collects the buffered percentage as a Flow.

currentMediaItemAsFlow

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

Collects the current media item as a Flow.

currentMediaMetadataAsFlow

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

Collects the media metadata as a Flow.

currentMetricsAsFlow

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

Collects the current playback metrics as a Flow.

currentPositionAsFlow

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

Collects the current position of the player as a Flow.

fun Player.durationAsFlow(): Flow<Long>

Collects the duration as a Flow.

getAspectRatioAsFlow

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

Collects the aspect ratio of the current video as a Flow.

getCurrentChapterAsFlow

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

Collects the current chapter as a Flow.

getCurrentCreditAsFlow

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

Collects the current credit as a Flow.

getCurrentDefaultPositionAsFlow

fun Player.getCurrentDefaultPositionAsFlow(): Flow<Long>

Collects the timeline's default position, in milliseconds, as a Flow.

getCurrentMediaItemIndexAsFlow

fun Player.getCurrentMediaItemIndexAsFlow(): Flow<Int>

Collects the current media item index as a Flow.

getCurrentMediaItemsAsFlow

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

Collects the current media items as a Flow.

getCurrentTracksAsFlow

fun Player.getCurrentTracksAsFlow(): Flow<Tracks>

Collects the current tracks as a Flow.

getPlaybackSpeedAsFlow

fun Player.getPlaybackSpeedAsFlow(): Flow<Float>

Collects the playback speed as a Flow.

getTrackSelectionParametersAsFlow

fun Player.getTrackSelectionParametersAsFlow(): Flow<TrackSelectionParameters>

Collects the track selection parameters as a Flow.

isCurrentMediaItemLiveAsFlow

fun Player.isCurrentMediaItemLiveAsFlow(): Flow<Boolean>

Collects whether the current media item is a live stream as a Flow.

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>

Collects whether the player is playing as a Flow.

mediaItemCountAsFlow

fun Player.mediaItemCountAsFlow(): Flow<Int>

Collects the media item count as a Flow.

PillarboxBandwidthMeter

fun PillarboxBandwidthMeter(context: Context): BandwidthMeter

Provides a pre-configured instance of BandwidthMeter suitable for use within 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

Provides a pre-configured instance of RenderersFactory suitable for use within Pillarbox.

PillarboxTrackSelector

fun PillarboxTrackSelector(context: Context): TrackSelector

Provides a pre-configured instance of TrackSelector suitable for use within Pillarbox.

playbackStateAsFlow

fun Player.playbackStateAsFlow(): Flow<Int>

Collects the playback state as a Flow.

playerErrorAsFlow

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

Collects the playback error as a Flow.

playWhenReadyAsFlow

fun Player.playWhenReadyAsFlow(): Flow<Boolean>

Collects the play when ready state as a Flow.

PreloadConfiguration

fun PreloadConfiguration(targetPreloadDuration: Duration?): ExoPlayer.PreloadConfiguration

Creates a PreloadConfiguration instance using a Duration.

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>

Collects whether the shuffle mode is enabled as a Flow.

tickerWhilePlayingAsFlow

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

Emits an event every interval while the Player is playing.

videoSizeAsFlow

fun Player.videoSizeAsFlow(): Flow<VideoSize>

Collects the video size as a Flow.