SourceConfig

open class SourceConfig(url: String, type: SourceType, title: String?, description: String?, posterSource: String?, isPosterPersistent: Boolean, subtitleTracks: List<SubtitleTrack>, thumbnailTrack: ThumbnailTrack?, drmConfig: DrmConfig?, labelingConfig: LabelingConfig, vrConfig: VrConfig, videoCodecPriority: List<String>, audioCodecPriority: List<String>, options: SourceOptions, metadata: Map<String, String>?) : Parcelable

Configures a Source that can be loaded into a Player.

Constructors

SourceConfig

fun SourceConfig(url: String, type: SourceType)

Creates a new SourceConfig for a given type.

SourceConfig

fun SourceConfig(url: String)

Creates a new SourceConfig based on the provided url to a DASH, HLS, SMOOTH or Progressive MP4 source.

SourceConfig

fun SourceConfig(adaptiveSource: AdaptiveSource)

SourceConfig

fun SourceConfig(progressiveSource: ProgressiveSource)

SourceConfig

fun SourceConfig(url: String, type: SourceType, title: String? = null, description: String? = null, posterSource: String? = null, isPosterPersistent: Boolean = false, subtitleTracks: List<SubtitleTrack> = emptyList(), thumbnailTrack: ThumbnailTrack? = null, drmConfig: DrmConfig? = null, labelingConfig: LabelingConfig = LabelingConfig(), vrConfig: VrConfig = VrConfig(), videoCodecPriority: List<String> = emptyList(), audioCodecPriority: List<String> = emptyList(), options: SourceOptions = SourceOptions(), metadata: Map<String, String>? = null)

Types

Companion

object Companion

Properties

audioCodecPriority

var audioCodecPriority: List<String>

The audio codec priority for the Source.

dashSource

val dashSource: DASHSource?

The current DASHSource.

description

var description: String? = null

The descriptions of the Source.

drmConfig

var drmConfig: DrmConfig? = null

The current DrmConfig or null.

drmConfigs

val drmConfigs: List<DrmConfig?>

hlsSource

val hlsSource: HLSSource?

The current HLSSource.

isPosterPersistent

var isPosterPersistent: Boolean = false

Whether the poster is persistent.

labelingConfig

var labelingConfig: LabelingConfig

The LabelingConfig for the Source.

metadata

var metadata: Map<String, String>? = null

The optional custom metadata.

options

var options: SourceOptions

The additional SourceOptions for the Source.

posterSource

var posterSource: String? = null

The URL pointing to the poster image.

progressiveSource

val progressiveSource: ProgressiveSource?

The current ProgressiveSource.

smoothSource

val smoothSource: SmoothSource?

The current SmoothSource.

subtitleTracks

var subtitleTracks: List<SubtitleTrack>

A list of additional SubtitleTracks available for the Source.

thumbnailTrack

var thumbnailTrack: ThumbnailTrack? = null

The current ThumbnailTrack or null.

title

var title: String? = null

The title of the Source.

type

val type: SourceType

The SourceType of the Source.

url

val url: String

The URL pointing to the media stream with the specified type.

videoCodecPriority

var videoCodecPriority: List<String>

The video codec priority for the Source.

vrConfig

var vrConfig: VrConfig

The current VrConfig.

Functions

addDrmConfig

fun addDrmConfig(drmConfig: DrmConfig)

Sets a DrmConfig to this SourceConfig.

fun addDrmConfig(uuid: UUID, licenseUrl: String): DrmConfig?

Sets a DrmConfig to this SourceConfig.

addSubtitleTrack

fun addSubtitleTrack(subtitleTrack: SubtitleTrack): SubtitleTrack

Adds the provided SubtitleTrack to this SourceConfig.

fun addSubtitleTrack(url: String?): SubtitleTrack

Generates a SubtitleTrack with the provided url and adds it to this SourceConfig.

fun addSubtitleTrack(url: String?, label: String?, id: String, isDefault: Boolean, language: String?): SubtitleTrack

Generates a SubtitleTrack with the provided parameter and adds it to this SourceConfig.

fun addSubtitleTrack(url: String?, mimeType: String?, label: String?, id: String, isDefault: Boolean, language: String?): SubtitleTrack

Generates a SubtitleTrack with the provided parameter and adds it to this SourceConfig.

getDrmConfig

fun getDrmConfig(uuid: UUID): DrmConfig?

Returns the DrmConfig if the uuid matches the config in this SourceConfig.

setPosterImage

fun setPosterImage(url: String, keepPersistent: Boolean = false)

Sets the poster image and its persistent state for this SourceConfig.

setThumbnailTrack

fun setThumbnailTrack(url: String?)

Generates a ThumbnailTrack with the provided url and sets it on this SourceConfig.

Inherited functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Inheritors

OfflineSourceConfig