public final class

ChapterFrame

extends Id3Frame

 java.lang.Object

androidx.media3.extractor.metadata.id3.Id3Frame

↳androidx.media3.extractor.metadata.id3.ChapterFrame

Gradle dependencies

compile group: 'androidx.media3', name: 'media3-extractor', version: '1.0.0-alpha03'

  • groupId: androidx.media3
  • artifactId: media3-extractor
  • version: 1.0.0-alpha03

Artifact androidx.media3:media3-extractor:1.0.0-alpha03 it located at Google repository (https://maven.google.com/)

Overview

Chapter information ID3 frame.

Summary

Fields
public final java.lang.StringchapterId

public static final <any>CREATOR

public final longendOffset

The byte offset of the end of the chapter, or C.POSITION_UNSET if not set.

public final intendTimeMs

public static final java.lang.StringID

public final longstartOffset

The byte offset of the start of the chapter, or C.POSITION_UNSET if not set.

public final intstartTimeMs

from Id3Frameid
Constructors
publicChapterFrame(java.lang.String chapterId, int startTimeMs, int endTimeMs, long startOffset, long endOffset, Id3Frame subFrames[])

Methods
public intdescribeContents()

public booleanequals(java.lang.Object obj)

public Id3FramegetSubFrame(int index)

Returns the sub-frame at index.

public intgetSubFrameCount()

Returns the number of sub-frames.

public inthashCode()

public voidwriteToParcel(Parcel dest, int flags)

from Id3FrametoString
from java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, wait

Fields

public static final java.lang.String ID

public final java.lang.String chapterId

public final int startTimeMs

public final int endTimeMs

public final long startOffset

The byte offset of the start of the chapter, or C.POSITION_UNSET if not set.

public final long endOffset

The byte offset of the end of the chapter, or C.POSITION_UNSET if not set.

public static final <any> CREATOR

Constructors

public ChapterFrame(java.lang.String chapterId, int startTimeMs, int endTimeMs, long startOffset, long endOffset, Id3Frame subFrames[])

Methods

public int getSubFrameCount()

Returns the number of sub-frames.

public Id3Frame getSubFrame(int index)

Returns the sub-frame at index.

public boolean equals(java.lang.Object obj)

public int hashCode()

public void writeToParcel(Parcel dest, int flags)

public int describeContents()

Source

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package androidx.media3.extractor.metadata.id3;

import static androidx.media3.common.util.Util.castNonNull;

import android.os.Parcel;
import androidx.annotation.Nullable;
import androidx.media3.common.C;
import androidx.media3.common.util.UnstableApi;
import androidx.media3.common.util.Util;
import java.util.Arrays;

/** Chapter information ID3 frame. */
@UnstableApi
public final class ChapterFrame extends Id3Frame {

  public static final String ID = "CHAP";

  public final String chapterId;
  public final int startTimeMs;
  public final int endTimeMs;
  /** The byte offset of the start of the chapter, or {@link C#POSITION_UNSET} if not set. */
  public final long startOffset;
  /** The byte offset of the end of the chapter, or {@link C#POSITION_UNSET} if not set. */
  public final long endOffset;

  private final Id3Frame[] subFrames;

  public ChapterFrame(
      String chapterId,
      int startTimeMs,
      int endTimeMs,
      long startOffset,
      long endOffset,
      Id3Frame[] subFrames) {
    super(ID);
    this.chapterId = chapterId;
    this.startTimeMs = startTimeMs;
    this.endTimeMs = endTimeMs;
    this.startOffset = startOffset;
    this.endOffset = endOffset;
    this.subFrames = subFrames;
  }

  /* package */ ChapterFrame(Parcel in) {
    super(ID);
    this.chapterId = castNonNull(in.readString());
    this.startTimeMs = in.readInt();
    this.endTimeMs = in.readInt();
    this.startOffset = in.readLong();
    this.endOffset = in.readLong();
    int subFrameCount = in.readInt();
    subFrames = new Id3Frame[subFrameCount];
    for (int i = 0; i < subFrameCount; i++) {
      subFrames[i] = in.readParcelable(Id3Frame.class.getClassLoader());
    }
  }

  /** Returns the number of sub-frames. */
  public int getSubFrameCount() {
    return subFrames.length;
  }

  /** Returns the sub-frame at {@code index}. */
  public Id3Frame getSubFrame(int index) {
    return subFrames[index];
  }

  @Override
  public boolean equals(@Nullable Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null || getClass() != obj.getClass()) {
      return false;
    }
    ChapterFrame other = (ChapterFrame) obj;
    return startTimeMs == other.startTimeMs
        && endTimeMs == other.endTimeMs
        && startOffset == other.startOffset
        && endOffset == other.endOffset
        && Util.areEqual(chapterId, other.chapterId)
        && Arrays.equals(subFrames, other.subFrames);
  }

  @Override
  public int hashCode() {
    int result = 17;
    result = 31 * result + startTimeMs;
    result = 31 * result + endTimeMs;
    result = 31 * result + (int) startOffset;
    result = 31 * result + (int) endOffset;
    result = 31 * result + (chapterId != null ? chapterId.hashCode() : 0);
    return result;
  }

  @Override
  public void writeToParcel(Parcel dest, int flags) {
    dest.writeString(chapterId);
    dest.writeInt(startTimeMs);
    dest.writeInt(endTimeMs);
    dest.writeLong(startOffset);
    dest.writeLong(endOffset);
    dest.writeInt(subFrames.length);
    for (Id3Frame subFrame : subFrames) {
      dest.writeParcelable(subFrame, 0);
    }
  }

  @Override
  public int describeContents() {
    return 0;
  }

  public static final Creator<ChapterFrame> CREATOR =
      new Creator<ChapterFrame>() {

        @Override
        public ChapterFrame createFromParcel(Parcel in) {
          return new ChapterFrame(in);
        }

        @Override
        public ChapterFrame[] newArray(int size) {
          return new ChapterFrame[size];
        }
      };
}