sdk/com.brightcove.player.model/CuePoint

CuePoint

open class CuePoint : MetadataObject, Comparable<T>

Represents the data of a single cue point.

Constructors

CuePoint

constructor(positionType: CuePoint.PositionType, type: String, properties: Map<String, Any>)

Used to create a before (pre-roll) or after (post-roll) cue point.

constructor(positionType: CuePoint.PositionType, type: CuePoint.CuePointType, properties: Map<String, Any>)

Used to create a pre-roll (PositionType.BEFORE) or post-roll (PositionType.AFTER) cue point.

constructor(position: Int, type: String, properties: Map<String, Any>)

Used to create a point in time (mid-roll) cue point at a specific position.

constructor(position: Int, type: CuePoint.CuePointType, properties: Map<String, Any>)

Used to create a mid-roll (PositionType.POINT_IN_TIME) cue point at a specific position.

constructor(position: Long, type: CuePoint.CuePointType, properties: Map<String, Any>)

Used to create a mid-roll (PositionType.POINT_IN_TIME) cue point at a specific position.

Types

CuePointType

enum CuePointType

Specifies the cue point type.

PositionType

enum PositionType

Indicates the position of the cue point in relation to the entire video.

Properties

position

val ~~position~~: Int

positionType

val positionType: CuePoint.PositionType

TAG

val TAG: String

Functions

compareTo

open fun compareTo(cuePoint: CuePoint): Int

Compares this CuePoint object with the specified CuePoint object.

equals

open fun equals(object: Any): Boolean

getCuePointType

open fun getCuePointType(): CuePoint.CuePointType

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.

getPositionLong

open fun getPositionLong(): Long

Returns the time offset of the cue point from the beginning of the video, in milliseconds.

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.

getType

open fun ~~getType~~(): String

hashCode

open fun hashCode(): Int

toString

open fun toString(): String