sdk/com.brightcove.player.model/SourceCollection

SourceCollection

open class SourceCollection : SourceAwareMetadataObject

The SourceCollection class represents a collection of video asset Source model objects grouped by a common encoding and/or delivery method. The delivery method is defined in the dynamic metadata properties.

For example, one SourceCollection may contain several H.264-encoded asset URLs suitable for progressive download, each representing a different bit rate and resoultion, while another SourceCollection may contain a single HTTP Live Streaming (HLS) asset URL (with which the adaptation of bit rate is managed via the HLS protocol and not separate asset URLs).

Constructors

SourceCollection

constructor(properties: Map<String, Any>)

constructor(properties: Map<String, Any>, sources: Set<Source>)

Initializes a new SourceCollection with a predefined metadata properties collection and a predefined Set of Source objects.

constructor(sources: Set<Source>, deliveryType: DeliveryType)

Initializes a new SourceCollection with a predefined Set of Source objects all having the given DeliveryType.

constructor(source: Source, deliveryType: DeliveryType)

Convenience constructor that initializes the SourceCollection with a single Source (most commonly used for HTTP Live Streaming which only has a single URL)

Properties

EMPTY

val EMPTY: SourceCollection

Indicates an empty Source Collection.

sources

val sources: Set<Source>

TAG

val TAG: String

Functions

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.

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.

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.

toString

open fun toString(): String