gstreamermm  1.10.0
Public Member Functions | Static Public Member Functions | List of all members
Gst::MessageProgress Class Reference

A progress message. More...

#include <gstreamermm/message.h>

Inheritance diagram for Gst::MessageProgress:
Inheritance graph
[legend]

Public Member Functions

void parse (Gst::ProgressType& type, Glib::ustring& code, Glib::ustring& text) const
 Parses the progress type, code and text. More...
 
Gst::ProgressType parse_type () const
 Extracts and returns the ProgressType from the Gst::MessageProgress. More...
 
Glib::ustring parse_code () const
 Extracts and returns the code from the Gst::MessageProgress. More...
 
Glib::ustring parse_text () const
 Extracts and returns the text from the Gst::MessageProgress. More...
 
- Public Member Functions inherited from Gst::Message
void reference () const
 Increment the reference count for this object. More...
 
void unreference () const
 Decrement the reference count for this object. More...
 
GstMessage* gobj ()
 Provides access to the underlying C instance. More...
 
const GstMessage* gobj () const
 Provides access to the underlying C instance. More...
 
GstMessage* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
 Message ()=delete
 
 Message (const Message&)=delete
 
Messageoperator= (const Message&)=delete
 
Gst::Structure get_structure () const
 Access the structure of the message. More...
 
Glib::RefPtr< Gst::Messagecreate_writable ()
 Checks if a message is writable. More...
 
guint32 get_seqnum () const
 Retrieve the sequence number of a message. More...
 
void set_seqnum (guint32 seqnum)
 Set the sequence number of a message. More...
 
Glib::RefPtr< Gst::Messagecopy () const
 Creates a copy of the message. More...
 
MessageType get_message_type () const
 Get the GstMessageType of message. More...
 
Gst::ClockTime get_timestamp () const
 Get the timestamp of message. More...
 
Glib::RefPtr< Gst::Objectget_source ()
 Get the object that posted the message. More...
 
Glib::RefPtr< const Gst::Objectget_source () const
 
bool has_name (const Glib::ustring& name) const
 Checks if message has the given name. More...
 
- Public Member Functions inherited from Gst::MiniObject
void reference () const
 Increment the reference count for this object. More...
 
void unreference () const
 Decrement the reference count for this object. More...
 
GstMiniObject* gobj ()
 Provides access to the underlying C instance. More...
 
const GstMiniObject* gobj () const
 Provides access to the underlying C instance. More...
 
GstMiniObject* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
 MiniObject ()=delete
 
 MiniObject (const MiniObject&)=delete
 
MiniObjectoperator= (const MiniObject&)=delete
 
 ~MiniObject ()
 
guint get_flags () const
 
void set_flags (const guint& value)
 
gint get_refcount () const
 
gint get_lockstate () const
 
bool lock (LockFlags flags)
 Lock the mini-object with the specified access mode in flags. More...
 
void unlock (LockFlags flags)
 Unlock the mini-object with the specified access mode in flags. More...
 
bool is_writable () const
 If mini_object has the LOCKABLE flag set, check if the current EXCLUSIVE lock on object is the only one, this means that changes to the object will not be visible to any other object. More...
 
Glib::RefPtr< MiniObjectcreate_writable ()
 Checks if a mini-object is writable. More...
 
void set_qdata (GQuark quark, QuarkData* data)
 This sets an opaque, named pointer on a miniobject. More...
 
QuarkDataget_qdata (GQuark quark) const
 This function gets back user data pointers stored via set_qdata(). More...
 
QuarkDatasteal_qdata (GQuark quark)
 This function gets back user data pointers stored via set_qdata() and removes the data from object without invoking its destroy() function (if any was set). More...
 
void add_finalize_notifier (const SlotFinalizer& slot)
 Adds notifier when mini object is finalized. More...
 
void remove_finalize_notifier ()
 Remove finalize notifier. More...
 

Static Public Member Functions

static Glib::RefPtr< Gst::MessageProgresscreate (const Glib::RefPtr< Gst::Object >& src, Gst::ProgressType type, const Glib::ustring& code, const Glib::ustring& text)
 Progress messages are posted by elements when they use an asynchronous task to perform actions triggered by a state change. More...
 

Additional Inherited Members

- Public Types inherited from Gst::MiniObject
typedef sigc::slot< void > SlotFinalizer
 
- Protected Member Functions inherited from Gst::Message
void operator delete (void*, std::size_t)
 
- Protected Member Functions inherited from Gst::MiniObject
void operator delete (void*, std::size_t)
 

Detailed Description

A progress message.

See create() for more details.

Member Function Documentation

◆ create()

static Glib::RefPtr<Gst::MessageProgress> Gst::MessageProgress::create ( const Glib::RefPtr< Gst::Object >&  src,
Gst::ProgressType  type,
const Glib::ustring &  code,
const Glib::ustring &  text 
)
static

Progress messages are posted by elements when they use an asynchronous task to perform actions triggered by a state change.

code contains a well defined string describing the action. test should contain a user visible string detailing the current action.

Parameters
srcThe object originating the message.
typeA Gst::ProgressType.
codeA progress code.
textFree, user visible text describing the progress.
Returns
The new qos message.

◆ parse()

void Gst::MessageProgress::parse ( Gst::ProgressType type,
Glib::ustring &  code,
Glib::ustring &  text 
) const

Parses the progress type, code and text.

Parameters
typeA Gst::ProgressType.
codeA code.
textA text.

◆ parse_code()

Glib::ustring Gst::MessageProgress::parse_code ( ) const

Extracts and returns the code from the Gst::MessageProgress.

Returns
The code.

◆ parse_text()

Glib::ustring Gst::MessageProgress::parse_text ( ) const

Extracts and returns the text from the Gst::MessageProgress.

Returns
The text.

◆ parse_type()

Gst::ProgressType Gst::MessageProgress::parse_type ( ) const

Extracts and returns the ProgressType from the Gst::MessageProgress.

Returns
The ProgressType.