Class (GI Struct)

Gst-1.0 ▶ Gst ▶ StreamError

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

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

$gtype CODEC_NOT_FOUND DECODE DECRYPT DECRYPT_NOKEY DEMUX ENCODE FAILED FORMAT MUX NOT_IMPLEMENTED NUM_ERRORS TOO_LAZY TYPE_NOT_FOUND WRONG_TYPE

Properties - Inherited from GLib

code domain message stack

Methods

quark

Methods - Inherited from GLib

copy free matches domain_register domain_register_static new_literal

Constructors

Properties

$gtype: GType<GLib.Error>
CODEC_NOT_FOUND: number

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

DECODE: number

used when decoding fails.

DECRYPT: number

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

DECRYPT_NOKEY: number

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

DEMUX: number

used when demuxing fails.

ENCODE: number

used when encoding fails.

FAILED: number

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

FORMAT: number

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

MUX: number

used when muxing fails.

NOT_IMPLEMENTED: number

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

NUM_ERRORS: number

the number of stream error types.

TOO_LAZY: number

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

TYPE_NOT_FOUND: number

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

WRONG_TYPE: number

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

Properties - Inherited from GLib

code: number
domain: number
message: string
stack: string

Methods

Methods - Inherited from GLib

  • Returns true if error matches domain and code, false otherwise. In particular, when error is null, false will be returned.

    If domain contains a FAILED (or otherwise generic) error code, you should generally not check for it explicitly, but should instead treat any not-explicitly-recognized error code as being equivalent to the FAILED code. This way, if the domain is extended in the future to provide a more specific error code for a certain case, your code will still work.

    Parameters

    • domain: number | (new (...args: any[]) => GLib.Error)

      an error domain

    • code: number

      an error code

    Returns boolean

    whether error has domain and code

  • This function registers an extended GLib.Error domain. error_type_name will be duplicated. Otherwise does the same as g_error_domain_register_static().

    Parameters

    • error_type_name: string

      string to create a GLib.Quark from

    • error_type_private_size: number

      size of the private error data in bytes

    • error_type_init: ErrorInitFunc

      function initializing fields of the private error data

    • error_type_copy: ErrorCopyFunc

      function copying fields of the private error data

    • error_type_clear: ErrorClearFunc

      function freeing fields of the private error data

    Returns number

  • This function registers an extended GLib.Error domain.

    error_type_name should not be freed. error_type_private_size must be greater than 0.

    error_type_init receives an initialized GLib.Error and should then initialize the private data.

    error_type_copy is a function that receives both original and a copy GLib.Error and should copy the fields of the private error data. The standard GLib.Error fields are already handled.

    error_type_clear receives the pointer to the error, and it should free the fields of the private error data. It should not free the struct itself though.

    Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it already takes care of passing valid information to this function.

    Parameters

    • error_type_name: string

      static string to create a GLib.Quark from

    • error_type_private_size: number

      size of the private error data in bytes

    • error_type_init: ErrorInitFunc

      function initializing fields of the private error data

    • error_type_copy: ErrorCopyFunc

      function copying fields of the private error data

    • error_type_clear: ErrorClearFunc

      function freeing fields of the private error data

    Returns number