Interface DateRangeCue
-
- All Implemented Interfaces:
-
com.theoplayer.android.api.event.EventDispatcher
,com.theoplayer.android.api.player.track.texttrack.cue.TextTrackCue
public interface DateRangeCue implements TextTrackCue
Represents the HLS date range cue which is a part of the metadata text track.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
DateRangeCue.CustomAttributes
-
Method Summary
Modifier and Type Method Description abstract String
getAttributeClass()
The class of the date range cue. abstract Date
getStartDate()
The playback position at which the date range cue becomes active, as a Date. abstract Date
getEndDate()
The playback position at which the date range cue becomes inactive, as a Date. abstract Double
getDuration()
The duration of the date range cue. abstract Double
getPlannedDuration()
The planned duration of the date range cue, in seconds. abstract boolean
isEndOnNext()
Returns whether the end date of this cue will become equal to the start of the next cue, once it is known. abstract Array<byte>
getScte35Cmd()
The SCTE 'cmd' splice_info_section of the date range cue. abstract Array<byte>
getScte35Out()
The SCTE 'out' splice_info_section of the date range cue. abstract Array<byte>
getScte35In()
The SCTE 'in' splice_info_section of the date range cue. abstract DateRangeCue.CustomAttributes
getCustomAttributes()
The custom attributes of the date range cue. -
Methods inherited from class com.theoplayer.android.api.player.track.texttrack.cue.TextTrackCue
getContent, getEndTime, getId, getStartTime, getUid, setEndTime, setStartTime
-
Methods inherited from class com.theoplayer.android.api.event.EventDispatcher
addEventListener, removeEventListener
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getAttributeClass
@Nullable() abstract String getAttributeClass()
The class of the date range cue.
- The class is a client-defined string that specifies a set of attributes with associated value semantics.
- Returns:
The client-defined string specifying a set of attributes with associated value semantics. (Nullable)
-
getStartDate
@NonNull() abstract Date getStartDate()
The playback position at which the date range cue becomes active, as a Date.
- Returns:
The start of the date range cue, as a Date. (NonNull)
-
getEndDate
@Nullable() abstract Date getEndDate()
The playback position at which the date range cue becomes inactive, as a Date.
- The end date will be the same or after the start date.
- Returns:
The end of the date range cue, as a Date. (Nullable)
-
getDuration
@Nullable() abstract Double getDuration()
The duration of the date range cue.
- Null when the duration is unknown.
- Returns:
The date range cue duration, in seconds. (Nullable)
-
getPlannedDuration
@Nullable() abstract Double getPlannedDuration()
The planned duration of the date range cue, in seconds.
- This is used when the exact duration is not known yet.
- Returns:
The expected duration, in seconds. (Nullable)
-
isEndOnNext
abstract boolean isEndOnNext()
Returns whether the end date of this cue will become equal to the start of the next cue, once it is known.
- Both date range cues have the same getAttributeClass.
-
getScte35Cmd
@Nullable() abstract Array<byte> getScte35Cmd()
The SCTE 'cmd' splice_info_section of the date range cue.
- Returns:
The SCTE 'cmd' splice_info_section of the date range cue. (Nullable)
-
getScte35Out
@Nullable() abstract Array<byte> getScte35Out()
The SCTE 'out' splice_info_section of the date range cue.
- Returns:
The SCTE 'out' splice_info_section of the date range cue. (Nullable)
-
getScte35In
@Nullable() abstract Array<byte> getScte35In()
The SCTE 'in' splice_info_section of the date range cue.
- Returns:
The SCTE 'in' splice_info_section of the date range cue. (Nullable)
-
getCustomAttributes
abstract DateRangeCue.CustomAttributes getCustomAttributes()
The custom attributes of the date range cue.
- The attribute name does not include the 'X-' prefix.
- Returns:
The client-defined CustomAttributes.
-
-
-
-