pillarbox-player/ch.srgssr.pillarbox.player.session/PillarboxMediaBrowser

PillarboxMediaBrowser

class PillarboxMediaBrowser : PillarboxMediaController

PillarboxMediaBrowser extends PillarboxMediaController but connects to a PillarboxMediaLibrarySession from a MediaLibraryService.

Types

Builder

class Builder(context: Context, clazz: Class<out MediaLibraryService>)

Builder for PillarboxMediaBrowser.

Listener

interface Listener : PillarboxMediaController.Listener

A listener for events and incoming commands from PillarboxMediaLibrarySession.

Properties

availableSessionCommands

val availableSessionCommands: SessionCommands

Available session commands

connectedToken

val connectedToken: SessionToken?

The SessionToken of the connected session, or null if it is not connected.

customLayout

@get:UnstableApi

val customLayout: ImmutableList<CommandButton>

Custom layout

isConnected

val isConnected: Boolean

Is connected

sessionActivity

val sessionActivity: PendingIntent?

Session activity

sessionExtras

@get:UnstableApi

val sessionExtras: Bundle

Session extras

smoothSeekingEnabled

open override var smoothSeekingEnabled: Boolean

Smooth seeking enabled

trackingEnabled

open override var trackingEnabled: Boolean

Enable or disable MediaItem tracking

Functions

addListener

open override fun addListener(listener: Player.Listener)

addMediaItem

open override fun addMediaItem(mediaItem: MediaItem)

open override fun addMediaItem(index: Int, mediaItem: MediaItem)

addMediaItems

open override fun addMediaItems(mediaItems: List<MediaItem>)

open override fun addMediaItems(index: Int, mediaItems: List<MediaItem>)

availableCommandsAsFlow

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

Available commands Player.getAvailableCommands as Flow.

canAdvertiseSession

open override fun canAdvertiseSession(): Boolean

clearMediaItems

open override fun clearMediaItems()

clearVideoSurface

open override fun clearVideoSurface()

open override fun clearVideoSurface(surface: Surface?)

clearVideoSurfaceHolder

open override fun clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)

clearVideoSurfaceView

open override fun clearVideoSurfaceView(surfaceView: SurfaceView?)

clearVideoTextureView

open override fun clearVideoTextureView(textureView: 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

open override fun ~~decreaseDeviceVolume~~()

open override fun decreaseDeviceVolume(flags: 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

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

getAvailableCommands

open override fun getAvailableCommands(): Player.Commands

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.

getChildren

@JvmOverloads

suspend fun getChildren(parentId: String, @IntRange(from = 0) page: Int, @IntRange(from = 1) pageSize: Int, params: MediaLibraryService.LibraryParams? = null): LibraryResult<ImmutableList<MediaItem>>

Get children for the parentId

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

open override fun getCurrentManifest(): Any?

getCurrentMediaItem

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

getCurrentPeriodIndex

open override fun getCurrentPeriodIndex(): Int

getCurrentPosition

open override fun getCurrentPosition(): Long

getCurrentTimeline

open override fun getCurrentTimeline(): Timeline

getCurrentTracks

open override fun getCurrentTracks(): Tracks

getCurrentTracksAsFlow

fun Player.getCurrentTracksAsFlow(): Flow<Tracks>

Get current tracks as flow Player.getCurrentTracks

getCurrentWindowIndex

@UnstableApi

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

getDeviceInfo

open override fun getDeviceInfo(): DeviceInfo

getDeviceVolume

@IntRange(from = 0)

open override fun getDeviceVolume(): Int

getDuration

open override fun getDuration(): Long

getItem

suspend fun getItem(mediaId: String): LibraryResult<MediaItem>

Get item

getLibraryRoot

@JvmOverloads

suspend fun getLibraryRoot(params: MediaLibraryService.LibraryParams? = null): LibraryResult<MediaItem>

Get library root

getMaxSeekToPreviousPosition

open override fun getMaxSeekToPreviousPosition(): Long

getMediaItemAt

open override fun getMediaItemAt(index: Int): MediaItem

getMediaItemCount

open override fun getMediaItemCount(): Int

getMediaMetadata

open override fun getMediaMetadata(): MediaMetadata

getNextMediaItemIndex

open override fun getNextMediaItemIndex(): Int

getNextWindowIndex

@UnstableApi

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

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

open override fun getPlayerError(): PlaybackException?

getPlaylistMetadata

open override fun getPlaylistMetadata(): MediaMetadata

getPlayWhenReady

open override fun getPlayWhenReady(): Boolean

getPreviousMediaItemIndex

open override fun getPreviousMediaItemIndex(): Int

getPreviousWindowIndex

@UnstableApi

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

getRepeatMode

open override fun getRepeatMode(): Int

getSearchResult

@JvmOverloads

suspend fun getSearchResult(query: String, @IntRange(from = 0) page: Int, @IntRange(from = 1) pageSize: Int, params: MediaLibraryService.LibraryParams? = null): LibraryResult<ImmutableList<MediaItem>>

Returns the search result from the library service.

getSeekBackIncrement

open override fun getSeekBackIncrement(): Long

getSeekForwardIncrement

open override fun getSeekForwardIncrement(): Long

getShuffleModeEnabled

open override fun getShuffleModeEnabled(): Boolean

getSurfaceSize

@UnstableApi

open override fun getSurfaceSize(): Size

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

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(flags: Int)

isAtLiveEdge

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

Is at live edge

isCommandAvailable

open override fun isCommandAvailable(command: 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.

isSessionCommandAvailable

fun isSessionCommandAvailable(sessionCommand: SessionCommand): Boolean

fun isSessionCommandAvailable(sessionCommandCode: Int): Boolean

mediaItemCountAsFlow

fun Player.mediaItemCountAsFlow(): Flow<Int>

Media item count Player.getMediaItemCount as Flow.

moveMediaItem

open override fun moveMediaItem(currentIndex: Int, newIndex: Int)

moveMediaItems

open override fun moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: 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 ~~previous~~()

release

open override fun release()

removeListener

open override fun removeListener(listener: Player.Listener)

removeMediaItem

open override fun removeMediaItem(index: Int)

removeMediaItems

open override fun removeMediaItems(fromIndex: Int, toIndex: Int)

replaceMediaItem

open override fun replaceMediaItem(index: Int, mediaItem: MediaItem)

replaceMediaItems

open override fun replaceMediaItems(fromIndex: Int, toIndex: Int, mediaItems: List<MediaItem>)

runOnApplicationLooper

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

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

@JvmOverloads

suspend fun search(query: String, params: MediaLibraryService.LibraryParams? = null): LibraryResult<Void>

Requests a search from the library service.

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.

sendCustomCommand

@JvmOverloads

fun sendCustomCommand(command: SessionCommand, args: Bundle = Bundle.EMPTY): ListenableFuture<SessionResult>

setAudioAttributes

open override fun setAudioAttributes(audioAttributes: AudioAttributes, handleAudioFocus: 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

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

open override fun setDeviceMuted(muted: Boolean, flags: Int)

setDeviceVolume

open override fun ~~setDeviceVolume~~(volume: Int)

open override fun setDeviceVolume(volume: Int, flags: Int)

setHandleAudioFocus

fun Player.setHandleAudioFocus(handleAudioFocus: Boolean)

Handle audio focus with the currently set AudioAttributes.

setMediaItem

open override fun setMediaItem(mediaItem: MediaItem)

open override fun setMediaItem(mediaItem: MediaItem, resetPosition: Boolean)

open override fun setMediaItem(mediaItem: MediaItem, startPositionMs: Long)

setMediaItems

open override fun setMediaItems(mediaItems: List<MediaItem>)

open override fun setMediaItems(mediaItems: List<MediaItem>, resetPosition: Boolean)

open override fun setMediaItems(mediaItems: List<MediaItem>, startIndex: Int, startPositionMs: Long)

setPlaybackParameters

open override fun setPlaybackParameters(playbackParameters: PlaybackParameters)

setPlaybackSpeed

open override fun setPlaybackSpeed(speed: Float)

setPlaylistMetadata

open override fun setPlaylistMetadata(mediaMetadata: MediaMetadata)

setPlayWhenReady

open override fun setPlayWhenReady(playWhenReady: Boolean)

setRating

fun setRating(rating: Rating): ListenableFuture<SessionResult>

fun setRating(mediaId: String, rating: Rating): ListenableFuture<SessionResult>

setRepeatMode

open override fun setRepeatMode(repeatMode: Int)

setShuffleModeEnabled

open override fun setShuffleModeEnabled(shuffleModeEnabled: Boolean)

setTrackOverride

fun Player.setTrackOverride(override: TrackSelectionOverride)

Set track override.

setTrackSelectionParameters

open override fun setTrackSelectionParameters(parameters: TrackSelectionParameters)

setVideoSurface

open override fun setVideoSurface(surface: Surface?)

setVideoSurfaceHolder

open override fun setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)

setVideoSurfaceView

open override fun setVideoSurfaceView(surfaceView: SurfaceView?)

setVideoTextureView

open override fun setVideoTextureView(textureView: TextureView?)

setVolume

open override fun setVolume(volume: Float)

shuffleModeEnabledAsFlow

fun Player.shuffleModeEnabledAsFlow(): Flow<Boolean>

Shuffle mode enabled Player.getShuffleModeEnabled as Flow.

stop

open override fun stop()

@JvmOverloads

suspend fun subscribe(parentId: String, params: MediaLibraryService.LibraryParams? = null): LibraryResult<Void>

Subscribes to a parent id for changes to its children. When there's a change, PillarboxMediaBrowser.Listener.onChildrenChanged will be called with the MediaLibraryService.LibraryParams. You may call PillarboxMediaBrowser.getChildren to get the children.

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.

unsubscribe

suspend fun unsubscribe(parentId: String): LibraryResult<Void>

Unsubscribes from a parent id for changes to its children, which was previously subscribed by subscribe.

videoSizeAsFlow

fun Player.videoSizeAsFlow(): Flow<VideoSize>

Get video size as flow Player.getVideoSize

PillarboxMediaBrowser

See also

Types

Properties

Functions