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

A latency query object. More...

#include <gstreamermm/query.h>

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

Public Member Functions

void set (bool live, ClockTime min_latency, ClockTime max_latency)
 Answer a latency query by setting the requested values in the given format. More...
 
void parse (bool& live, ClockTime& min_latency, ClockTime& max_latency) const
 Parse a latency query answer. More...
 
bool parse_live () const
 Parse a latency query answer, returning the live status. More...
 
ClockTime parse_min () const
 Parse a latency query answer, returning the minimum latency. More...
 
ClockTime parse_max () const
 Parse a latency query answer, returning the maximum latency. More...
 
- Public Member Functions inherited from Gst::Query
void reference () const
 Increment the reference count for this object. More...
 
void unreference () const
 Decrement the reference count for this object. More...
 
GstQuery* gobj ()
 Provides access to the underlying C instance. More...
 
const GstQuery* gobj () const
 Provides access to the underlying C instance. More...
 
GstQuery* 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...
 
 Query ()=delete
 
 Query (const Query&)=delete
 
Queryoperator= (const Query&)=delete
 
Glib::RefPtr< Gst::Querycreate_writable ()
 Makes a writable query from the given query. More...
 
Gst::Structure get_structure () const
 Get the structure of a query. More...
 
QueryType get_query_type () const
 Get the Gst::QueryType of the query. More...
 
Glib::RefPtr< Gst::Querycopy ()
 Copies the given query using the copy function of the parent Gst::Structure. 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::QueryLatencycreate ()
 Constructs a new latency query object. More...
 
- Static Public Member Functions inherited from Gst::Query
static Glib::RefPtr< Gst::Querycreate_buffering (Gst::Format format)
 Constructs a new query object for querying the buffering status of a stream. More...
 
static Glib::RefPtr< Gst::Querycreate_allocation (Glib::RefPtr< Gst::Caps > caps, bool need_pool)
 Constructs a new query object for querying the allocation properties. More...
 
static Glib::RefPtr< Gst::Querycreate_uri ()
 Constructs a new query URI query object. More...
 
static Glib::RefPtr< Gst::Querycreate_scheduling ()
 Constructs a new query object for querying the scheduling properties. More...
 
static Glib::RefPtr< Gst::Querycreate_drain ()
 Constructs a new query object for querying the drain state. More...
 
static Glib::RefPtr< Gst::Querycreate_custom (Gst::QueryType type, const Gst::Structure& structure)
 Constructs a new custom query object. More...
 
static Glib::RefPtr< Gst::Querycreate_convert (Gst::Format format, gint64 value, Gst::Format dest_format)
 Constructs a new convert query object. More...
 
static Glib::RefPtr< Gst::Querycreate_position (Gst::Format format)
 Constructs a new query stream position query object. More...
 
static Glib::RefPtr< Gst::Querycreate_duration (Gst::Format format)
 Constructs a new stream duration query object to query in the given format. More...
 
static Glib::RefPtr< Gst::Querycreate_latency ()
 Constructs a new latency query object. More...
 
static Glib::RefPtr< Gst::Querycreate_seeking (Gst::Format format)
 Constructs a new query object for querying seeking properties of the stream. More...
 
static Glib::RefPtr< Gst::Querycreate_formats ()
 Constructs a new query object for querying formats of the stream. More...
 
static Glib::RefPtr< Gst::Querycreate_segment (Gst::Format format)
 Constructs a new segment query object. More...
 
static Glib::RefPtr< Gst::Querycreate_caps (Glib::RefPtr< Gst::Caps > filter)
 Constructs a new query object for querying the caps. More...
 
static Glib::RefPtr< Gst::Querycreate_accept_caps (Glib::RefPtr< Gst::Caps > filter)
 Constructs a new query object for querying if filter are accepted. More...
 

Additional Inherited Members

- Public Types inherited from Gst::MiniObject
typedef sigc::slot< void > SlotFinalizer
 
- Protected Member Functions inherited from Gst::Query
void operator delete (void*, std::size_t)
 
- Protected Member Functions inherited from Gst::MiniObject
void operator delete (void*, std::size_t)
 
- Static Protected Member Functions inherited from Gst::Query
template<class QueryType >
static Glib::RefPtr< QueryTypewrap (GstQuery* query, bool take_copy=false)
 

Detailed Description

A latency query object.

See create() for more details.

Member Function Documentation

◆ create()

static Glib::RefPtr<Gst::QueryLatency> Gst::QueryLatency::create ( )
static

Constructs a new latency query object.

A latency query is usually performed by sinks to compensate for additional latency introduced by elements in the pipeline.

Returns
The new Gst::QueryLatency.

◆ parse()

void Gst::QueryLatency::parse ( bool &  live,
ClockTime min_latency,
ClockTime max_latency 
) const

Parse a latency query answer.

Use the other parse() methods for parsing individual values.

Parameters
liveStorage for live.
min_latencyThe storage for the min latency.
max_latencyThe storage for the max latency.

◆ parse_live()

bool Gst::QueryLatency::parse_live ( ) const

Parse a latency query answer, returning the live status.

Returns
the live satus.

◆ parse_max()

ClockTime Gst::QueryLatency::parse_max ( ) const

Parse a latency query answer, returning the maximum latency.

Returns
The maximum latency.

◆ parse_min()

ClockTime Gst::QueryLatency::parse_min ( ) const

Parse a latency query answer, returning the minimum latency.

Returns
The minimum latency.

◆ set()

void Gst::QueryLatency::set ( bool  live,
ClockTime  min_latency,
ClockTime  max_latency 
)

Answer a latency query by setting the requested values in the given format.

Parameters
liveIf there is a live element upstream.
min_latencyThe minimal latency of the live element.
max_latencyThe maximal latency of the live element.