# SpliceInsertCommand

Artifact: [androidx.media3:media3-extractor](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/extractor/metadata/scte35/SpliceInsertCommand.java+class:androidx.media3.extractor.metadata.scte35.SpliceInsertCommand)

*** ** * ** ***

<br />

```
@UnstableApi
class SpliceInsertCommand : SpliceCommand
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.media3.extractor.metadata.scte35.SpliceCommand](https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceCommand) ||
|   | ↳ | [androidx.media3.extractor.metadata.scte35.SpliceInsertCommand](https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand) |

*** ** * ** ***

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

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand.ComponentSplice` Holds splicing information for specific splice insert command components. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#autoReturn()` If `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#breakDurationUs()` is not `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_UNSET()`, defines whether `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#breakDurationUs()` should be used to know when to return to the network feed. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#availNum()` Holds the value of `avail_num` as defined in SCTE35, Section 9.3.3. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#availsExpected()` Holds the value of `avails_expected` as defined in SCTE35, Section 9.3.3. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#breakDurationUs()` The duration of the splice in microseconds, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_UNSET()` if no duration is present. |
| `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand.ComponentSplice!>!` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#componentSpliceList()` If `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSpliceFlag()` is false, a non-empty list containing the `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand.ComponentSplice`s. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#outOfNetworkIndicator()` If true, the splice event is an opportunity to exit from the network feed. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSpliceFlag()` Whether the splice mode is program splice mode, whereby all PIDs/components are to be spliced. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSplicePlaybackPositionUs()` Equivalent to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSplicePts()` but in the playback timebase. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSplicePts()` If `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSpliceFlag()` is true, the PTS at which the program splice should occur. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#spliceEventCancelIndicator()` True if the event with id `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#spliceEventId()` has been canceled. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#spliceEventId()` The splice event id. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#spliceImmediateFlag()` Whether splicing should be done at the nearest opportunity. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#uniqueProgramId()` The unique program id as defined in SCTE35, Section 9.3.3. |

### Inherited functions

From [androidx.media3.common.Metadata.Entry](https://developer.android.com/reference/kotlin/androidx/media3/common/Metadata.Entry) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte/index.html>?` `https://developer.android.com/reference/kotlin/androidx/media3/common/Metadata.Entry#getWrappedMetadataBytes()()`

Returns the bytes of the wrapped metadata in this Entry, or null if it doesn't contain wrapped metadata.
`https://developer.android.com/reference/kotlin/androidx/media3/common/Format?` `https://developer.android.com/reference/kotlin/androidx/media3/common/Metadata.Entry#getWrappedMetadataFormat()()`

Returns the `https://developer.android.com/reference/kotlin/androidx/media3/common/Format` that can be used to decode the wrapped metadata in `https://developer.android.com/reference/kotlin/androidx/media3/common/Metadata.Entry#getWrappedMetadataBytes()`, or null if this Entry doesn't contain wrapped metadata.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/common/Metadata.Entry#populateMediaMetadata(androidx.media3.common.MediaMetadata.Builder)(builder: https://developer.android.com/reference/kotlin/androidx/media3/common/MediaMetadata.Builder!)`

Updates the `https://developer.android.com/reference/kotlin/androidx/media3/common/MediaMetadata.Builder` with the type-specific values stored in this ` Entry`.

## Public functions

### toString

```
fun toString(): String!
```

## Public properties

### autoReturn

```
val autoReturn: Boolean
```

If `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#breakDurationUs()` is not `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_UNSET()`, defines whether `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#breakDurationUs()` should be used to know when to return to the network feed. If `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#breakDurationUs()` is `https://developer.android.com/reference/kotlin/androidx/media3/common/C#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 `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_UNSET()` if no duration is present.

### componentSpliceList

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

If `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSpliceFlag()` is false, a non-empty list containing the `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand.ComponentSplice`s. 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 `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSplicePts()` but in the playback timebase.

### programSplicePts

```
val programSplicePts: Long
```

If `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSpliceFlag()` is true, the PTS at which the program splice should occur. `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_UNSET()` otherwise.

### spliceEventCancelIndicator

```
val spliceEventCancelIndicator: Boolean
```

True if the event with id `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#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 `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSplicePlaybackPositionUs()` or `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand.ComponentSplice#componentSplicePlaybackPositionUs()`, depending on `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/scte35/SpliceInsertCommand#programSpliceFlag()`.

### uniqueProgramId

```
val uniqueProgramId: Int
```

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