gstreamermm  1.4.3
Public Types | Public Member Functions | List of all members
Gst::StreamError Class Reference

The GStreamer stream GError type. More...

Inheritance diagram for Gst::StreamError:
Inheritance graph
[legend]
Collaboration diagram for Gst::StreamError:
Collaboration graph
[legend]

Public Types

enum  Code {
  FAILED = 1,
  TOO_LAZY,
  NOT_IMPLEMENTED,
  TYPE_NOT_FOUND,
  WRONG_TYPE,
  CODEC_NOT_FOUND,
  DECODE,
  ENCODE,
  DEMUX,
  MUX,
  FORMAT,
  DECRYPT,
  DECRYPT_NOKEY,
  NUM_ERRORS
}
 

Public Member Functions

 StreamError (Code error_code, const Glib::ustring& error_message)
 
 StreamError (GError* gobject)
 
Code code () const
 
- Public Member Functions inherited from Glib::Exception
virtual Glib::ustring what () const =0
 

Detailed Description

The GStreamer stream GError type.

GStreamer elements can throw non-fatal warnings and fatal errors. Higher-level elements and applications can programatically filter the ones they are interested in or can recover from, and have a default handler handle the rest of them. Both warnings and fatal errors are treated similarly.

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

Elements do not have the context required to decide what to do with errors. As such, they should only inform about errors, and stop their processing. In short, an element doesn't know what it is being used for.

It is the application or compound element using the given element that has more context about the use of the element. Errors can be received by listening to the Gst::Bus of the element/pipeline for Gst::Message objects with the type Gst::MESSAGE_ERROR or Gst::MESSAGE_WARNING. The thrown errors should be inspected, and filtered if appropriate.

An application is expected to, by default, present the user with a dialog box (or an equivalent) showing the error message. The dialog should also allow a way to get at the additional debug information, so the user can provide bug reporting information.

A compound element is expected to forward errors by default higher up the hierarchy; this is done by default in the same way as for other types of Gst::Message.

When applications or compound elements trigger errors that they can recover from, they can filter out these errors and take appropriate action. For example, an application that gets an error from xvimagesink that indicates all XVideo ports are taken, the application can attempt to use another sink instead.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

Gst::StreamError::StreamError ( Code  error_code,
const Glib::ustring error_message 
)
Gst::StreamError::StreamError ( GError *  gobject)
explicit

Member Function Documentation

Code Gst::StreamError::code ( ) const

The documentation for this class was generated from the following file: