PlaybackConfig

PlaybackConfig

data class PlaybackConfig(var isAutoplayEnabled: Boolean = false, var isMuted: Boolean = false, var isTimeShiftEnabled: Boolean = true, var videoCodecPriority: List<String> = listOf("av1", "hevc", "hvc", "vp9", "avc"), var audioCodecPriority: List<String> = listOf("ec-3", "mp4a.a6", "ac-3", "mp4a.a5", "mp4a.40"), val decoderConfig: DecoderConfig = DecoderConfig(), var isTunneledPlaybackEnabled: Boolean = false, var seekMode: SeekMode = SeekMode.Exact, var forcedSubtitleCallback: ForcedSubtitleCallback? = null, var audioFilter: MediaFilter = MediaFilter.Loose, var videoFilter: MediaFilter = MediaFilter.Loose, var handleAudioFocus: Boolean = false, var handleAudioBecomingNoisy: Boolean = false) : Parcelable

Configures the playback behaviour of the player.

Constructors

PlaybackConfigconstructor(isAutoplayEnabled: Boolean = false, isMuted: Boolean = false, isTimeShiftEnabled: Boolean = true, videoCodecPriority: List<String> = listOf("av1", "hevc", "hvc", "vp9", "avc"), audioCodecPriority: List<String> = listOf("ec-3", "mp4a.a6", "ac-3", "mp4a.a5", "mp4a.40"), decoderConfig: DecoderConfig = DecoderConfig(), isTunneledPlaybackEnabled: Boolean = false, seekMode: SeekMode = SeekMode.Exact, forcedSubtitleCallback: ForcedSubtitleCallback? = null, audioFilter: MediaFilter = MediaFilter.Loose, videoFilter: MediaFilter = MediaFilter.Loose, handleAudioFocus: Boolean = false, handleAudioBecomingNoisy: Boolean = false)

Types

NameSummary
Builderclass Builder

Properties

NameSummary
audioCodecPriorityvar audioCodecPriority: List<String>
The audio codec priority where the first index has the highest priority. For a single SourceConfig this can be overwritten using SourceConfig.audioCodecPriority.
audioFiltervar audioFilter: MediaFilter
Specifies how strictly potentially unsupported audio tracks and qualities are filtered out of a playback session.
decoderConfigval decoderConfig: DecoderConfig
Configures decoder behaviour.
forcedSubtitleCallback@Transient
var forcedSubtitleCallback: ForcedSubtitleCallback?
The ForcedSubtitleCallback that shall be used to overwrite which subtitles are considered forced.
handleAudioBecomingNoisyvar handleAudioBecomingNoisy: Boolean
Specifies if the player should pause when headphones are disconnected.
handleAudioFocusvar handleAudioFocus: Boolean
Specifies if the player should only play when it has the audio focus.
isAutoplayEnabled@SerialName(value = "autoplay")
var isAutoplayEnabled: Boolean
Specifies whether autoplay is enabled.
isMuted@SerialName(value = "muted")
var isMuted: Boolean
Specifies if the player should start muted.
isTimeShiftEnabled@SerialName(value = "timeShift")
var isTimeShiftEnabled: Boolean
Specifies if time shifting (during live streaming) should be enabled.
isTunneledPlaybackEnabled@SerialName(value = "tunneledPlaybackEnabled")
var isTunneledPlaybackEnabled: Boolean
Specifies if tunneled playback should be enabled. This property is ignored for Android versions below LOLLIPOP (21) or when VR sources are scheduled.
seekModevar seekMode: SeekMode
The SeekMode that will be used. Default is SeekMode.Exact.
videoCodecPriorityvar videoCodecPriority: List<String>
The video codec priority where the index has the highest priority. For a single SourceConfig this can be overwritten using SourceConfig.videoCodecPriority.
videoFiltervar videoFilter: MediaFilter
Specifies how strictly potentially unsupported video qualities are filtered out of a playback session.