Class MetadataConfiguration

java.lang.Object
com.castlabs.android.player.MetadataConfiguration
All Implemented Interfaces:
Parcelable

public final class MetadataConfiguration extends Object implements Parcelable
Configuration for metadata rendering.

This configuration allows customizing when metadata is output and how pending metadata is handled.

  • Field Details

    • DEFAULT_OUTPUT_METADATA_EARLY

      public static final boolean DEFAULT_OUTPUT_METADATA_EARLY
      Default value for whether metadata is output immediately after it is decoded false
      See Also:
    • DEFAULT_END_OF_STREAM_METADATA_THRESHOLD_US

      public static final long DEFAULT_END_OF_STREAM_METADATA_THRESHOLD_US
      Default end-of-stream metadata threshold, in microseconds.

      A value of 0 causes pending metadata beyond the period duration to be discarded immediately when playback reaches the end of the period.

      See Also:
    • DISABLE_END_OF_STREAM_METADATA_THRESHOLD_US

      public static final long DISABLE_END_OF_STREAM_METADATA_THRESHOLD_US
      Disables end-of-stream metadata threshold handling.

      When set, pending metadata is never discarded solely because its presentation time is beyond the period duration.

      See Also:
    • DEFAULT

      @NonNull public static final MetadataConfiguration DEFAULT
    • outputMetadataEarly

      public final boolean outputMetadataEarly
      Whether metadata is output immediately after it is decoded instead of at its presentation time.
    • endOfStreamMetadataThresholdUs

      public final long endOfStreamMetadataThresholdUs
      The time, in microseconds, that the renderer waits after reaching the end of a media period before discarding pending metadata with presentation time beyond the period duration.

      Use 0 to discard such metadata immediately at the end of the period, or DISABLE_END_OF_STREAM_METADATA_THRESHOLD_US to disable this behavior.

    • CREATOR

      public static final Parcelable.Creator<MetadataConfiguration> CREATOR
      Creator for MetadataConfiguration from a Parcel.
  • Method Details