Enum Class TocScope

java.lang.Object
java.lang.Enum<TocScope>
org.freedesktop.gstreamer.gst.TocScope
All Implemented Interfaces:
Serializable, Comparable<TocScope>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum TocScope extends Enum<TocScope> implements Enumeration
The scope of a TOC.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CURRENT
    TOC for the currently active/selected stream (this is a TOC representing the current stream from start to EOS, and is what a TOC writer / muxer is usually interested in; it will usually be a subset of the global TOC, e.g. just the chapters of the current title, or the chapters selected for playback from the current title)
    GLOBAL
    global TOC representing all selectable options (this is what applications are usually interested in)

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable Type
    getType()
    Get the GType of the TocScope class.
    int
    getValue()
    Get the numeric value of this enum
    static TocScope
    of(int value)
    Create a new TocScope for the provided value
    static TocScope
    of(MemorySegment address)
    Create a new TocScope for the value in the provided memory address.
    static TocScope
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static TocScope[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • GLOBAL

      public static final TocScope GLOBAL
      global TOC representing all selectable options (this is what applications are usually interested in)

    • CURRENT

      public static final TocScope CURRENT
      TOC for the currently active/selected stream (this is a TOC representing the current stream from start to EOS, and is what a TOC writer / muxer is usually interested in; it will usually be a subset of the global TOC, e.g. just the chapters of the current title, or the chapters selected for playback from the current title)

  • Method Details

    • values

      public static TocScope[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TocScope valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • of

      public static TocScope of(int value)
      Create a new TocScope for the provided value
      Parameters:
      value - the enum value
      Returns:
      the enum for the provided value

    • getValue

      public int getValue()
      Get the numeric value of this enum
      Specified by:
      getValue in interface Enumeration
      Returns:
      the enum value

    • of

      public static TocScope of(MemorySegment address)
      Create a new TocScope for the value in the provided memory address.
      Parameters:
      address - the memory address holding a enum value
      Returns:
      the enum for the value in the provided memory address

    • getType

      public static @Nullable Type getType()
      Get the GType of the TocScope class.
      Returns:
      the GType