Mux Player SDK for Android/com.mux.player/MuxPlayer

MuxPlayer

class MuxPlayer : ExoPlayer

Mux player for native Android. An ExoPlayer with a few extra APIs for interacting with Mux Video. This player also integrates transparently with Mux Data when you play Mux Video Assets

Basic Usage

MuxPlayer is almost a direct drop-in replacement for ExoPlayer. To create instances of MuxPlayer, use our Builder

To play Mux Assets, you can create a MediaItem using MediaItems.fromMuxPlaybackId, or MediaItems.builderFromMuxPlaybackId

Customizing ExoPlayer

The underlying ExoPlayer.Builder can be reached using Builder.applyExoConfig (java callers can use Builder.plusExoConfig). If you need to inject any custom objects into the underlying ExoPlayer, you are able to do so this way. Please note that doing this may interfere with Mux Player's features.

Types

Builds instances of MuxPlayer. To configure the underlying ExoPlayer, you can use plusExoConfig, and provide a function to update an ExoPlayer.Builder. Note that configuring or overriding certain objects with plusExoConfig may degrade the player's behavior

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 addMediaItem(p0: MediaItem)

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

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

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

open override fun addMediaSource(p0: MediaSource)

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

addMediaSources

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

open override fun addMediaSources(p0: Int, p1: MutableList<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)

experimentalIsSleepingForOffload

open override fun experimentalIsSleepingForOffload(): Boolean

experimentalSetOffloadSchedulingEnabled

open override fun experimentalSetOffloadSchedulingEnabled(p0: Boolean)

getAnalyticsCollector

open override fun getAnalyticsCollector(): AnalyticsCollector

getApplicationLooper

open override fun getApplicationLooper(): Looper

getAudioAttributes

open override fun getAudioAttributes(): AudioAttributes

getAudioComponent

open override fun ~~getAudioComponent~~(): ExoPlayer.AudioComponent?

getAudioDecoderCounters

open override fun getAudioDecoderCounters(): DecoderCounters?

open override fun getAudioFormat(): Format?

getAudioSessionId

open override fun getAudioSessionId(): Int

getAvailableCommands

open override fun getAvailableCommands(): Player.Commands

getBufferedPercentage

@IntRange(from = 0, to = 100)

open override fun getBufferedPercentage(): Int

getBufferedPosition

open override fun getBufferedPosition(): Long

open override fun getClock(): Clock

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

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

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

getDeviceComponent

open override fun ~~getDeviceComponent~~(): ExoPlayer.DeviceComponent?

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

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

getSeekBackIncrement

open override fun getSeekBackIncrement(): Long

getSeekForwardIncrement

open override fun getSeekForwardIncrement(): Long

getSeekParameters

open override fun getSeekParameters(): SeekParameters

getShuffleModeEnabled

open override fun getShuffleModeEnabled(): Boolean

getSkipSilenceEnabled

open override fun getSkipSilenceEnabled(): Boolean

open override fun getSurfaceSize(): Size

getTextComponent

open override fun ~~getTextComponent~~(): ExoPlayer.TextComponent?

getTotalBufferedDuration

open override fun getTotalBufferedDuration(): Long

getTrackSelectionParameters

open override fun getTrackSelectionParameters(): TrackSelectionParameters

getTrackSelector

open override fun getTrackSelector(): TrackSelector?

getVideoChangeFrameRateStrategy

open override fun getVideoChangeFrameRateStrategy(): Int

getVideoComponent

open override fun ~~getVideoComponent~~(): ExoPlayer.VideoComponent?

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

open operator override fun ~~hasNext~~(): Boolean

hasNextMediaItem

open override fun hasNextMediaItem(): Boolean

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

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

hasPreviousMediaItem

open override fun hasPreviousMediaItem(): Boolean

hasPreviousWindow

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

isTunnelingEnabled

open override fun isTunnelingEnabled(): Boolean

open override fun moveMediaItem(p0: Int, p1: Int)

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

open operator override fun ~~next~~()

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)

open override fun ~~previous~~()

open override fun release()

removeAnalyticsListener

open override fun removeAnalyticsListener(p0: AnalyticsListener)

removeAudioOffloadListener

open override fun removeAudioOffloadListener(p0: ExoPlayer.AudioOffloadListener)

open override fun removeListener(p0: Player.Listener)

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

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

seekToNextWindow

open override fun ~~seekToNextWindow~~()

open override fun seekToPrevious()

seekToPreviousMediaItem

open override fun seekToPreviousMediaItem()

seekToPreviousWindow

open override fun ~~seekToPreviousWindow~~()

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)

open override fun setMediaItem(p0: MediaItem)

open override fun setMediaItem(p0: MediaItem, p1: Boolean)

open override fun setMediaItem(p0: MediaItem, p1: Long)

open override fun setMediaItems(p0: MutableList<MediaItem>)

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

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

open override fun setMediaSource(p0: MediaSource)

open override fun setMediaSource(p0: MediaSource, p1: Boolean)

open override fun setMediaSource(p0: MediaSource, p1: Long)

setMediaSources

open override fun setMediaSources(p0: MutableList<MediaSource>)

open override fun setMediaSources(p0: MutableList<MediaSource>, p1: Boolean)

open override fun setMediaSources(p0: MutableList<MediaSource>, p1: Int, p2: Long)

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

setPriorityTaskManager

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

open override fun setRepeatMode(p0: Int)

setSeekParameters

open override fun setSeekParameters(@Nullable p0: SeekParameters?)

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

@RequiresApi(value = 18)

open override fun setVideoEffects(p0: MutableList<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()