pillarbox-cast/ch.srgssr.pillarbox.cast/PillarboxCastPlayer

PillarboxCastPlayer

class PillarboxCastPlayer : PillarboxPlayer, Player

A PillarboxPlayer implementation that forwards calls to a CastPlayer.

It disables smooth seeking and tracking capabilities as these are not supported or relevant in the context of Cast playback.

Parameters

castContext

The context from which the cast session is obtained.

context

A Context used to populate getDeviceInfo. If null, getDeviceInfo will always return CastPlayer.DEVICE_INFO_REMOTE_EMPTY.

mediaItemConverter

The MediaItemConverter to use.

seekBackIncrementMs

The seekBack increment, in milliseconds.

seekForwardIncrementMs

The seekForward increment, in milliseconds.

maxSeekToPreviousPositionMs

The maximum position for which seekToPrevious seeks to the previous MediaItem, in milliseconds.

trackSelector

The CastTrackSelector to use when selecting tracks from TrackSelectionParameters.

castPlayer

The underlying CastPlayer instance to which method calls will be forwarded.

Properties

applicationLooper

open override val applicationLooper: Looper

audioAttributes

open override val audioAttributes: AudioAttributes

availableCommands

open override val availableCommands: Player.Commands

bufferedPercentage

@get:IntRange(from = 0, to = 100)

open override val bufferedPercentage: Int

bufferedPosition

open override val bufferedPosition: Long

contentBufferedPosition

open override val contentBufferedPosition: Long

contentDuration

open override val contentDuration: Long

contentPosition

open override val contentPosition: Long

currentAdGroupIndex

open override val currentAdGroupIndex: Int

currentAdIndexInAdGroup

open override val currentAdIndexInAdGroup: Int

currentCues

open override val currentCues: CueGroup

currentLiveOffset

open override val currentLiveOffset: Long

currentManifest

@get:UnstableApi

@get:Nullable

open override val currentManifest: Any?

currentMediaItem

@get:Nullable

open override val currentMediaItem: MediaItem?

currentMediaItemIndex

open override val currentMediaItemIndex: Int

currentPeriodIndex

open override val currentPeriodIndex: Int

currentPosition

open override val currentPosition: Long

currentTimeline

open override val currentTimeline: Timeline

currentTracks

open override val currentTracks: Tracks

currentWindowIndex

@get:UnstableApi

open override val currentWindowIndex: Int

deviceInfo

open override val deviceInfo: DeviceInfo

deviceVolume

@get:IntRange(from = 0)

open override var deviceVolume: Int

duration

open override val duration: Long

isCurrentMediaItemDynamic

open override val isCurrentMediaItemDynamic: Boolean

isCurrentMediaItemLive

open override val isCurrentMediaItemLive: Boolean

isCurrentMediaItemSeekable

open override val isCurrentMediaItemSeekable: Boolean

isCurrentWindowDynamic

@get:UnstableApi

open override val isCurrentWindowDynamic: Boolean

isCurrentWindowLive

@get:UnstableApi

open override val isCurrentWindowLive: Boolean

isCurrentWindowSeekable

@get:UnstableApi

open override val isCurrentWindowSeekable: Boolean

isDeviceMuted

open override var isDeviceMuted: Boolean

isLoading

open override val isLoading: Boolean

isPlaying

open override val isPlaying: Boolean

isPlayingAd

open override val isPlayingAd: Boolean

maxSeekToPreviousPosition

open override val maxSeekToPreviousPosition: Long

mediaItemCount

open override val mediaItemCount: Int

mediaMetadata

open override val mediaMetadata: MediaMetadata

nextMediaItemIndex

open override val nextMediaItemIndex: Int

nextWindowIndex

@get:UnstableApi

open override val nextWindowIndex: Int

playbackParameters

open override var playbackParameters: PlaybackParameters

playbackState

open override val playbackState: Int

playbackSuppressionReason

open override val playbackSuppressionReason: Int

playerError

@get:Nullable

open override val playerError: PlaybackException?

playlistMetadata

open override var playlistMetadata: MediaMetadata

playWhenReady

open override var playWhenReady: Boolean

previousMediaItemIndex

open override val previousMediaItemIndex: Int

previousWindowIndex

@get:UnstableApi

open override val previousWindowIndex: Int

repeatMode

open override var repeatMode: Int

seekBackIncrement

open override val seekBackIncrement: Long

seekForwardIncrement

open override val seekForwardIncrement: Long

shuffleModeEnabled

open override var shuffleModeEnabled: Boolean

smoothSeekingEnabled

open override var smoothSeekingEnabled: Boolean

Smooth seeking is not supported on CastPlayer. By its very nature (ie. being remote), seeking smoothly is impossible to achieve.

surfaceSize

@get:UnstableApi

open override val surfaceSize: Size

totalBufferedDuration

open override val totalBufferedDuration: Long

trackingEnabled

open override var trackingEnabled: Boolean

This flag is not supported on CastPlayer. The receiver should implement tracking on its own.

trackSelectionParameters

open override var trackSelectionParameters: TrackSelectionParameters

videoSize

open override val videoSize: VideoSize

volume

@get:FloatRange(from = 0.0, to = 1.0)

open override var volume: Float

Functions

addListener

open override fun addListener(listener: Player.Listener)

getAvailableCommands

open override fun getAvailableCommands(): Player.Commands

getCurrentTracks

open override fun getCurrentTracks(): Tracks

getItem

fun getItem(periodId: Int): MediaQueueItem?

Returns the item that corresponds to the period with the given id, or null if no media queue or period with id periodId exist.

getShuffleModeEnabled

open override fun getShuffleModeEnabled(): Boolean

It is not possible to toggle shuffle mode on and off on a CastPlayer, thus, this method always returns false.

getTrackSelectionParameters

open override fun getTrackSelectionParameters(): TrackSelectionParameters

isCastSessionAvailable

fun isCastSessionAvailable(): Boolean

Returns whether a cast session is available.

isCommandAvailable

open override fun isCommandAvailable(command: Int): Boolean

release

open override fun release()

removeListener

open override fun removeListener(listener: Player.Listener)

setSessionAvailabilityListener

fun setSessionAvailabilityListener(listener: SessionAvailabilityListener?)

Sets a listener for updates on the cast session availability.

setShuffleModeEnabled

open override fun setShuffleModeEnabled(shuffleModeEnabled: Boolean)

Shuffle in place the list of media items being played, independently of the value of shuffleModeEnabled.

setTrackSelectionParameters

open override fun setTrackSelectionParameters(parameters: TrackSelectionParameters)

Inherited functions

addMediaItem

open override fun addMediaItem(p0: MediaItem)

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

addMediaItems

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

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

canAdvertiseSession

open override fun canAdvertiseSession(): Boolean

clearMediaItems

open override fun clearMediaItems()

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?)

decreaseDeviceVolume

open override fun ~~decreaseDeviceVolume~~()

open override fun decreaseDeviceVolume(p0: Int)

getApplicationLooper

open override fun getApplicationLooper(): Looper

getAudioAttributes

open override fun getAudioAttributes(): AudioAttributes

getBufferedPercentage

@IntRange(from = 0, to = 100)

open override fun getBufferedPercentage(): Int

getBufferedPosition

open override fun getBufferedPosition(): Long

getContentBufferedPosition

open override fun getContentBufferedPosition(): Long

getContentDuration

open override fun getContentDuration(): Long

getContentPosition

open override fun getContentPosition(): Long

getCurrentAdGroupIndex

open override fun getCurrentAdGroupIndex(): Int

getCurrentAdIndexInAdGroup

open override fun getCurrentAdIndexInAdGroup(): Int

getCurrentCues

open override fun getCurrentCues(): CueGroup

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

getCurrentPeriodIndex

open override fun getCurrentPeriodIndex(): Int

getCurrentPosition

open override fun getCurrentPosition(): Long

getCurrentTimeline

open override fun getCurrentTimeline(): Timeline

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

getMaxSeekToPreviousPosition

open override fun getMaxSeekToPreviousPosition(): Long

getMediaItemAt

open override fun getMediaItemAt(p0: 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

getPlaybackState

open override fun getPlaybackState(): Int

getPlaybackSuppressionReason

open override fun getPlaybackSuppressionReason(): Int

getPlayerError

@Nullable

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

getSeekBackIncrement

open override fun getSeekBackIncrement(): Long

getSeekForwardIncrement

open override fun getSeekForwardIncrement(): Long

getSurfaceSize

@UnstableApi

open override fun getSurfaceSize(): Size

getTotalBufferedDuration

open override fun getTotalBufferedDuration(): Long

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

hasPreviousMediaItem

open override fun hasPreviousMediaItem(): Boolean

increaseDeviceVolume

open override fun ~~increaseDeviceVolume~~()

open override fun increaseDeviceVolume(p0: Int)

isCastSessionAvailableAsFlow

fun PillarboxCastPlayer.isCastSessionAvailableAsFlow(): Flow<Boolean>

Observe the availability of a Cast session as a Flow.

isCurrentMediaItemDynamic

open override fun isCurrentMediaItemDynamic(): Boolean

isCurrentMediaItemLive

open override fun isCurrentMediaItemLive(): 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

isPlaying

open override fun isPlaying(): Boolean

isPlayingAd

open override fun isPlayingAd(): Boolean

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()

prepare

open override fun prepare()

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: List<MediaItem>)

seekBack

open override fun seekBack()

seekForward

open override fun seekForward()

seekTo

open override fun seekTo(p0: Long)

open override fun seekTo(p0: Int, p1: Long)

seekToDefaultPosition

open override fun seekToDefaultPosition()

open override fun seekToDefaultPosition(p0: 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~~()

setAudioAttributes

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

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)

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: List<MediaItem>)

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

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

setPlaybackParameters

open override fun setPlaybackParameters(p0: PlaybackParameters)

setPlaybackSpeed

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

setPlaylistMetadata

open override fun setPlaylistMetadata(p0: MediaMetadata)

setPlayWhenReady

open override fun setPlayWhenReady(p0: Boolean)

setRepeatMode

open override fun setRepeatMode(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)

stop

open override fun stop()