Enum Class DebugLevel

java.lang.Object

java.lang.Enum<DebugLevel>

org.freedesktop.gstreamer.gst.DebugLevel

All Implemented Interfaces:

Serializable, Comparable<DebugLevel>, Constable, Enumeration

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

The level defines the importance of a debugging message. The more important a message is, the greater the probability that the debugging system outputs it.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COUNT	The number of defined debugging levels.
DEBUG	Debugging messages should be used when something common happens that is not the expected default behavior, or something that's useful to know but doesn't happen all the time (ie. per loop iteration or buffer processed or event handled).
ERROR	Error messages are to be used only when an error occurred that stops the application from keeping working correctly.
FIXME	Fixme messages are messages that indicate that something in the executed code path is not fully implemented or handled yet.
INFO	Informational messages should be used to keep the developer updated about what is happening.
LOG	Log messages are messages that are very common but might be useful to know.
MEMDUMP	memory dump messages are used to log (small) chunks of data as memory dumps in the log.
NONE	No debugging level specified or desired.
TRACE	Tracing-related messages.
WARNING	Warning messages are to inform about abnormal behaviour that could lead to problems or weird behaviour later on.

Method Summary

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

NONE

public static final DebugLevel NONE

No debugging level specified or desired. Used to deactivate debugging output.

ERROR

public static final DebugLevel ERROR

Error messages are to be used only when an error occurred that stops the application from keeping working correctly. An examples is gst_element_error, which outputs a message with this priority. It does not mean that the application is terminating as with g_error.

WARNING

public static final DebugLevel WARNING

Warning messages are to inform about abnormal behaviour that could lead to problems or weird behaviour later on. An example of this would be clocking issues ("your computer is pretty slow") or broken input data ("Can't synchronize to stream.")

FIXME

public static final DebugLevel FIXME

Fixme messages are messages that indicate that something in the executed code path is not fully implemented or handled yet. Note that this does not replace proper error handling in any way, the purpose of this message is to make it easier to spot incomplete/unfinished pieces of code when reading the debug log.

INFO

public static final DebugLevel INFO

Informational messages should be used to keep the developer updated about what is happening. Examples where this should be used are when a typefind function has successfully determined the type of the stream or when an mp3 plugin detects the format to be used. ("This file has mono sound.")

DEBUG

public static final DebugLevel DEBUG

Debugging messages should be used when something common happens that is not the expected default behavior, or something that's useful to know but doesn't happen all the time (ie. per loop iteration or buffer processed or event handled). An example would be notifications about state changes or receiving/sending of events.

LOG

public static final DebugLevel LOG

Log messages are messages that are very common but might be useful to know. As a rule of thumb a pipeline that is running as expected should never output anything else but LOG messages whilst processing data. Use this log level to log recurring information in chain functions and loop functions, for example.

TRACE

public static final DebugLevel TRACE

Tracing-related messages. Examples for this are referencing/dereferencing of objects.

MEMDUMP

public static final DebugLevel MEMDUMP

memory dump messages are used to log (small) chunks of data as memory dumps in the log. They will be displayed as hexdump with ASCII characters.

COUNT

public static final DebugLevel COUNT

The number of defined debugging levels.

Method Details

values

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

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

Create a new DebugLevel 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 DebugLevel class.

Returns:

the GType

getName

public String getName()

Get the string representation of a debugging level

Returns:

the name