CuePoint

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.

Parameters

positionType

Either BEFORE (pre-roll) or AFTER (post-roll).

type

Either AD or CODE

properties

The properties describing this cue point.


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.

Parameters

position

The offset from the beginning of the video, in milliseconds.

type

Either CuePointType.AD or CuePointType.CODE

properties

The properties describing this cue point.


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

Deprecated

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

Deprecated

Use the construtor that use a CuePointType rather than a string. This will guarantee that the CuePoint is of a known type and can be handled properly by the system. This method now throws IllegalArgumentException if the string value describing the cue point type does not specify a known cue point type. Currently supported values are "AD" or "CODE".

Parameters

positionType

Either PositionType.Before (pre-roll) or PositionType.After (post-roll).

type

The type of the cue point. Valid values are: "AD" or "CODE".

properties

The properties describing this cue point.


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

Deprecated

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

Deprecated

Use the construtor that takes a CuePointType rather than a string. This will guarantee that the CuePoint is of a known type and can be handled properly by the system. This method now throws IllegalArgumentException if the string value describing the cue point type does not specify a known cue point type. Currently supported values are "AD" and "CODE".

Parameters

position

The offset from the beginning of the video, in milliseconds.

type

The type of the cue point. Valid values are "AD" or "CODE".

properties

The properties describing this cue point.


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

Deprecated

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

Parameters

position

The offset from the beginning of the video, in milliseconds.

type

Either CuePointType.AD or CuePointType.CODE

properties

The properties describing this cue point.