SpliceInsertCommand

@UnstableApi
class SpliceInsertCommand : SpliceCommand

kotlin.Any
   ↳ androidx.media3.extractor.metadata.scte35.SpliceCommand
     ↳ androidx.media3.extractor.metadata.scte35.SpliceInsertCommand

Represents a splice insert command defined in SCTE35, Section 9.3.3.

Summary

Nested types

Holds splicing information for specific splice insert command components.

Public functions
String!

Public properties
Boolean

If breakDurationUs is not TIME_UNSET, defines whether breakDurationUs should be used to know when to return to the network feed.
Int

Holds the value of avail_num as defined in SCTE35, Section 9.3.3.
Int

Holds the value of avails_expected as defined in SCTE35, Section 9.3.3.
Long

The duration of the splice in microseconds, or TIME_UNSET if no duration is present.
(Mutable)List<SpliceInsertCommand.ComponentSplice!>!

If programSpliceFlag is false, a non-empty list containing the ComponentSplices.
Boolean

If true, the splice event is an opportunity to exit from the network feed.
Boolean

Whether the splice mode is program splice mode, whereby all PIDs/components are to be spliced.
Long

Equivalent to programSplicePts but in the playback timebase.
Long

If programSpliceFlag is true, the PTS at which the program splice should occur.
Boolean

True if the event with id spliceEventId has been canceled.
Long

The splice event id.
Boolean

Whether splicing should be done at the nearest opportunity.
Int

The unique program id as defined in SCTE35, Section 9.3.3.

Inherited functions
From androidx.media3.common.Metadata.Entry
Array<Byte>?

Returns the bytes of the wrapped metadata in this Entry, or null if it doesn't contain wrapped metadata.
Format?

Returns the Format that can be used to decode the wrapped metadata in getWrappedMetadataBytes, or null if this Entry doesn't contain wrapped metadata.
Unit

Updates the MediaMetadata.Builder with the type-specific values stored in this Entry.

Public functions

toString

fun toString(): String!

Public properties

autoReturn

val autoReturn: Boolean

If breakDurationUs is not TIME_UNSET, defines whether breakDurationUs should be used to know when to return to the network feed. If breakDurationUs is TIME_UNSET, the value is undefined.

availNum

val availNum: Int

Holds the value of avail_num as defined in SCTE35, Section 9.3.3.

availsExpected

val availsExpected: Int

Holds the value of avails_expected as defined in SCTE35, Section 9.3.3.

breakDurationUs

val breakDurationUs: Long

The duration of the splice in microseconds, or TIME_UNSET if no duration is present.

componentSpliceList

val componentSpliceList: (Mutable)List<SpliceInsertCommand.ComponentSplice!>!

If programSpliceFlag is false, a non-empty list containing the ComponentSplices. Otherwise, an empty list.

outOfNetworkIndicator

val outOfNetworkIndicator: Boolean

If true, the splice event is an opportunity to exit from the network feed. If false, indicates an opportunity to return to the network feed.

programSpliceFlag

val programSpliceFlag: Boolean

Whether the splice mode is program splice mode, whereby all PIDs/components are to be spliced. If false, splicing is done per PID/component.

programSplicePlaybackPositionUs

val programSplicePlaybackPositionUs: Long

Equivalent to programSplicePts but in the playback timebase.

programSplicePts

val programSplicePts: Long

If programSpliceFlag is true, the PTS at which the program splice should occur. TIME_UNSET otherwise.

spliceEventCancelIndicator

val spliceEventCancelIndicator: Boolean

True if the event with id spliceEventId has been canceled.

spliceEventId

val spliceEventId: Long

The splice event id.

spliceImmediateFlag

val spliceImmediateFlag: Boolean

Whether splicing should be done at the nearest opportunity. If false, splicing should be done at the moment indicated by programSplicePlaybackPositionUs or componentSplicePlaybackPositionUs, depending on programSpliceFlag.

uniqueProgramId

val uniqueProgramId: Int

The unique program id as defined in SCTE35, Section 9.3.3.