8.0.0

pillarbox-cast-receiver/ch.srgssr.pillarbox.cast.receiver/PillarboxCastReceiverPlayer

PillarboxCastReceiverPlayer

class PillarboxCastReceiverPlayer(player: PillarboxExoPlayer, castReceiverContext: CastReceiverContext = CastReceiverContext.getInstance(), mediaItemConverter: MediaItemConverter = DefaultMediaItemConverter(), tracksConverter: TracksConverter = DefaultTracksConverter()) : PillarboxPlayer, ExoPlayer

PillarboxPlayer implementation that handles operations that are not currently handled by androidx.media3.session.MediaSession. It guarantees synchronization between the underlying player with all Google Cast senders.

Usage

val castReceiverContext = CastReceiverContext.getInstance()

val pillarboxCastReceiverPlayer = PillarboxCastReceiverPlayer(
    player = PillarboxExoPlayer(...),
    castReceiverContext = castReceiverContext,
    mediaItemConverter = SRGMediaItemConverter()
)

val mediaSession = PillarboxMediaSession.Builder(this, pillarboxCastReceiverPlayer).build()

castReceiverContext.mediaManager.setSessionTokenFromPillarboxMediaSession(mediaSession)

Parameters

player

The PillarboxExoPlayer that plays content.

castReceiverContext

The CastReceiverContext used for communication with Google Cast senders.

mediaItemConverter

The MediaItemConverter used for conversion between MediaQueueItem and MediaItem.

tracksConverter

The TracksConverter used for conversion between androidx.media3.common.Tracks and com.google.android.gms.cast.MediaTrack.

See also

Official documentation Cast Receiver with Android TV

Constructors

PillarboxCastReceiverPlayer

constructor(player: PillarboxExoPlayer, castReceiverContext: CastReceiverContext = CastReceiverContext.getInstance(), mediaItemConverter: MediaItemConverter = DefaultMediaItemConverter(), tracksConverter: TracksConverter = DefaultTracksConverter())

Properties

analyticsCollector

@get:UnstableApi

open override val analyticsCollector: AnalyticsCollector

applicationLooper

open override val applicationLooper: Looper

audioAttributes

open override val audioAttributes: AudioAttributes

audioDecoderCounters

@get:UnstableApi

open override val audioDecoderCounters: DecoderCounters?

@get:UnstableApi

open override val audioFormat: Format?

@get:UnstableApi

@set:UnstableApi

open override var audioSessionId: Int

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

@get:UnstableApi

open override val clock: Clock

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

open override val currentCues: CueGroup

currentLiveOffset

open override val currentLiveOffset: Long

currentManifest

@get:UnstableApi

open override val currentManifest: Any?

currentMediaItem

open override val currentMediaItem: MediaItem?

currentMediaItemIndex

open override val currentMediaItemIndex: Int

currentPeriodIndex

open override val currentPeriodIndex: Int

currentPillarboxMetadata

open override val currentPillarboxMetadata: PillarboxMetadata

currentPosition

open override val currentPosition: Long

currentTimeline

open override val currentTimeline: Timeline

currentTrackGroups

@get:UnstableApi

open override val currentTrackGroups: TrackGroupArray

open override val currentTracks: Tracks

currentTrackSelections

@get:UnstableApi

open override val currentTrackSelections: TrackSelectionArray

currentWindowIndex

@get:UnstableApi

open override val currentWindowIndex: Int

open override val deviceInfo: DeviceInfo

@get:IntRange(from = 0)

open override var deviceVolume: Int

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

open override var isDeviceMuted: Boolean

isImageOutputAvailable

open override val isImageOutputAvailable: Boolean

open override val isLoading: Boolean

isMetricsAvailable

open override val isMetricsAvailable: Boolean

open override val isPlaying: Boolean

open override val isPlayingAd: Boolean

@get:UnstableApi

open override val isReleased: Boolean

isScrubbingModeEnabled

@get:UnstableApi

@set:UnstableApi

open override var isScrubbingModeEnabled: Boolean

isSeekParametersAvailable

open override val isSeekParametersAvailable: Boolean

isSleepingForOffload

@get:UnstableApi

open override val isSleepingForOffload: Boolean

isTunnelingEnabled

@get:UnstableApi

open override val isTunnelingEnabled: Boolean

maxSeekToPreviousPosition

open override val maxSeekToPreviousPosition: Long

open override val mediaItemCount: Int

open override val mediaMetadata: MediaMetadata

nextMediaItemIndex

open override val nextMediaItemIndex: Int

nextWindowIndex

@get:UnstableApi

open override val nextWindowIndex: Int

pauseAtEndOfMediaItems

@get:UnstableApi

@set:UnstableApi

open override var pauseAtEndOfMediaItems: Boolean

@get:UnstableApi

open override val playbackLooper: Looper

playbackParameters

open override var playbackParameters: PlaybackParameters

open override val playbackState: Int

playbackSuppressionReason

open override val playbackSuppressionReason: Int

open override val playerError: ExoPlaybackException?

playlistMetadata

open override var playlistMetadata: MediaMetadata

open override var playWhenReady: Boolean

preloadConfiguration

@get:UnstableApi

@set:UnstableApi

open override var preloadConfiguration: ExoPlayer.PreloadConfiguration

previousMediaItemIndex

open override val previousMediaItemIndex: Int

previousWindowIndex

@get:UnstableApi

open override val previousWindowIndex: Int

@get:UnstableApi

open override val rendererCount: Int

open override var repeatMode: Int

scrubbingModeParameters

@get:UnstableApi

@set:UnstableApi

open override var scrubbingModeParameters: ScrubbingModeParameters

seekBackIncrement

open override val seekBackIncrement: Long

seekForwardIncrement

open override val seekForwardIncrement: Long

open override val seekParameters: SeekParameters

shuffleModeEnabled

open override var shuffleModeEnabled: Boolean

@get:UnstableApi

@set:UnstableApi

open override var shuffleOrder: ShuffleOrder

skipSilenceEnabled

@get:UnstableApi

@set:UnstableApi

open override var skipSilenceEnabled: Boolean

smoothSeekingEnabled

open override var smoothSeekingEnabled: Boolean

@get:UnstableApi

open override val surfaceSize: Size

totalBufferedDuration

open override val totalBufferedDuration: Long

trackingEnabled

open override var trackingEnabled: Boolean

trackSelectionParameters

open override var trackSelectionParameters: TrackSelectionParameters

@get:UnstableApi

open override val trackSelector: TrackSelector?

videoChangeFrameRateStrategy

@get:UnstableApi

@set:UnstableApi

open override var videoChangeFrameRateStrategy: Int

videoDecoderCounters

@get:UnstableApi

open override val videoDecoderCounters: DecoderCounters?

@get:UnstableApi

open override val videoFormat: Format?

videoScalingMode

@get:UnstableApi

@set:UnstableApi

open override var videoScalingMode: Int

open override val videoSize: VideoSize

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

open override var volume: Float

Inherited properties

currentBlockedTimeRanges

open val currentBlockedTimeRanges: List<BlockedTimeRange>

currentChapters

open val currentChapters: List<Chapter>

open val currentCredits: List<Credit>

Functions

open override fun addMediaItem(mediaItem: MediaItem)

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

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

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

getCurrentMetrics

open override fun getCurrentMetrics(): PlaybackMetrics?

getSecondaryRenderer

open override fun getSecondaryRenderer(index: Int): Renderer?

getSeekParameters

open override fun getSeekParameters(): SeekParameters

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

open override fun moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)

open override fun release()

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

open override fun setImageOutput(imageOutput: ImageOutput?)

open override fun setMediaItem(mediaItem: MediaItem)

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

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

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)

open override fun setMediaSource(mediaSource: MediaSource)

open override fun setMediaSource(mediaSource: MediaSource, resetPosition: Boolean)

open override fun setMediaSource(mediaSource: MediaSource, startPositionMs: Long)

setMediaSources

open override fun setMediaSources(mediaSources: List<MediaSource>)

open override fun setMediaSources(mediaSources: List<MediaSource>, resetPosition: Boolean)

open override fun setMediaSources(mediaSources: List<MediaSource>, startMediaItemIndex: Int, startPositionMs: Long)

setSeekParameters

open override fun setSeekParameters(seekParameters: SeekParameters?)

Inherited functions

addAnalyticsListener

open override fun addAnalyticsListener(p0: AnalyticsListener)

addAudioOffloadListener

open override fun addAudioOffloadListener(p0: ExoPlayer.AudioOffloadListener)

open override fun addListener(p0: Player.Listener)

open override fun addMediaSource(p0: MediaSource)

open override fun addMediaSource(p0: Int, p1: MediaSource)

addMediaSources

open override fun addMediaSources(p0: List<MediaSource>)

open override fun addMediaSources(p0: Int, p1: List<MediaSource>)

canAdvertiseSession

open override fun canAdvertiseSession(): Boolean

clearAuxEffectInfo

open override fun clearAuxEffectInfo()

clearCameraMotionListener

open override fun clearCameraMotionListener(p0: CameraMotionListener)

clearMediaItems

open override fun clearMediaItems()

clearVideoFrameMetadataListener

open override fun clearVideoFrameMetadataListener(p0: VideoFrameMetadataListener)

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

open override fun createMessage(p0: PlayerMessage.Target): PlayerMessage

decreaseDeviceVolume

open override fun ~~decreaseDeviceVolume~~()

open override fun decreaseDeviceVolume(p0: Int)

getAnalyticsCollector

open override fun getAnalyticsCollector(): AnalyticsCollector

getApplicationLooper

open override fun getApplicationLooper(): Looper

getAudioAttributes

open override fun getAudioAttributes(): AudioAttributes

getAudioDecoderCounters

open override fun getAudioDecoderCounters(): DecoderCounters?

open override fun getAudioFormat(): Format?

getAudioSessionId

open override fun getAudioSessionId(): Int

getAvailableCommands

open override fun getAvailableCommands(): Player.Commands

getBlockedTimeRangeAtPosition

open fun getBlockedTimeRangeAtPosition(positionMs: Long): BlockedTimeRange?

getBufferedPercentage

@IntRange(from = 0, to = 100)

open override fun getBufferedPercentage(): Int

getBufferedPosition

open override fun getBufferedPosition(): Long

getChapterAtPosition

open fun getChapterAtPosition(positionMs: Long): Chapter?

open override fun getClock(): Clock

getContentBufferedPosition

open override fun getContentBufferedPosition(): Long

getContentDuration

open override fun getContentDuration(): Long

getContentPosition

open override fun getContentPosition(): Long

getCreditAtPosition

open fun getCreditAtPosition(positionMs: Long): Credit?

getCurrentAdGroupIndex

open override fun getCurrentAdGroupIndex(): Int

getCurrentAdIndexInAdGroup

open override fun getCurrentAdIndexInAdGroup(): Int

open override fun getCurrentCues(): CueGroup

getCurrentLiveOffset

open override fun getCurrentLiveOffset(): Long

getCurrentManifest

open override fun getCurrentManifest(): Any?

getCurrentMediaItem

open override fun getCurrentMediaItem(): MediaItem?

getCurrentMediaItemIndex

open override fun getCurrentMediaItemIndex(): Int

getCurrentPeriodIndex

open override fun getCurrentPeriodIndex(): Int

getCurrentPlaybackSessionId

open fun getCurrentPlaybackSessionId(): String?

getCurrentPosition

open override fun getCurrentPosition(): Long

getCurrentTimeline

open override fun getCurrentTimeline(): Timeline

getCurrentTrackGroups

open override fun ~~getCurrentTrackGroups~~(): TrackGroupArray

getCurrentTracks

open override fun getCurrentTracks(): Tracks

getCurrentTrackSelections

open override fun ~~getCurrentTrackSelections~~(): TrackSelectionArray

getCurrentWindowIndex

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

open override fun getDeviceInfo(): DeviceInfo

getDeviceVolume

@IntRange(from = 0)

open override fun getDeviceVolume(): Int

open override fun getDuration(): Long

getMaxSeekToPreviousPosition

open override fun getMaxSeekToPreviousPosition(): Long

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

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

getPauseAtEndOfMediaItems

open override fun getPauseAtEndOfMediaItems(): Boolean

getPlaybackLooper

open override fun getPlaybackLooper(): Looper

getPlaybackParameters

open override fun getPlaybackParameters(): PlaybackParameters

getPlaybackState

open override fun getPlaybackState(): Int

getPlaybackSuppressionReason

open override fun getPlaybackSuppressionReason(): Int

open override fun getPlayerError(): ExoPlaybackException?

getPlaylistMetadata

open override fun getPlaylistMetadata(): MediaMetadata

getPlayWhenReady

open override fun getPlayWhenReady(): Boolean

getPreloadConfiguration

open override fun getPreloadConfiguration(): ExoPlayer.PreloadConfiguration

getPreviousMediaItemIndex

open override fun getPreviousMediaItemIndex(): Int

getPreviousWindowIndex

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

open override fun getRenderer(p0: Int): Renderer

getRendererCount

open override fun getRendererCount(): Int

getRendererType

open override fun getRendererType(p0: Int): Int

open override fun getRepeatMode(): Int

getScrubbingModeParameters

open override fun getScrubbingModeParameters(): ScrubbingModeParameters

getSeekBackIncrement

open override fun getSeekBackIncrement(): Long

getSeekForwardIncrement

open override fun getSeekForwardIncrement(): Long

getShuffleModeEnabled

open override fun getShuffleModeEnabled(): Boolean

getShuffleOrder

open override fun getShuffleOrder(): ShuffleOrder

getSkipSilenceEnabled

open override fun getSkipSilenceEnabled(): Boolean

open override fun getSurfaceSize(): Size

getTotalBufferedDuration

open override fun getTotalBufferedDuration(): Long

getTrackSelectionParameters

open override fun getTrackSelectionParameters(): TrackSelectionParameters

getTrackSelector

open override fun getTrackSelector(): TrackSelector?

getVideoChangeFrameRateStrategy

open override fun getVideoChangeFrameRateStrategy(): Int

getVideoDecoderCounters

open override fun getVideoDecoderCounters(): DecoderCounters?

open override fun getVideoFormat(): Format?

getVideoScalingMode

open override fun getVideoScalingMode(): Int

open override fun getVideoSize(): VideoSize

@FloatRange(from = 0.0, to = 1.0)

open override fun getVolume(): Float

hasNextMediaItem

open override fun hasNextMediaItem(): Boolean

hasPreviousMediaItem

open override fun hasPreviousMediaItem(): Boolean

increaseDeviceVolume

open override fun ~~increaseDeviceVolume~~()

open override fun increaseDeviceVolume(p0: Int)

isCommandAvailable

open override fun isCommandAvailable(p0: Int): Boolean

isCurrentMediaItemDynamic

open override fun isCurrentMediaItemDynamic(): Boolean

isCurrentMediaItemLive

open override fun isCurrentMediaItemLive(): Boolean

isCurrentMediaItemSeekable

open override fun isCurrentMediaItemSeekable(): Boolean

isCurrentWindowDynamic

open override fun ~~isCurrentWindowDynamic~~(): Boolean

isCurrentWindowLive

open override fun ~~isCurrentWindowLive~~(): Boolean

isCurrentWindowSeekable

open override fun ~~isCurrentWindowSeekable~~(): Boolean

open override fun isDeviceMuted(): Boolean

open override fun isLoading(): Boolean

open override fun isPlaying(): Boolean

open override fun isPlayingAd(): Boolean

open override fun isReleased(): Boolean

isScrubbingModeEnabled

open override fun isScrubbingModeEnabled(): Boolean

isSleepingForOffload

open override fun isSleepingForOffload(): Boolean

isTunnelingEnabled

open override fun isTunnelingEnabled(): Boolean

open override fun pause()

open override fun play()

open override fun prepare()

open override fun ~~prepare~~(p0: MediaSource)

open override fun ~~prepare~~(p0: MediaSource, p1: Boolean, p2: Boolean)

removeAnalyticsListener

open override fun removeAnalyticsListener(p0: AnalyticsListener)

removeAudioOffloadListener

open override fun removeAudioOffloadListener(p0: ExoPlayer.AudioOffloadListener)

open override fun removeListener(p0: Player.Listener)

open override fun seekBack()

open override fun seekForward()

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)

open override fun seekToNext()

seekToNextMediaItem

open override fun seekToNextMediaItem()

open override fun seekToPrevious()

seekToPreviousMediaItem

open override fun seekToPreviousMediaItem()

setAudioAttributes

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

setAudioSessionId

open override fun setAudioSessionId(p0: Int)

setAuxEffectInfo

open override fun setAuxEffectInfo(p0: AuxEffectInfo)

setCameraMotionListener

open override fun setCameraMotionListener(p0: CameraMotionListener)

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)

setForegroundMode

open override fun setForegroundMode(p0: Boolean)

setHandleAudioBecomingNoisy

open override fun setHandleAudioBecomingNoisy(p0: Boolean)

setPauseAtEndOfMediaItems

open override fun setPauseAtEndOfMediaItems(p0: Boolean)

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)

setPreferredAudioDevice

@RequiresApi(value = 23)

open override fun setPreferredAudioDevice(@Nullable p0: AudioDeviceInfo?)

setPreloadConfiguration

open override fun setPreloadConfiguration(p0: ExoPlayer.PreloadConfiguration)

open override fun setPriority(p0: Int)

setPriorityTaskManager

open override fun setPriorityTaskManager(@Nullable p0: PriorityTaskManager?)

open override fun setRepeatMode(p0: Int)

setScrubbingModeEnabled

open override fun setScrubbingModeEnabled(p0: Boolean)

setScrubbingModeParameters

open override fun setScrubbingModeParameters(p0: ScrubbingModeParameters)

setShuffleModeEnabled

open override fun setShuffleModeEnabled(p0: Boolean)

setShuffleOrder

open override fun setShuffleOrder(p0: ShuffleOrder)

setSkipSilenceEnabled

open override fun setSkipSilenceEnabled(p0: Boolean)

setTrackSelectionParameters

open override fun setTrackSelectionParameters(p0: TrackSelectionParameters)

setVideoChangeFrameRateStrategy

open override fun setVideoChangeFrameRateStrategy(p0: Int)

setVideoEffects

open override fun setVideoEffects(p0: List<Effect>)

setVideoFrameMetadataListener

open override fun setVideoFrameMetadataListener(p0: VideoFrameMetadataListener)

setVideoScalingMode

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

open override fun setVolume(@FloatRange(from = 0.0, to = 1.0) p0: Float)

open override fun setWakeMode(p0: Int)

open override fun stop()