# ChapterTocFrame

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/id3/ChapterTocFrame.java+class:androidx.media3.extractor.metadata.id3.ChapterTocFrame)

*** ** * ** ***

<br />

```
@UnstableApi
class ChapterTocFrame : Id3Frame
```

<br />

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

*** ** * ** ***

Chapter table of contents ID3 frame.

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#ID() = "CTOC"` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#ChapterTocFrame(java.lang.String,boolean,boolean,java.lang.String[],androidx.media3.extractor.metadata.id3.Id3Frame[])( elementId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!, isRoot: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, isOrdered: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, children: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>!, subFrames: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/Id3Frame!>! )` |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#equals(java.lang.Object)(obj: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/Id3Frame!` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#getSubFrame(int)(index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns the sub-frame at `index`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#getSubFrameCount()()` Returns the number of sub-frames. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#hashCode()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>!` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#children()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#elementId()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#isOrdered()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/ChapterTocFrame#isRoot()` |

### Inherited functions

From [androidx.media3.extractor.metadata.id3.Id3Frame](https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/Id3Frame) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/Id3Frame#toString()()` 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`.

### Inherited properties

From [androidx.media3.extractor.metadata.id3.Id3Frame](https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/Id3Frame) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` `https://developer.android.com/reference/kotlin/androidx/media3/extractor/metadata/id3/Id3Frame#id()`

The frame ID.

## Constants

### ID

```
const val ID = "CTOC": String!
```

## Public constructors

### ChapterTocFrame

```
ChapterTocFrame(
    elementId: String!,
    isRoot: Boolean,
    isOrdered: Boolean,
    children: Array<String!>!,
    subFrames: Array<Id3Frame!>!
)
```

## Public functions

### equals

```
fun equals(obj: Any?): Boolean
```

### getSubFrame

```
fun getSubFrame(index: Int): Id3Frame!
```

Returns the sub-frame at `index`.

### getSubFrameCount

```
fun getSubFrameCount(): Int
```

Returns the number of sub-frames.

### hashCode

```
fun hashCode(): Int
```

## Public properties

### children

```
val children: Array<String!>!
```

### elementId

```
val elementId: String!
```

### isOrdered

```
val isOrdered: Boolean
```

### isRoot

```
val isRoot: Boolean
```