# 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)

*** ** * ** ***


```
@UnstableApi
public final class ChapterTocFrame extends Id3Frame
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.media3.extractor.metadata.id3.Id3Frame](https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/Id3Frame) ||
|   | ↳ | [androidx.media3.extractor.metadata.id3.ChapterTocFrame](https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame) |

*** ** * ** ***

Chapter table of contents ID3 frame.

## Summary

| ### Constants |
|---|---|
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#ID() = "CTOC"` |

| ### Public fields |
|---|---|
| `final String[]` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#children()` |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#elementId()` |
| `final boolean` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#isOrdered()` |
| `final boolean` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#isRoot()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#ChapterTocFrame(java.lang.String,boolean,boolean,java.lang.String[],androidx.media3.extractor.metadata.id3.Id3Frame[])( https://developer.android.com/reference/java/lang/String.html elementId, boolean isRoot, boolean isOrdered, String[] children, Id3Frame[] subFrames )` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#equals(java.lang.Object)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html obj)` |
| `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/Id3Frame` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#getSubFrame(int)(int index)` Returns the sub-frame at `index`. |
| `int` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#getSubFrameCount()()` Returns the number of sub-frames. |
| `int` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/ChapterTocFrame#hashCode()()` |

| ### Inherited fields |
|---|
| From [androidx.media3.extractor.metadata.id3.Id3Frame](https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/Id3Frame) |---|---| | `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/Id3Frame#id()` The frame ID. | |

| ### Inherited methods |
|---|
| From [androidx.media3.extractor.metadata.id3.Id3Frame](https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/Id3Frame) |---|---| | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/extractor/metadata/id3/Id3Frame#toString()()` | |
| From [androidx.media3.common.Metadata.Entry](https://developer.android.com/reference/androidx/media3/common/Metadata.Entry) |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable byte[]` | `https://developer.android.com/reference/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/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/Format` | `https://developer.android.com/reference/androidx/media3/common/Metadata.Entry#getWrappedMetadataFormat()()` Returns the `https://developer.android.com/reference/androidx/media3/common/Format` that can be used to decode the wrapped metadata in `https://developer.android.com/reference/androidx/media3/common/Metadata.Entry#getWrappedMetadataBytes()`, or null if this Entry doesn't contain wrapped metadata. | | `void` | `https://developer.android.com/reference/androidx/media3/common/Metadata.Entry#populateMediaMetadata(androidx.media3.common.MediaMetadata.Builder)(https://developer.android.com/reference/androidx/media3/common/MediaMetadata.Builder builder)` Updates the `https://developer.android.com/reference/androidx/media3/common/MediaMetadata.Builder` with the type-specific values stored in this ` Entry`. | |

## Constants

### ID

```
public static final String ID = "CTOC"
```

## Public fields

### children

```
public final String[] children
```

### elementId

```
public final String elementId
```

### isOrdered

```
public final boolean isOrdered
```

### isRoot

```
public final boolean isRoot
```

## Public constructors

### ChapterTocFrame

```
public ChapterTocFrame(
    String elementId,
    boolean isRoot,
    boolean isOrdered,
    String[] children,
    Id3Frame[] subFrames
)
```

## Public methods

### equals

```
public boolean equals(@Nullable Object obj)
```

### getSubFrame

```
public Id3Frame getSubFrame(int index)
```

Returns the sub-frame at `index`.

### getSubFrameCount

```
public int getSubFrameCount()
```

Returns the number of sub-frames.

### hashCode

```
public int hashCode()
```