Enum Class AudioFormat
- All Implemented Interfaces:
Serializable, Comparable<AudioFormat>, Constable, Enumeration
@Generated("org.javagi.JavaGI")
public enum AudioFormat
extends Enum<AudioFormat>
implements Enumeration
Enum value describing the most common audio formats.
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionencoded audio format32-bit floating point samples, big endian32-bit floating point samples, little endian64-bit floating point samples, big endian64-bit floating point samples, little endian16 bits in 16 bits, signed, big endian16 bits in 16 bits, signed, little endian18 bits in 24 bits, signed, big endian18 bits in 24 bits, signed, little endian20 bits in 24 bits, signed, big endian20 bits in 24 bits, signed, little endian24 bits in 32 bits, signed, big endian24 bits in 32 bits, signed, little endian24 bits in 24 bits, signed, big endian24 bits in 24 bits, signed, little endian32 bits in 32 bits, signed, big endian32 bits in 32 bits, signed, little endian8 bits in 8 bits, signed16 bits in 16 bits, unsigned, big endian16 bits in 16 bits, unsigned, little endian18 bits in 24 bits, unsigned, big endian18 bits in 24 bits, unsigned, little endian20 bits in 24 bits, unsigned, big endian20 bits in 24 bits, unsigned, little endian24 bits in 32 bits, unsigned, big endian24 bits in 32 bits, unsigned, little endian24 bits in 24 bits, unsigned, big endian24 bits in 24 bits, unsigned, little endian32 bits in 32 bits, unsigned, big endian32 bits in 32 bits, unsigned, little endian8 bits in 8 bits, unsignedunknown or unset audio format -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AudioFormat32-bit floating point samples, native endiannessstatic final AudioFormat64-bit floating point samples, native endiannessstatic final AudioFormat16 bits in 16 bits, signed, native endiannessstatic final AudioFormat18 bits in 24 bits, signed, native endiannessstatic final AudioFormat20 bits in 24 bits, signed, native endiannessstatic final AudioFormat24 bits in 24 bits, signed, native endiannessstatic final AudioFormat24 bits in 32 bits, signed, native endiannessstatic final AudioFormat32 bits in 32 bits, signed, native endiannessstatic final AudioFormat16 bits in 16 bits, unsigned, native endiannessstatic final AudioFormat18 bits in 24 bits, unsigned, native endiannessstatic final AudioFormat20 bits in 24 bits, unsigned, native endiannessstatic final AudioFormat24 bits in 24 bits, unsigned, native endiannessstatic final AudioFormat24 bits in 32 bits, unsigned, native endiannessstatic final AudioFormat32 bits in 32 bits, unsigned, native endianness -
Method Summary
Modifier and TypeMethodDescriptionstatic AudioFormatbuildInteger(boolean sign, int endianness, int width, int depth) Construct aGstAudioFormatwith given parameters.static voidfillSilence(AudioFormatInfo info, @Nullable byte @Nullable [] dest) Deprecated.Use gst_audio_format_info_fill_silence() instead.static AudioFormatfromString(String format) Convert theformatstring to itsGstAudioFormat.getInfo()Get theGstAudioFormatInfofor this AudioFormatstatic @Nullable TypegetType()Get the GType of the AudioFormat class.intgetValue()Get the numeric value of this enumstatic AudioFormatof(int value) Create a new AudioFormat for the provided valuestatic AudioFormatof(MemorySegment address) Create a new AudioFormat for the value in the provided memory address.toString()Returns a string containing a descriptive name for theGstAudioFormat.static AudioFormatReturns the enum constant of this class with the specified name.static AudioFormat[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNKNOWN
unknown or unset audio format -
ENCODED
encoded audio format -
S8
8 bits in 8 bits, signed -
U8
8 bits in 8 bits, unsigned -
S16LE
16 bits in 16 bits, signed, little endian -
S16BE
16 bits in 16 bits, signed, big endian -
U16LE
16 bits in 16 bits, unsigned, little endian -
U16BE
16 bits in 16 bits, unsigned, big endian -
S24_32LE
24 bits in 32 bits, signed, little endian -
S24_32BE
24 bits in 32 bits, signed, big endian -
U24_32LE
24 bits in 32 bits, unsigned, little endian -
U24_32BE
24 bits in 32 bits, unsigned, big endian -
S32LE
32 bits in 32 bits, signed, little endian -
S32BE
32 bits in 32 bits, signed, big endian -
U32LE
32 bits in 32 bits, unsigned, little endian -
U32BE
32 bits in 32 bits, unsigned, big endian -
S24LE
24 bits in 24 bits, signed, little endian -
S24BE
24 bits in 24 bits, signed, big endian -
U24LE
24 bits in 24 bits, unsigned, little endian -
U24BE
24 bits in 24 bits, unsigned, big endian -
S20LE
20 bits in 24 bits, signed, little endian -
S20BE
20 bits in 24 bits, signed, big endian -
U20LE
20 bits in 24 bits, unsigned, little endian -
U20BE
20 bits in 24 bits, unsigned, big endian -
S18LE
18 bits in 24 bits, signed, little endian -
S18BE
18 bits in 24 bits, signed, big endian -
U18LE
18 bits in 24 bits, unsigned, little endian -
U18BE
18 bits in 24 bits, unsigned, big endian -
F32LE
32-bit floating point samples, little endian -
F32BE
32-bit floating point samples, big endian -
F64LE
64-bit floating point samples, little endian -
F64BE
64-bit floating point samples, big endian
-
-
Field Details
-
S16
16 bits in 16 bits, signed, native endianness -
U16
16 bits in 16 bits, unsigned, native endianness -
S24_32
24 bits in 32 bits, signed, native endianness -
U24_32
24 bits in 32 bits, unsigned, native endianness -
S32
32 bits in 32 bits, signed, native endianness -
U32
32 bits in 32 bits, unsigned, native endianness -
S24
24 bits in 24 bits, signed, native endianness -
U24
24 bits in 24 bits, unsigned, native endianness -
S20
20 bits in 24 bits, signed, native endianness -
U20
20 bits in 24 bits, unsigned, native endianness -
S18
18 bits in 24 bits, signed, native endianness -
U18
18 bits in 24 bits, unsigned, native endianness -
F32
32-bit floating point samples, native endianness -
F64
64-bit floating point samples, native endianness
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
of
Create a new AudioFormat 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:
getValuein interfaceEnumeration- Returns:
- the enum value
-
of
Create a new AudioFormat 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
-
buildInteger
Construct aGstAudioFormatwith given parameters.- Parameters:
sign- signed or unsigned formatendianness- G_LITTLE_ENDIAN or G_BIG_ENDIANwidth- amount of bits used per sampledepth- amount of used bits inwidth- Returns:
- a
GstAudioFormator GST_AUDIO_FORMAT_UNKNOWN when no audio format exists with the given parameters.
-
fillSilence
Deprecated.Use gst_audio_format_info_fill_silence() instead.Filllengthbytes indestwith silence samples forinfo.- Parameters:
info- aGstAudioFormatInfodest- a destination to fill
-
fromString
Convert theformatstring to itsGstAudioFormat.- Parameters:
format- a format string- Returns:
- the
GstAudioFormatforformator GST_AUDIO_FORMAT_UNKNOWN when the string is not a known format.
-
getInfo
Get theGstAudioFormatInfofor this AudioFormat- Returns:
- The
GstAudioFormatInfoforformat.
-
toString
Returns a string containing a descriptive name for the
GstAudioFormat.Since 1.26 this can also be used with
UNKNOWN, previous versions were printing a critical warning and returnednull.- Overrides:
toStringin classEnum<AudioFormat>- Returns:
- the name corresponding to this AudioFormat
-