sdk/com.brightcove.player.model/Source

Source

open class Source : SourceAwareMetadataObject

The Source class is an immutable representation of a specific playable video asset, including the URL or other necessary information required to play the video.

Constructors

Source

constructor(properties: Map<String, Any>)

constructor(url: String)

Initializes a Source with a single URL property.

constructor(url: String, deliveryType: DeliveryType)

Initializes a Source with a single URL property with the given DeliveryType.

Types

Fields

class Fields

Provides the list of known field names that can appear in the properties Map.

Properties

EXT_X_VERSION_4

val EXT_X_VERSION_4: String = "4"

The constant HLS EXT_X_VERSION_4.

EXT_X_VERSION_5

val EXT_X_VERSION_5: String = "5"

The constant HLS EXT_X_VERSION_5.

TAG

val TAG: String

Functions

getBitRate

open fun getBitRate(): Integer

Convenience getter to retrieve the property with a key of BIT_RATE

getDeliveryType

open fun getDeliveryType(): DeliveryType

Returns the DeliveryType for this Source, or DeliveryType.UNKNOWN if none was specified.

getIntegerProperty

open fun getIntegerProperty(propertyName: String): Integer

Convenience method to retrieve a property from the dynamic properties Map that is expected to be an Integer.

open fun getIntegerProperty(properties: Map<String, Any>, propertyName: String): Integer

Convenience static method to retrieve a property from a properties Map that is expected to be an Integer.

getKeySystem

open fun getKeySystem(keySystem: String): Map<String, Any>

Returns the specified key system, or an empty Map if the key system can not be found

getLongProperty

open fun getLongProperty(properties: Map<String, Any>, propertyName: String): Long

Convenience static method to retrieve a property from a properties Map that is expected to be an Integer.

getProperties

open fun getProperties(): Map<String, Any>

Retrieves a Map of dynamic properties for this object.

getSourceUrl

open fun getSourceUrl(source: Source): String

Gets the URL of the source.

getStringProperty

open fun getStringProperty(propertyName: String): String

Convenience method to retrieve a property from the dynamic properties Map that is expected to be a String.

open fun getStringProperty(properties: Map<String, Any>, propertyName: String): String

Convenience static method to retrieve a property from a properties Map that is expected to be a String.

getUrl

open fun getUrl(): String

Convenience getter to retrieve the property with the URL key

hasHlseEncryption

open fun hasHlseEncryption(): Boolean

Checks if the source has HLSe encryption.

hasKeySystem

open fun hasKeySystem(keySystem: String): Boolean

Checks if the source has the specified key system.

isLocal

open fun isLocal(): Boolean

Checks if the source points to local media.

toString

open fun toString(): String