EventStream.java

/*
 * 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.exoplayer.dash.manifest;

import androidx.media3.common.util.UnstableApi;
import androidx.media3.extractor.metadata.emsg.EventMessage;

/** A DASH in-MPD EventStream element, as defined by ISO/IEC 23009-1, 2nd edition, section 5.10. */
@UnstableApi
public final class EventStream {

  /** {@link EventMessage}s in the event stream. */
  public final EventMessage[] events;

  /** Presentation time of the events in microsecond, sorted in ascending order. */
  public final long[] presentationTimesUs;

  /** The scheme URI. */
  public final String schemeIdUri;

  /** The value of the event stream. Use empty string if not defined in manifest. */
  public final String value;

  /** The timescale in units per seconds, as defined in the manifest. */
  public final long timescale;

  public EventStream(
      String schemeIdUri,
      String value,
      long timescale,
      long[] presentationTimesUs,
      EventMessage[] events) {
    this.schemeIdUri = schemeIdUri;
    this.value = value;
    this.timescale = timescale;
    this.presentationTimesUs = presentationTimesUs;
    this.events = events;
  }

  /** A constructed id of this {@link EventStream}. Equal to {@code schemeIdUri + "/" + value}. */
  public String id() {
    return schemeIdUri + "/" + value;
  }
}