Video

open class Video : MetadataObject

The Video class is an immutable representation of all data related to a video, including associated metadata (in properties) and the groupings of source assets for this video.

Constructors

Video

constructor(properties: Map<String, Any>)

constructor(properties: Map<String, Any>, sourceCollectionSet: Set<SourceCollection>)

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

constructor(properties: Map<String, Any>, sourceCollectionSet: Set<SourceCollection>, cuePoints: List<CuePoint>)

Initializes a new Video with a predefined metadata properties collection, a predefined Set of SourceCollection objects, and a list of cue points.

Types

Builder

open class Builder

Convenience Builder to build Video objects.

CanSetDownloadIdentifier

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

annotation class CanSetDownloadIdentifier

Any method attempting to call setDownloadId must be annotated explicitly with this annotation.

CanSetLicenseExpiryDate

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

annotation class CanSetLicenseExpiryDate

Any method attempting to call setLicenseExpiryDate must be annotated explicitly with this annotation.

CanSetLicenseKeySetId

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

annotation class CanSetLicenseKeySetId

Any method attempting to call setOfflinePlaybackLicenseKey must be annotated explicitly with this annotation.

Fields

open class Fields

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

ProjectionFormat

enum ProjectionFormat

The list of known projection formats.

Status

enum Status

Properties

CREATOR

open var CREATOR: Creator<Video>

Creator for de-serializing Video object from the given Parcel.

cuePoints

open val cuePoints: List<CuePoint>

DEFAULT_LIVE_VIDEO_DURATION

val DEFAULT_LIVE_VIDEO_DURATION: Int = -1

Deprecated.

DEFAULT_LIVE_VIDEO_DURATION_LONG

val DEFAULT_LIVE_VIDEO_DURATION_LONG: Int = -1

Represent the default duration for a Live Video.

DEFAULT_REMOTE_VIDEO_DURATION

val DEFAULT_REMOTE_VIDEO_DURATION: Int = 0

Represent the default duration for a Remote Video (including Remote Live Videos).

downloadId

open var downloadId: UUID

The globally unique identifier to the local copy of this video, if any.

licenseExpiryDate

open var licenseExpiryDate: Date

The UTC date and time when the offline playback license for this video will expire.

PARCEL_OBJECT_TYPE

val PARCEL_OBJECT_TYPE: Int = 1

The type of the parcelable object.

status

val status: Video.Status

TAG

val TAG: String

Functions

createVideo

open fun createVideo(uri: String): Video

open fun createVideo(uri: String, type: DeliveryType): Video

open fun createVideo(uri: String, projectionFormat: Video.ProjectionFormat): Video

open fun createVideo(uri: String, type: DeliveryType, projectionFormat: Video.ProjectionFormat): Video

Creates a Video object from a string path.

describeContents

open fun describeContents(): Int

detectDeliveryType

open fun detectDeliveryType(uri: String): DeliveryType

Attempts to detect the delivery type of the asset URI provided.

findHighQualitySource

open fun findHighQualitySource(deliveryType: DeliveryType): Source

Finds the source with highest bitrate for the specified delivery type.

findLowQualitySource

open fun findLowQualitySource(deliveryType: DeliveryType): Source

Finds the source with lowest bitrate for the specified delivery type.

fixProperties

open fun fixProperties(): Video

Ensures that the video properties to conform the expected value types.

getDescription

open fun getDescription(): String

It gets the video description from the SHORT_DESCRIPTION video property if available, or an empty string otherwise.

getDuration

open fun ~~getDuration~~(): Int

Convenience method for obtaining the parsed Duration value from the properties Map

getDurationLong

open fun getDurationLong(): Long

Convenience method for obtaining the parsed Duration value from the properties Map

getId

open fun getId(): String

Convenience method for obtaining the parsed ID from the properties map.

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.

getLongDescription

open fun getLongDescription(): String

It gets the video's long description from the LONG_DESCRIPTION video property if available.

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.

getName

open fun getName(): String

It gets the video name from the NAME video property if available, or an empty string otherwise.

getOfflinePlaybackLicenseKey

open fun getOfflinePlaybackLicenseKey(): Array<Byte>

Gets the key set identifier for the current offline playback license for this video, if any.

getPosterImage

open fun getPosterImage(): URI

Gets the poster image source.

getPosterSources

open fun getPosterSources(): Set<URI>

Gets the list of poster sources.

getPreviewThumbnailSources

open fun getPreviewThumbnailSources(): List<PreviewThumbnailFormat>

getProjectionFormat

open fun getProjectionFormat(): Video.ProjectionFormat

Gets the video format.

getProperties

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

Retrieves a Map of dynamic properties for this object.

getReferenceId

open fun getReferenceId(): String

Convenience method for obtaining the parsed reference identifier from the properties map.

getSourceCollectionByDeliveryType

open fun getSourceCollectionByDeliveryType(deliveryType: DeliveryType): SourceCollection

Retrieve the SourceCollection associated with this Video and the specified Delivery Type.

getSourceCollections

open fun getSourceCollections(): Map<DeliveryType, SourceCollection>

Retrieve a Set of the SourceCollections associated with this Video.

getStillImageUri

open fun getStillImageUri(): URI

It gets the URI from the STILL_IMAGE_URI video property if available, or null otherwise.

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.

getThumbnail

open fun getThumbnail(): URI

Gets the thumbnail image source.

getThumbnailSources

open fun getThumbnailSources(): Set<URI>

Gets the list of thumbnail sources.

isClearContent

open fun isClearContent(): Boolean

Check if the video is DRM free content.

isOfflineCopy

open fun isOfflineCopy(): Boolean

Checks if this video is an offline copy, if and only if all of its sources are local.

isOfflinePlaybackAllowed

fun isOfflinePlaybackAllowed(): Boolean

Checks if the video can be stored locally on the host device.

isOwned

open fun isOwned(): Boolean

Checks if the video has a valid purchase license.

isRented

open fun isRented(): Boolean

Checks if the video has a valid rental license.

isVideo360

open fun isVideo360(): Boolean

Checks if this is a 360 degree video.

setOfflinePlaybackLicenseKey

open fun setOfflinePlaybackLicenseKey(licenseKeySetId: Array<Byte>)

Sets the key set identifier for the current offline playback license for this video, if any.

toString

open fun toString(): String

writeToParcel

open fun writeToParcel(parcel: Parcel, i: Int)