Enum Class StreamError

java.lang.Object

java.lang.Enum<StreamError>

org.freedesktop.gstreamer.gst.StreamError

All Implemented Interfaces:

Serializable, Comparable<StreamError>, Constable, Enumeration

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

Stream errors are for anything related to the stream being processed: format errors, media type errors, ... They're typically used by decoders, demuxers, converters, ...

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CODEC_NOT_FOUND	used when there's no codec to handle the stream's type.
DECODE	used when decoding fails.
DECRYPT	used when the stream is encrypted and can't be decrypted because this is not supported by the element.
DECRYPT_NOKEY	used when the stream is encrypted and can't be decrypted because no suitable key is available.
DEMUX	used when demuxing fails.
ENCODE	used when encoding fails.
FAILED	a general error which doesn't fit in any other category.
FORMAT	used when the stream is of the wrong format (for example, wrong caps).
MUX	used when muxing fails.
NOT_IMPLEMENTED	use this when you do not want to implement this functionality yet.
NUM_ERRORS	the number of stream error types.
TOO_LAZY	do not use this except as a placeholder for deciding where to go while developing code.
TYPE_NOT_FOUND	used when the element doesn't know the stream's type.
WRONG_TYPE	used when the element doesn't handle this type of stream.

Method Summary

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

FAILED

public static final StreamError FAILED

a general error which doesn't fit in any other category. Make sure you add a custom message to the error call.

TOO_LAZY

public static final StreamError TOO_LAZY

do not use this except as a placeholder for deciding where to go while developing code.

NOT_IMPLEMENTED

public static final StreamError NOT_IMPLEMENTED

use this when you do not want to implement this functionality yet.

TYPE_NOT_FOUND

public static final StreamError TYPE_NOT_FOUND

used when the element doesn't know the stream's type.

WRONG_TYPE

public static final StreamError WRONG_TYPE

used when the element doesn't handle this type of stream.

CODEC_NOT_FOUND

public static final StreamError CODEC_NOT_FOUND

used when there's no codec to handle the stream's type.

DECODE

public static final StreamError DECODE

used when decoding fails.

ENCODE

public static final StreamError ENCODE

used when encoding fails.

DEMUX

public static final StreamError DEMUX

used when demuxing fails.

MUX

public static final StreamError MUX

used when muxing fails.

FORMAT

public static final StreamError FORMAT

used when the stream is of the wrong format (for example, wrong caps).

DECRYPT

public static final StreamError DECRYPT

used when the stream is encrypted and can't be decrypted because this is not supported by the element.

DECRYPT_NOKEY

public static final StreamError DECRYPT_NOKEY

used when the stream is encrypted and can't be decrypted because no suitable key is available.

NUM_ERRORS

public static final StreamError NUM_ERRORS

the number of stream error types.

Method Details

values

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

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

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

Returns:

the GType

quark

public static Quark quark()