com.brightcove.player.model

Class CuePoint

java.lang.Object

com.brightcove.player.model.MetadataObject

com.brightcove.player.model.CuePoint

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CuePoint>

public class CuePoint
extends MetadataObject
implements java.lang.Comparable<CuePoint>

Represents the data of a single cue point.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CuePoint.PositionType

Field Summary

Fields inherited from class com.brightcove.player.model.MetadataObject

properties, TAG

Constructor Summary

Constructors

Constructor and Description
CuePoint(CuePoint.PositionType positionType, java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> properties) Used to create a before or after cue point.
CuePoint(int position, java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> properties) Used to create a point in time cue point.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CuePoint cuePoint)
boolean	equals(java.lang.Object object)
int	getPosition()
CuePoint.PositionType	getPositionType()
java.lang.String	getType()
java.lang.String	toString()

Methods inherited from class com.brightcove.player.model.MetadataObject

getIntegerProperty, getIntegerProperty, getProperties, getStringProperty, getStringProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CuePoint

public CuePoint(CuePoint.PositionType positionType,
                java.lang.String type,
                java.util.Map<java.lang.String,java.lang.Object> properties)

Used to create a before or after cue point.

Parameters:

positionType - Either Before or After.

type - The type of the cue point, for example: "ad", "bumper", or "code".

properties - The properties describing this cue point.

CuePoint

public CuePoint(int position,
                java.lang.String type,
                java.util.Map<java.lang.String,java.lang.Object> properties)

Used to create a point in time cue point.

Parameters:

position - The offset from the beginning of the video in milliseconds.

type - The type of the cue point, for example: "ad", "bumper", or "code".

properties - The properties describing this cue point.

Method Detail

getPositionType

public CuePoint.PositionType getPositionType()

getPosition

public int getPosition()

getType

public java.lang.String getType()

compareTo

public int compareTo(CuePoint cuePoint)

Specified by:

compareTo in interface java.lang.Comparable<CuePoint>

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class MetadataObject