HlsMediaPlaylist.Interstitial
class HlsMediaPlaylist.Interstitial
An interstitial data range.
See RFC 8216bis, appendix D.2.
Summary
Nested types |
|---|
|
Builder for |
@Retention(value = RetentionPolicy.SOURCE)The cue trigger type. |
@Retention(value = RetentionPolicy.SOURCE)The navigation restriction identifier. |
@Retention(value = RetentionPolicy.SOURCE)The snap identifier. |
@Retention(value = RetentionPolicy.SOURCE)The timeline occupies identifier. |
@Retention(value = RetentionPolicy.SOURCE)The timeline style identifier. |
Constants |
|
|---|---|
const String! |
CUE_TRIGGER_ONCE = "ONCE"Cue trigger type indicating to trigger the interstitial only once. |
const String! |
CUE_TRIGGER_POST = "POST"Cue trigger type indicating to trigger the interstitial after playback of the primary asset. |
const String! |
CUE_TRIGGER_PRE = "PRE"Cue trigger type indicating to trigger the interstitial before playback of the primary asset. |
const String! |
NAVIGATION_RESTRICTION_JUMP = "JUMP"Navigation restriction identifier indicating to enforce playback of the interstitial if the user attempts to seek beyond the interstitial start position. |
const String! |
NAVIGATION_RESTRICTION_SKIP = "SKIP"Navigation restriction identifier indicating to prevent seeking or changing the playback speed during the interstitial being played. |
const String! |
SNAP_TYPE_IN = "IN"Snap identifier indicating to locate the segment boundary closest to the scheduled resumption point of the interstitial. |
const String! |
SNAP_TYPE_OUT = "OUT"Snap identifier indicating to locate the segment boundary closest to the |
const String! |
TIMELINE_OCCUPIES_POINT = "POINT"Timeline occupies identifier indicating to present the interstitial as a single point. |
const String! |
TIMELINE_OCCUPIES_RANGE = "RANGE"Timeline occupies identifier indicating to present the interstitial as a range. |
const String! |
TIMELINE_STYLE_HIGHLIGHT = "HIGHLIGHT"Timeline style identifier indicating to present the interstitial as distinct from the content. |
const String! |
TIMELINE_STYLE_PRIMARY = "PRIMARY"Timeline style identifier indicating not to differentiate the interstitial from the content. |
Public constructors |
|---|
Interstitial(Creates an instance. |
Public properties |
|
|---|---|
Uri? |
The asset list URI. |
Uri? |
The asset URI. |
ImmutableList<HlsMediaPlaylist.ClientDefinedAttribute!>! |
The attributes defined by a client. |
Boolean |
Whether the content may vary between clients. |
(Mutable)List<@HlsMediaPlaylist.Interstitial.CueTriggerType String!>! |
The trigger cue types. |
Long |
The optional duration, in microseconds. |
Long |
The optional end time, in microseconds. |
Boolean |
Whether the |
String! |
The required ID. |
Long |
The optional planned duration, in microseconds. |
Long |
The playout limit indicating the limit of the playback time of the interstitial. |
ImmutableList<@HlsMediaPlaylist.Interstitial.NavigationRestriction String!>! |
The navigation restrictions. |
Long |
The offset from |
ImmutableList<@HlsMediaPlaylist.Interstitial.SnapType String!>! |
The snap types. |
Long |
The required start time, in microseconds. |
@HlsMediaPlaylist.Interstitial.TimelineOccupiesType String! |
The timeline occupies type. |
@HlsMediaPlaylist.Interstitial.TimelineStyleType String! |
The timeline style type. |
Constants
CUE_TRIGGER_ONCE
const val CUE_TRIGGER_ONCE = "ONCE": String!
Cue trigger type indicating to trigger the interstitial only once.
CUE_TRIGGER_POST
const val CUE_TRIGGER_POST = "POST": String!
Cue trigger type indicating to trigger the interstitial after playback of the primary asset.
CUE_TRIGGER_PRE
const val CUE_TRIGGER_PRE = "PRE": String!
Cue trigger type indicating to trigger the interstitial before playback of the primary asset.
NAVIGATION_RESTRICTION_JUMP
const val NAVIGATION_RESTRICTION_JUMP = "JUMP": String!
Navigation restriction identifier indicating to enforce playback of the interstitial if the user attempts to seek beyond the interstitial start position.
NAVIGATION_RESTRICTION_SKIP
const val NAVIGATION_RESTRICTION_SKIP = "SKIP": String!
Navigation restriction identifier indicating to prevent seeking or changing the playback speed during the interstitial being played.
SNAP_TYPE_IN
const val SNAP_TYPE_IN = "IN": String!
Snap identifier indicating to locate the segment boundary closest to the scheduled resumption point of the interstitial.
SNAP_TYPE_OUT
const val SNAP_TYPE_OUT = "OUT": String!
Snap identifier indicating to locate the segment boundary closest to the startDateUnixUs.
TIMELINE_OCCUPIES_POINT
const val TIMELINE_OCCUPIES_POINT = "POINT": String!
Timeline occupies identifier indicating to present the interstitial as a single point.
TIMELINE_OCCUPIES_RANGE
const val TIMELINE_OCCUPIES_RANGE = "RANGE": String!
Timeline occupies identifier indicating to present the interstitial as a range.
TIMELINE_STYLE_HIGHLIGHT
const val TIMELINE_STYLE_HIGHLIGHT = "HIGHLIGHT": String!
Timeline style identifier indicating to present the interstitial as distinct from the content.
TIMELINE_STYLE_PRIMARY
const val TIMELINE_STYLE_PRIMARY = "PRIMARY": String!
Timeline style identifier indicating not to differentiate the interstitial from the content.
Public constructors
Interstitial
Interstitial(
id: String!,
assetUri: Uri?,
assetListUri: Uri?,
startDateUnixUs: Long,
endDateUnixUs: Long,
durationUs: Long,
plannedDurationUs: Long,
cue: (Mutable)List<@HlsMediaPlaylist.Interstitial.CueTriggerType String!>!,
endOnNext: Boolean,
resumeOffsetUs: Long,
playoutLimitUs: Long,
snapTypes: (Mutable)List<@HlsMediaPlaylist.Interstitial.SnapType String!>!,
restrictions: (Mutable)List<@HlsMediaPlaylist.Interstitial.NavigationRestriction String!>!,
clientDefinedAttributes: (Mutable)List<HlsMediaPlaylist.ClientDefinedAttribute!>!,
contentMayVary: Boolean,
@HlsMediaPlaylist.Interstitial.TimelineOccupiesType timelineOccupies: @HlsMediaPlaylist.Interstitial.TimelineOccupiesType String!,
@HlsMediaPlaylist.Interstitial.TimelineStyleType timelineStyle: @HlsMediaPlaylist.Interstitial.TimelineStyleType String!
)
Creates an instance.
Public properties
clientDefinedAttributes
val clientDefinedAttributes: ImmutableList<HlsMediaPlaylist.ClientDefinedAttribute!>!
The attributes defined by a client. For informational purpose only.
cue
val cue: (Mutable)List<@HlsMediaPlaylist.Interstitial.CueTriggerType String!>!
The trigger cue types.
endDateUnixUs
val endDateUnixUs: Long
The optional end time, in microseconds. TIME_UNSET if not present.
endOnNext
val endOnNext: Boolean
Whether the endDateUnixUs of the interstitial is equal to the start startTimeUs of the following interstitial. false if not present.
plannedDurationUs
val plannedDurationUs: Long
The optional planned duration, in microseconds. TIME_UNSET if not present.
playoutLimitUs
val playoutLimitUs: Long
The playout limit indicating the limit of the playback time of the interstitial.
restrictions
val restrictions: ImmutableList<@HlsMediaPlaylist.Interstitial.NavigationRestriction String!>!
The navigation restrictions.
resumeOffsetUs
val resumeOffsetUs: Long
The offset from startTimeUs indicating where in the primary asset to resume playback after completing playback of the interstitial. TIME_UNSET if not present. If not present, the value is considered to be the duration of the interstitial.
snapTypes
val snapTypes: ImmutableList<@HlsMediaPlaylist.Interstitial.SnapType String!>!
The snap types.
timelineOccupies
@HlsMediaPlaylist.Interstitial.TimelineOccupiesType
val timelineOccupies: @HlsMediaPlaylist.Interstitial.TimelineOccupiesType String!
The timeline occupies type.
timelineStyle
@HlsMediaPlaylist.Interstitial.TimelineStyleType
val timelineStyle: @HlsMediaPlaylist.Interstitial.TimelineStyleType String!
The timeline style type.