Enum Class StreamVolumeFormat

java.lang.Object

java.lang.Enum<StreamVolumeFormat>

org.freedesktop.gstreamer.audio.StreamVolumeFormat

All Implemented Interfaces:

Serializable, Comparable<StreamVolumeFormat>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum StreamVolumeFormat
extends Enum<StreamVolumeFormat>
implements Enumeration

Different representations of a stream volume. gst_stream_volume_convert_volume() allows to convert between the different representations.

Formulas to convert from a linear to a cubic or dB volume are cbrt(val) and 20 * log10 (val).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUBIC	Cubic volume scale
DB	Logarithmic volume scale (dB, amplitude not power)
LINEAR	Linear scale factor, 1.0 = 100%

Method Summary

Modifier and Type	Method	Description
int	getValue()	Get the numeric value of this enum
static StreamVolumeFormat	of(int value)	Create a new StreamVolumeFormat for the provided value
static StreamVolumeFormat	of(MemorySegment address)	Create a new StreamVolumeFormat for the value in the provided memory address.
static StreamVolumeFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StreamVolumeFormat[]	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

LINEAR

public static final StreamVolumeFormat LINEAR

Linear scale factor, 1.0 = 100%

CUBIC

public static final StreamVolumeFormat CUBIC

Cubic volume scale

DB

public static final StreamVolumeFormat DB

Logarithmic volume scale (dB, amplitude not power)

Method Details

values

public static StreamVolumeFormat[] 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 StreamVolumeFormat 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 StreamVolumeFormat of(int value)

Create a new StreamVolumeFormat 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 StreamVolumeFormat of(MemorySegment address)

Create a new StreamVolumeFormat 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