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

A stream-start message. More...

#include <gstreamermm/message.h>

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

Public Member Functions

void set_group_id (guint group_id)
 Sets the group id on the stream-start message. More...
 
bool parse_group_id (guint& group_id) const
 Extract the group from the STREAM_START message. 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::MessageStreamStartcreate (const Glib::RefPtr< Gst::Object >& src)
 Create a new stream_start message. 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 stream-start message.

See create() for more details.

Member Function Documentation

◆ create()

static Glib::RefPtr<Gst::MessageStreamStart> Gst::MessageStreamStart::create ( const Glib::RefPtr< Gst::Object >&  src)
static

Create a new stream_start message.

This message is generated and posted in the sink elements of a GstBin. The bin will only forward the STREAM_START message to the application if all sinks have posted an STREAM_START message.

Parameters
srcThe object originating the message.
Returns
The new stream_start message.

MT safe.

◆ parse_group_id()

bool Gst::MessageStreamStart::parse_group_id ( guint &  group_id) const

Extract the group from the STREAM_START message.

MT safe

Parameters
group_idResult location for the group id.
Returns
true if the message had a group id set, false otherwse.

◆ set_group_id()

void Gst::MessageStreamStart::set_group_id ( guint  group_id)

Sets the group id on the stream-start message.

All streams that have the same group id are supposed to be played together, i.e. all streams inside a container file should have the same group id but different stream ids. The group id should change each time the stream is started, resulting in different group ids each time a file is played for example.

MT safe.

Parameters
group_idThe group id.