Gst::MessageDuration Class Reference

A duration message. More...

Inheritance diagram for Gst::MessageDuration:
[legend]
Collaboration diagram for Gst::MessageDuration:
[legend]

## Public Member Functions

void | parse (Format& format, gint64& duration) const
| Extracts the duration and format from the duration message. More...
gint64 | parse () const
| Extracts and returns the duration from the duration message. More...
Format | parse_format () const
| Extracts and returns the format from the duration 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...
Gst::Structure | get_structure () const
| Access the structure of the message. More...
Glib::RefPtr< Gst::Message > | create_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...
MessageType | get_message_type () const
| Get the GstMessageType of message. More...
ClockTime | get_timestamp () const
| Get the timestamp of message. More...
Glib::RefPtr< Gst::Object > | get_source ()
| Get the object that posted the message. More...
Glib::RefPtr< const Gst::Object > | get_source () const
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 ()
guint | get_flags () const
void | set_flags (const guint& value)
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< MiniObject > | create_writable ()
| Checks if a mini-object is writable. More...

## Static Public Member Functions

static Glib::RefPtr < Gst::MessageDuration > | create (const Glib::RefPtr< Gst::Object >& src, Format format, gint64 duration)
| Create a new duration message. More...

## Additional Inherited Members

Protected Member Functions inherited from Gst::Message
| Message ()
void | operator delete (void*, std::size_t)
Protected Member Functions inherited from Gst::MiniObject
| MiniObject ()
void | operator delete (void*, std::size_t)
Static Protected Member Functions inherited from Gst::Message
template<class MsgType >
static Glib::RefPtr< MsgType > | wrap (GstMessage* message, bool take_copy=false)
Related Functions inherited from Gst::Message
Glib::RefPtr< Gst::Message > | wrap (GstMessage* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Gst::MiniObject
Glib::RefPtr< Gst::MiniObject > | wrap (GstMiniObject* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...

## Detailed Description

A duration message.

See create() for more details.

## Member Function Documentation

static Glib::RefPtr<Gst::MessageDuration> Gst::MessageDuration::create | ( | const Glib::RefPtr< Gst::Object >& | src,
|  | Format | format,
|  | gint64 | duration
| ) |  |

static

Create a new duration message.

This message is posted by elements that know the duration of a stream in a specific format. This message is received by bins and is used to calculate the total duration of a pipeline. Elements may post a duration message with a duration of Gst::CLOCK_TIME_NONE to indicate that the duration has changed and the cached duration should be discarded. The new duration can then be retrieved via a query.

Parameters

  src | The object originating the message.
  format | The format of the duration.
  duration | The new duration.

Returns
  The new duration message. MT safe.

void Gst::MessageDuration::parse | ( | Format& | format,
|  | gint64 & | duration
| ) |  | const

Extracts the duration and format from the duration message.

The duration might be Gst::CLOCK_TIME_NONE, which indicates that the duration has changed. Applications should always use a query to retrieve the duration of a pipeline.

MT safe.

Parameters

  format | Result location for the format.
  duration | Result location for the duration.

gint64 Gst::MessageDuration::parse | ( |  | ) | const

Extracts and returns the duration from the duration message.

The duration might be Gst::CLOCK_TIME_NONE, which indicates that the duration has changed. Applications should always use a query to retrieve the duration of a pipeline.

MT safe.

Returns
  The duration.

Format Gst::MessageDuration::parse_format | ( |  | ) | const

Extracts and returns the format from the duration message.

Applications should always use a query to retrieve the duration of a pipeline.

MT safe.

Returns
  The format.

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

- gstreamermm/message.h