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

PillarboxCastPlayer

class PillarboxCastPlayer : SimpleBasePlayer, PillarboxPlayer

A PillarboxPlayer implementation that works with Cast devices.

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

Parameters

context

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

castContext

The context from which the cast session is obtained.

mediaItemConverter

The MediaItemConverter to use.

tracksConverter

The TracksConverter 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.

applicationLooper

The Looper that must be used for all calls to the player and that is used to call listeners on.

clock

A Clock used to generate timestamps.

Properties

currentPillarboxMetadata

open override val currentPillarboxMetadata: PillarboxMetadata

isImageOutputAvailable

open override val isImageOutputAvailable: Boolean = false

CastPlayer does not support ImageOutput.

isMetricsAvailable

open override val isMetricsAvailable: Boolean = false

CastPlayer does not support metrics.

isSeekParametersAvailable

open override val isSeekParametersAvailable: Boolean = false

CastPlayer does not support SeekParameters.

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.

trackingEnabled

open override var trackingEnabled: Boolean

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

Inherited properties

applicationLooper

override val applicationLooper: Looper

audioAttributes

override val audioAttributes: AudioAttributes

availableCommands

override val availableCommands: Player.Commands

bufferedPercentage

override val bufferedPercentage: Int

bufferedPosition

override val bufferedPosition: Long

contentBufferedPosition

override val contentBufferedPosition: Long

contentDuration

override val contentDuration: Long

contentPosition

override val contentPosition: Long

currentAdGroupIndex

override val currentAdGroupIndex: Int

currentAdIndexInAdGroup

override val currentAdIndexInAdGroup: Int

currentBlockedTimeRanges

open val currentBlockedTimeRanges: List<BlockedTimeRange>

currentChapters

open val currentChapters: List<Chapter>

currentCredits

open val currentCredits: List<Credit>

currentCues

override val currentCues: CueGroup

currentLiveOffset

override val currentLiveOffset: Long

currentManifest

@get:Nullable

override val currentManifest: Any?

currentMediaItem

@get:Nullable

override val currentMediaItem: MediaItem?

currentMediaItemIndex

override val currentMediaItemIndex: Int

currentPeriodIndex

override val currentPeriodIndex: Int

currentPosition

override val currentPosition: Long

currentTimeline

override val currentTimeline: Timeline

currentTracks

override val currentTracks: Tracks

currentWindowIndex

override val currentWindowIndex: Int

deviceInfo

override val deviceInfo: DeviceInfo

deviceVolume

override var deviceVolume: Int

duration

override val duration: Long

isCurrentMediaItemDynamic

override val isCurrentMediaItemDynamic: Boolean

isCurrentMediaItemLive

override val isCurrentMediaItemLive: Boolean

isCurrentMediaItemSeekable

override val isCurrentMediaItemSeekable: Boolean

isCurrentWindowDynamic

override val isCurrentWindowDynamic: Boolean

isCurrentWindowLive

override val isCurrentWindowLive: Boolean

isCurrentWindowSeekable

override val isCurrentWindowSeekable: Boolean

isDeviceMuted

override var isDeviceMuted: Boolean

isLoading

override val isLoading: Boolean

isPlaying

override val isPlaying: Boolean

isPlayingAd

override val isPlayingAd: Boolean

maxSeekToPreviousPosition

override val maxSeekToPreviousPosition: Long

mediaItemCount

override val mediaItemCount: Int

mediaMetadata

override val mediaMetadata: MediaMetadata

nextMediaItemIndex

override val nextMediaItemIndex: Int

nextWindowIndex

override val nextWindowIndex: Int

playbackParameters

override var playbackParameters: PlaybackParameters

playbackState

override val playbackState: Int

playbackSuppressionReason

override val playbackSuppressionReason: Int

playerError

@get:Nullable

override val playerError: PlaybackException?

playlistMetadata

override var playlistMetadata: MediaMetadata

playWhenReady

override var playWhenReady: Boolean

previousMediaItemIndex

override val previousMediaItemIndex: Int

previousWindowIndex

override val previousWindowIndex: Int

repeatMode

override var repeatMode: Int

seekBackIncrement

override val seekBackIncrement: Long

seekForwardIncrement

override val seekForwardIncrement: Long

shuffleModeEnabled

override var shuffleModeEnabled: Boolean

surfaceSize

override val surfaceSize: Size

totalBufferedDuration

override val totalBufferedDuration: Long

trackSelectionParameters

override var trackSelectionParameters: TrackSelectionParameters

videoSize

override val videoSize: VideoSize

volume

override var volume: Float

Functions

getSeekParameters

open override fun getSeekParameters(): SeekParameters

isCastSessionAvailable

fun isCastSessionAvailable(): Boolean

Returns whether a cast session is available.

setImageOutput

open override fun setImageOutput(imageOutput: ImageOutput?)

setSeekParameters

open override fun setSeekParameters(seekParameters: SeekParameters?)

setSessionAvailabilityListener

fun setSessionAvailabilityListener(listener: SessionAvailabilityListener?)

Sets a listener for updates on the cast session availability.

Inherited functions

addListener

fun addListener(p0: Player.Listener)

addMediaItem

fun addMediaItem(p0: MediaItem)

fun addMediaItem(p0: Int, p1: MediaItem)

addMediaItems

fun addMediaItems(p0: List<MediaItem>)

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

canAdvertiseSession

fun canAdvertiseSession(): Boolean

clearMediaItems

fun clearMediaItems()

clearVideoSurface

fun clearVideoSurface()

fun clearVideoSurface(@Nullable p0: Surface?)

clearVideoSurfaceHolder

fun clearVideoSurfaceHolder(@Nullable p0: SurfaceHolder?)

clearVideoSurfaceView

fun clearVideoSurfaceView(@Nullable p0: SurfaceView?)

clearVideoTextureView

fun clearVideoTextureView(@Nullable p0: TextureView?)

decreaseDeviceVolume

fun ~~decreaseDeviceVolume~~()

fun decreaseDeviceVolume(p0: Int)

getApplicationLooper

fun getApplicationLooper(): Looper

getAudioAttributes

fun getAudioAttributes(): AudioAttributes

getAvailableCommands

fun getAvailableCommands(): Player.Commands

getBlockedTimeRangeAtPosition

open fun getBlockedTimeRangeAtPosition(positionMs: Long): BlockedTimeRange?

getBufferedPercentage

fun getBufferedPercentage(): Int

getBufferedPosition

fun getBufferedPosition(): Long

getChapterAtPosition

open fun getChapterAtPosition(positionMs: Long): Chapter?

getContentBufferedPosition

fun getContentBufferedPosition(): Long

getContentDuration

fun getContentDuration(): Long

getContentPosition

fun getContentPosition(): Long

getCreditAtPosition

open fun getCreditAtPosition(positionMs: Long): Credit?

getCurrentAdGroupIndex

fun getCurrentAdGroupIndex(): Int

getCurrentAdIndexInAdGroup

fun getCurrentAdIndexInAdGroup(): Int

getCurrentCues

fun getCurrentCues(): CueGroup

getCurrentLiveOffset

fun getCurrentLiveOffset(): Long

getCurrentManifest

@Nullable

fun getCurrentManifest(): Any?

getCurrentMediaItem

@Nullable

fun getCurrentMediaItem(): MediaItem?

getCurrentMediaItemIndex

fun getCurrentMediaItemIndex(): Int

getCurrentMetrics

open fun getCurrentMetrics(): PlaybackMetrics?

getCurrentPeriodIndex

fun getCurrentPeriodIndex(): Int

getCurrentPlaybackSessionId

open fun getCurrentPlaybackSessionId(): String?

getCurrentPosition

fun getCurrentPosition(): Long

getCurrentTimeline

fun getCurrentTimeline(): Timeline

getCurrentTracks

fun getCurrentTracks(): Tracks

getCurrentWindowIndex

fun ~~getCurrentWindowIndex~~(): Int

getDeviceInfo

fun getDeviceInfo(): DeviceInfo

getDeviceVolume

fun getDeviceVolume(): Int

getDuration

fun getDuration(): Long

getMaxSeekToPreviousPosition

fun getMaxSeekToPreviousPosition(): Long

getMediaItemAt

fun getMediaItemAt(p0: Int): MediaItem

getMediaItemCount

fun getMediaItemCount(): Int

getMediaMetadata

fun getMediaMetadata(): MediaMetadata

getNextMediaItemIndex

fun getNextMediaItemIndex(): Int

getNextWindowIndex

fun ~~getNextWindowIndex~~(): Int

getPlaybackParameters

fun getPlaybackParameters(): PlaybackParameters

getPlaybackState

fun getPlaybackState(): Int

getPlaybackSuppressionReason

fun getPlaybackSuppressionReason(): Int

getPlayerError

@Nullable

fun getPlayerError(): PlaybackException?

getPlaylistMetadata

fun getPlaylistMetadata(): MediaMetadata

getPlayWhenReady

fun getPlayWhenReady(): Boolean

getPreviousMediaItemIndex

fun getPreviousMediaItemIndex(): Int

getPreviousWindowIndex

fun ~~getPreviousWindowIndex~~(): Int

getRepeatMode

fun getRepeatMode(): Int

getSeekBackIncrement

fun getSeekBackIncrement(): Long

getSeekForwardIncrement

fun getSeekForwardIncrement(): Long

getShuffleModeEnabled

fun getShuffleModeEnabled(): Boolean

getSurfaceSize

fun getSurfaceSize(): Size

getTotalBufferedDuration

fun getTotalBufferedDuration(): Long

getTrackSelectionParameters

fun getTrackSelectionParameters(): TrackSelectionParameters

getVideoSize

fun getVideoSize(): VideoSize

getVolume

fun getVolume(): Float

hasNextMediaItem

fun hasNextMediaItem(): Boolean

hasPreviousMediaItem

fun hasPreviousMediaItem(): Boolean

increaseDeviceVolume

fun ~~increaseDeviceVolume~~()

fun increaseDeviceVolume(p0: Int)

isCastSessionAvailableAsFlow

fun PillarboxCastPlayer.isCastSessionAvailableAsFlow(): Flow<Boolean>

Observe the availability of a Cast session as a Flow.

isCommandAvailable

fun isCommandAvailable(p0: Int): Boolean

isCurrentMediaItemDynamic

fun isCurrentMediaItemDynamic(): Boolean

isCurrentMediaItemLive

fun isCurrentMediaItemLive(): Boolean

isCurrentMediaItemSeekable

fun isCurrentMediaItemSeekable(): Boolean

isCurrentWindowDynamic

fun ~~isCurrentWindowDynamic~~(): Boolean

isCurrentWindowLive

fun ~~isCurrentWindowLive~~(): Boolean

isCurrentWindowSeekable

fun ~~isCurrentWindowSeekable~~(): Boolean

isDeviceMuted

fun isDeviceMuted(): Boolean

isLoading

fun isLoading(): Boolean

isPlaying

fun isPlaying(): Boolean

isPlayingAd

fun isPlayingAd(): Boolean

moveMediaItem

fun moveMediaItem(p0: Int, p1: Int)

moveMediaItems

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

fun pause()

fun play()

fun prepare()

fun release()

fun removeListener(p0: Player.Listener)

removeMediaItem

fun removeMediaItem(p0: Int)

removeMediaItems

fun removeMediaItems(p0: Int, p1: Int)

replaceMediaItem

fun replaceMediaItem(p0: Int, p1: MediaItem)

replaceMediaItems

fun replaceMediaItems(p0: Int, p1: Int, p2: List<MediaItem>)

seekBack

fun seekBack()

seekForward

fun seekForward()

seekTo

fun seekTo(p0: Long)

fun seekTo(p0: Int, p1: Long)

seekToDefaultPosition

fun seekToDefaultPosition()

fun seekToDefaultPosition(p0: Int)

seekToNext

fun seekToNext()

seekToNextMediaItem

fun seekToNextMediaItem()

seekToPrevious

fun seekToPrevious()

seekToPreviousMediaItem

fun seekToPreviousMediaItem()

setAudioAttributes

fun setAudioAttributes(p0: AudioAttributes, p1: Boolean)

setDeviceMuted

fun ~~setDeviceMuted~~(p0: Boolean)

fun setDeviceMuted(p0: Boolean, p1: Int)

setDeviceVolume

fun ~~setDeviceVolume~~(p0: Int)

fun setDeviceVolume(p0: Int, p1: Int)

setMediaItem

fun setMediaItem(p0: MediaItem)

fun setMediaItem(p0: MediaItem, p1: Boolean)

fun setMediaItem(p0: MediaItem, p1: Long)

setMediaItems

fun setMediaItems(p0: List<MediaItem>)

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

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

setPlaybackParameters

fun setPlaybackParameters(p0: PlaybackParameters)

setPlaybackSpeed

fun setPlaybackSpeed(p0: Float)

setPlaylistMetadata

fun setPlaylistMetadata(p0: MediaMetadata)

setPlayWhenReady

fun setPlayWhenReady(p0: Boolean)

setRepeatMode

fun setRepeatMode(p0: Int)

setShuffleModeEnabled

fun setShuffleModeEnabled(p0: Boolean)

setTrackSelectionParameters

fun setTrackSelectionParameters(p0: TrackSelectionParameters)

setVideoSurface

fun setVideoSurface(@Nullable p0: Surface?)

setVideoSurfaceHolder

fun setVideoSurfaceHolder(@Nullable p0: SurfaceHolder?)

setVideoSurfaceView

fun setVideoSurfaceView(@Nullable p0: SurfaceView?)

setVideoTextureView

fun setVideoTextureView(@Nullable p0: TextureView?)

setVolume

fun setVolume(p0: Float)

stop

fun stop()