GStreamer 1.0 Core Reference Manual | ||||
---|---|---|---|---|
Top | Description |
#include <gst/gst.h> struct GstQuery; enum GstQueryTypeFlags; #define GST_QUERY_TYPE_BOTH #define GST_QUERY_MAKE_TYPE (num, flags) enum GstQueryType; #define GST_QUERY_TYPE (query) #define GST_QUERY_TYPE_NAME (query) #define GST_QUERY_IS_UPSTREAM (ev) #define GST_QUERY_IS_DOWNSTREAM (ev) #define GST_QUERY_IS_SERIALIZED (ev) GstQueryTypeFlags gst_query_type_get_flags (GstQueryType type
); const gchar * gst_query_type_get_name (GstQueryType type
); GQuark gst_query_type_to_quark (GstQueryType type
); GstQuery * gst_query_ref (GstQuery *q
); void gst_query_unref (GstQuery *q
); GstQuery * gst_query_copy (const GstQuery *q
); #define gst_query_make_writable (q) #define gst_query_is_writable (q) gboolean gst_query_replace (GstQuery **old_query
,GstQuery *new_query
); GstStructure * gst_query_writable_structure (GstQuery *query
); GstQuery * gst_query_new_custom (GstQueryType type
,GstStructure *structure
); const GstStructure * gst_query_get_structure (GstQuery *query
); GstQuery * gst_query_new_convert (GstFormat src_format
,gint64 value
,GstFormat dest_format
); void gst_query_set_convert (GstQuery *query
,GstFormat src_format
,gint64 src_value
,GstFormat dest_format
,gint64 dest_value
); void gst_query_parse_convert (GstQuery *query
,GstFormat *src_format
,gint64 *src_value
,GstFormat *dest_format
,gint64 *dest_value
); GstQuery * gst_query_new_position (GstFormat format
); void gst_query_set_position (GstQuery *query
,GstFormat format
,gint64 cur
); void gst_query_parse_position (GstQuery *query
,GstFormat *format
,gint64 *cur
); GstQuery * gst_query_new_duration (GstFormat format
); void gst_query_set_duration (GstQuery *query
,GstFormat format
,gint64 duration
); void gst_query_parse_duration (GstQuery *query
,GstFormat *format
,gint64 *duration
); GstQuery * gst_query_new_latency (void
); void gst_query_parse_latency (GstQuery *query
,gboolean *live
,GstClockTime *min_latency
,GstClockTime *max_latency
); void gst_query_set_latency (GstQuery *query
,gboolean live
,GstClockTime min_latency
,GstClockTime max_latency
); GstQuery * gst_query_new_seeking (GstFormat format
); void gst_query_set_seeking (GstQuery *query
,GstFormat format
,gboolean seekable
,gint64 segment_start
,gint64 segment_end
); void gst_query_parse_seeking (GstQuery *query
,GstFormat *format
,gboolean *seekable
,gint64 *segment_start
,gint64 *segment_end
); GstQuery * gst_query_new_formats (void
); void gst_query_set_formats (GstQuery *query
,gint n_formats
,...
); void gst_query_set_formatsv (GstQuery *query
,gint n_formats
,const GstFormat *formats
); void gst_query_parse_n_formats (GstQuery *query
,guint *n_formats
); void gst_query_parse_nth_format (GstQuery *query
,guint nth
,GstFormat *format
); GstQuery * gst_query_new_segment (GstFormat format
); void gst_query_set_segment (GstQuery *query
,gdouble rate
,GstFormat format
,gint64 start_value
,gint64 stop_value
); void gst_query_parse_segment (GstQuery *query
,gdouble *rate
,GstFormat *format
,gint64 *start_value
,gint64 *stop_value
); GstQuery * gst_query_new_caps (GstCaps *filter
); void gst_query_parse_caps (GstQuery *query
,GstCaps **filter
); void gst_query_set_caps_result (GstQuery *query
,GstCaps *caps
); void gst_query_parse_caps_result (GstQuery *query
,GstCaps **caps
); GstQuery * gst_query_new_accept_caps (GstCaps *caps
); void gst_query_parse_accept_caps (GstQuery *query
,GstCaps **caps
); void gst_query_set_accept_caps_result (GstQuery *query
,gboolean result
); void gst_query_parse_accept_caps_result (GstQuery *query
,gboolean *result
); enum GstBufferingMode; GstQuery * gst_query_new_buffering (GstFormat format
); void gst_query_set_buffering_percent (GstQuery *query
,gboolean busy
,gint percent
); void gst_query_parse_buffering_percent (GstQuery *query
,gboolean *busy
,gint *percent
); void gst_query_set_buffering_stats (GstQuery *query
,GstBufferingMode mode
,gint avg_in
,gint avg_out
,gint64 buffering_left
); void gst_query_parse_buffering_stats (GstQuery *query
,GstBufferingMode *mode
,gint *avg_in
,gint *avg_out
,gint64 *buffering_left
); void gst_query_set_buffering_range (GstQuery *query
,GstFormat format
,gint64 start
,gint64 stop
,gint64 estimated_total
); void gst_query_parse_buffering_range (GstQuery *query
,GstFormat *format
,gint64 *start
,gint64 *stop
,gint64 *estimated_total
); gboolean gst_query_add_buffering_range (GstQuery *query
,gint64 start
,gint64 stop
); guint gst_query_get_n_buffering_ranges (GstQuery *query
); gboolean gst_query_parse_nth_buffering_range (GstQuery *query
,guint index
,gint64 *start
,gint64 *stop
); GstQuery * gst_query_new_uri (void
); void gst_query_parse_uri (GstQuery *query
,gchar **uri
); void gst_query_set_uri (GstQuery *query
,const gchar *uri
); GstQuery * gst_query_new_allocation (GstCaps *caps
,gboolean need_pool
); void gst_query_parse_allocation (GstQuery *query
,GstCaps **caps
,gboolean *need_pool
); void gst_query_add_allocation_pool (GstQuery *query
,GstBufferPool *pool
,guint size
,guint min_buffers
,guint max_buffers
); guint gst_query_get_n_allocation_pools (GstQuery *query
); void gst_query_parse_nth_allocation_pool (GstQuery *query
,guint index
,GstBufferPool **pool
,guint *size
,guint *min_buffers
,guint *max_buffers
); void gst_query_set_nth_allocation_pool (GstQuery *query
,guint index
,GstBufferPool *pool
,guint size
,guint min_buffers
,guint max_buffers
); void gst_query_remove_nth_allocation_pool (GstQuery *query
,guint index
); void gst_query_add_allocation_param (GstQuery *query
,GstAllocator *allocator
,const GstAllocationParams *params
); guint gst_query_get_n_allocation_params (GstQuery *query
); void gst_query_parse_nth_allocation_param (GstQuery *query
,guint index
,GstAllocator **allocator
,GstAllocationParams *params
); void gst_query_set_nth_allocation_param (GstQuery *query
,guint index
,GstAllocator *allocator
,const GstAllocationParams *params
); void gst_query_remove_nth_allocation_param (GstQuery *query
,guint index
); void gst_query_add_allocation_meta (GstQuery *query
,GType api
,const GstStructure *params
); guint gst_query_get_n_allocation_metas (GstQuery *query
); GType gst_query_parse_nth_allocation_meta (GstQuery *query
,guint index
,const GstStructure **params
); void gst_query_remove_nth_allocation_meta (GstQuery *query
,guint index
); gboolean gst_query_find_allocation_meta (GstQuery *query
,GType api
,guint *index
); enum GstSchedulingFlags; GstQuery * gst_query_new_scheduling (void
); void gst_query_parse_scheduling (GstQuery *query
,GstSchedulingFlags *flags
,gint *minsize
,gint *maxsize
,gint *align
); void gst_query_set_scheduling (GstQuery *query
,GstSchedulingFlags flags
,gint minsize
,gint maxsize
,gint align
); void gst_query_add_scheduling_mode (GstQuery *query
,GstPadMode mode
); guint gst_query_get_n_scheduling_modes (GstQuery *query
); GstPadMode gst_query_parse_nth_scheduling_mode (GstQuery *query
,guint index
); gboolean gst_query_has_scheduling_mode (GstQuery *query
,GstPadMode mode
); gboolean gst_query_has_scheduling_mode_with_flags (GstQuery *query
,GstPadMode mode
,GstSchedulingFlags flags
); GstQuery * gst_query_new_drain (void
); GstQuery * gst_query_new_context (void
); void gst_query_set_context (GstQuery *query
,GstContext *context
); void gst_query_parse_context (GstQuery *query
,GstContext **context
); void gst_query_add_context_type (GstQuery *query
,const gchar *context_type
); guint gst_query_get_n_context_types (GstQuery *query
); gboolean gst_query_parse_nth_context_type (GstQuery *query
,guint i
,const gchar **context_type
); gboolean gst_query_has_context_type (GstQuery *query
,const gchar *context_type
);
Queries can be performed on pads (gst_pad_query()
) and elements
(gst_element_query()
). Please note that some queries might need a running
pipeline to work.
Queries can be created using the gst_query_new_*() functions. Query values can be set using gst_query_set_*(), and parsed using gst_query_parse_*() helpers.
The following example shows how to query the duration of a pipeline:
Example 12. Query duration on a pipeline
1 2 3 4 5 6 7 8 9 10 11 12 13 |
GstQuery *query; gboolean res; query = gst_query_new_duration (GST_FORMAT_TIME); res = gst_element_query (pipeline, query); if (res) { gint64 duration; gst_query_parse_duration (query, NULL, &duration); g_print ("duration = %"GST_TIME_FORMAT, GST_TIME_ARGS (duration)); } else { g_print ("duration query failed..."); } gst_query_unref (query); |
Last reviewed on 2012-03-29 (0.11.3)
struct GstQuery { GstMiniObject mini_object; GstQueryType type; };
The GstQuery structure.
GstMiniObject |
The parent GstMiniObject type |
GstQueryType |
the GstQueryType |
typedef enum { GST_QUERY_TYPE_UPSTREAM = 1 << 0, GST_QUERY_TYPE_DOWNSTREAM = 1 << 1, GST_QUERY_TYPE_SERIALIZED = 1 << 2 } GstQueryTypeFlags;
GstQueryTypeFlags indicate the aspects of the different GstQueryType
values. You can get the type flags of a GstQueryType with the
gst_query_type_get_flags()
function.
#define GST_QUERY_TYPE_BOTH
The same thing as GST_QUERY_TYPE_UPSTREAM | GST_QUERY_TYPE_DOWNSTREAM.
#define GST_QUERY_MAKE_TYPE(num,flags)
when making custom query types, use this macro with the num and the given flags
|
the query number to create |
|
the query flags |
typedef enum { GST_QUERY_UNKNOWN = GST_QUERY_MAKE_TYPE (0, 0), GST_QUERY_POSITION = GST_QUERY_MAKE_TYPE (10, FLAG(BOTH)), GST_QUERY_DURATION = GST_QUERY_MAKE_TYPE (20, FLAG(BOTH)), GST_QUERY_LATENCY = GST_QUERY_MAKE_TYPE (30, FLAG(BOTH)), GST_QUERY_JITTER = GST_QUERY_MAKE_TYPE (40, FLAG(BOTH)), GST_QUERY_RATE = GST_QUERY_MAKE_TYPE (50, FLAG(BOTH)), GST_QUERY_SEEKING = GST_QUERY_MAKE_TYPE (60, FLAG(BOTH)), GST_QUERY_SEGMENT = GST_QUERY_MAKE_TYPE (70, FLAG(BOTH)), GST_QUERY_CONVERT = GST_QUERY_MAKE_TYPE (80, FLAG(BOTH)), GST_QUERY_FORMATS = GST_QUERY_MAKE_TYPE (90, FLAG(BOTH)), GST_QUERY_BUFFERING = GST_QUERY_MAKE_TYPE (110, FLAG(BOTH)), GST_QUERY_CUSTOM = GST_QUERY_MAKE_TYPE (120, FLAG(BOTH)), GST_QUERY_URI = GST_QUERY_MAKE_TYPE (130, FLAG(BOTH)), GST_QUERY_ALLOCATION = GST_QUERY_MAKE_TYPE (140, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)), GST_QUERY_SCHEDULING = GST_QUERY_MAKE_TYPE (150, FLAG(UPSTREAM)), GST_QUERY_ACCEPT_CAPS = GST_QUERY_MAKE_TYPE (160, FLAG(BOTH)), GST_QUERY_CAPS = GST_QUERY_MAKE_TYPE (170, FLAG(BOTH)), GST_QUERY_DRAIN = GST_QUERY_MAKE_TYPE (180, FLAG(DOWNSTREAM) | FLAG(SERIALIZED)), GST_QUERY_CONTEXT = GST_QUERY_MAKE_TYPE (190, FLAG(DOWNSTREAM)) } GstQueryType;
Standard predefined Query types
unknown query type | |
current position in stream | |
total duration of the stream | |
latency of stream | |
current jitter of stream | |
current rate of the stream | |
seeking capabilities | |
segment start/stop positions | |
convert values between formats | |
query supported formats for convert | |
query available media for efficient seeking. | |
a custom application or element defined query. | |
query the URI of the source or sink. | |
the buffer allocation properties | |
the scheduling properties | |
the accept caps query | |
the caps query | |
wait till all serialized data is consumed downstream | |
query the pipeline-local context from downstream (since 1.2) |
#define GST_QUERY_TYPE(query) (((GstQuery*)(query))->type)
Get the GstQueryType of the query.
|
the query to query |
#define GST_QUERY_TYPE_NAME(query) (gst_query_type_get_name(GST_QUERY_TYPE(query)))
Get a constant string representation of the GstQueryType of the query.
|
the query to query |
#define GST_QUERY_IS_UPSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_UPSTREAM)
Check if an query can travel upstream.
|
the query to query |
#define GST_QUERY_IS_DOWNSTREAM(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_DOWNSTREAM)
Check if an query can travel downstream.
|
the query to query |
#define GST_QUERY_IS_SERIALIZED(ev) !!(GST_QUERY_TYPE (ev) & GST_QUERY_TYPE_SERIALIZED)
Check if an query is serialized with the data stream.
|
the query to query |
GstQueryTypeFlags gst_query_type_get_flags (GstQueryType type
);
Gets the GstQueryTypeFlags associated with type
.
|
a GstQueryType |
Returns : |
a GstQueryTypeFlags. |
const gchar * gst_query_type_get_name (GstQueryType type
);
Get a printable name for the given query type. Do not modify or free.
|
the query type |
Returns : |
a reference to the static name of the query. |
GQuark gst_query_type_to_quark (GstQueryType type
);
Get the unique quark for the given query type.
|
the query type |
Returns : |
the quark associated with the query type |
GstQuery * gst_query_ref (GstQuery *q
);
Increases the refcount of the given query by one.
|
a GstQuery to increase the refcount of. |
Returns : |
q |
void gst_query_unref (GstQuery *q
);
Decreases the refcount of the query. If the refcount reaches 0, the query will be freed.
|
a GstQuery to decrease the refcount of. |
GstQuery * gst_query_copy (const GstQuery *q
);
Copies the given query using the copy function of the parent GstStructure.
Free-function: gst_query_unref
|
a GstQuery to copy. |
Returns : |
a new copy of q . [transfer full]
|
#define gst_query_make_writable(q) GST_QUERY_CAST (gst_mini_object_make_writable (GST_MINI_OBJECT_CAST (q)))
Makes a writable query from the given query.
|
a GstQuery to make writable. [transfer full] |
Returns : |
a new writable query (possibly same as q ). [transfer full]
|
#define gst_query_is_writable(q) gst_mini_object_is_writable (GST_MINI_OBJECT_CAST (q))
Tests if you can safely write data into a query's structure.
|
a GstQuery |
gboolean gst_query_replace (GstQuery **old_query
,GstQuery *new_query
);
Modifies a pointer to a GstQuery to point to a different GstQuery. The modification is done atomically (so this is useful for ensuring thread safety in some cases), and the reference counts are updated appropriately (the old query is unreffed, the new one is reffed).
Either new_query
or the GstQuery pointed to by old_query
may be NULL.
GstStructure * gst_query_writable_structure (GstQuery *query
);
Get the structure of a query. This method should be called with a writable
query
so that the returned structure is guranteed to be writable.
|
a GstQuery |
Returns : |
the GstStructure of the query. The structure is still owned by the query and will therefore be freed when the query is unreffed. [transfer none] |
GstQuery * gst_query_new_custom (GstQueryType type
,GstStructure *structure
);
Constructs a new custom query object. Use gst_query_unref()
when done with it.
Free-function: gst_query_unref
|
the query type |
|
a structure for the query |
Returns : |
a new GstQuery. [transfer full] |
const GstStructure * gst_query_get_structure (GstQuery *query
);
Get the structure of a query.
|
a GstQuery |
Returns : |
the GstStructure of the query. The structure is still owned by the query and will therefore be freed when the query is unreffed. [transfer none] |
GstQuery * gst_query_new_convert (GstFormat src_format
,gint64 value
,GstFormat dest_format
);
Constructs a new convert query object. Use gst_query_unref()
when done with it. A convert query is used to ask for a conversion between
one format and another.
Free-function: gst_query_unref
void gst_query_set_convert (GstQuery *query
,GstFormat src_format
,gint64 src_value
,GstFormat dest_format
,gint64 dest_value
);
Answer a convert query by setting the requested values.
void gst_query_parse_convert (GstQuery *query
,GstFormat *src_format
,gint64 *src_value
,GstFormat *dest_format
,gint64 *dest_value
);
Parse a convert query answer. Any of src_format
, src_value
, dest_format
,
and dest_value
may be NULL, in which case that value is omitted.
|
a GstQuery |
|
the storage for the GstFormat of the source value, or NULL. [out][allow-none] |
|
the storage for the source value, or NULL. [out][allow-none] |
|
the storage for the GstFormat of the destination value, or NULL. [out][allow-none] |
|
the storage for the destination value, or NULL. [out][allow-none] |
GstQuery * gst_query_new_position (GstFormat format
);
Constructs a new query stream position query object. Use gst_query_unref()
when done with it. A position query is used to query the current position
of playback in the streams, in some format.
Free-function: gst_query_unref
void gst_query_set_position (GstQuery *query
,GstFormat format
,gint64 cur
);
Answer a position query by setting the requested value in the given format.
void gst_query_parse_position (GstQuery *query
,GstFormat *format
,gint64 *cur
);
Parse a position query, writing the format into format
, and the position
into cur
, if the respective parameters are non-NULL.
GstQuery * gst_query_new_duration (GstFormat format
);
Constructs a new stream duration query object to query in the given format.
Use gst_query_unref()
when done with it. A duration query will give the
total length of the stream.
Free-function: gst_query_unref
void gst_query_set_duration (GstQuery *query
,GstFormat format
,gint64 duration
);
Answer a duration query by setting the requested value in the given format.
void gst_query_parse_duration (GstQuery *query
,GstFormat *format
,gint64 *duration
);
Parse a duration query answer. Write the format of the duration into format
,
and the value into duration
, if the respective variables are non-NULL.
GstQuery * gst_query_new_latency (void
);
Constructs a new latency query object.
Use gst_query_unref()
when done with it. A latency query is usually performed
by sinks to compensate for additional latency introduced by elements in the
pipeline.
Free-function: gst_query_unref
Returns : |
a GstQuery. [transfer full] |
void gst_query_parse_latency (GstQuery *query
,gboolean *live
,GstClockTime *min_latency
,GstClockTime *max_latency
);
Parse a latency query answer.
|
a GstQuery |
|
storage for live or NULL. [out][allow-none] |
|
the storage for the min latency or NULL. [out][allow-none] |
|
the storage for the max latency or NULL. [out][allow-none] |
void gst_query_set_latency (GstQuery *query
,gboolean live
,GstClockTime min_latency
,GstClockTime max_latency
);
Answer a latency query by setting the requested values in the given format.
|
a GstQuery |
|
if there is a live element upstream |
|
the minimal latency of the upstream elements |
|
the maximal latency of the upstream elements |
GstQuery * gst_query_new_seeking (GstFormat format
);
Constructs a new query object for querying seeking properties of the stream.
Free-function: gst_query_unref
void gst_query_set_seeking (GstQuery *query
,GstFormat format
,gboolean seekable
,gint64 segment_start
,gint64 segment_end
);
Set the seeking query result fields in query
.
|
a GstQuery |
|
the format to set for the segment_start and segment_end values |
|
the seekable flag to set |
|
the segment_start to set |
|
the segment_end to set |
void gst_query_parse_seeking (GstQuery *query
,GstFormat *format
,gboolean *seekable
,gint64 *segment_start
,gint64 *segment_end
);
Parse a seeking query, writing the format into format
, and
other results into the passed parameters, if the respective parameters
are non-NULL
|
a GST_QUERY_SEEKING type query GstQuery |
|
the format to set for the segment_start
and segment_end values, or NULL. [out][allow-none]
|
|
the seekable flag to set, or NULL. [out][allow-none] |
|
the segment_start to set, or NULL. [out][allow-none] |
|
the segment_end to set, or NULL. [out][allow-none] |
GstQuery * gst_query_new_formats (void
);
Constructs a new query object for querying formats of the stream.
Free-function: gst_query_unref
Returns : |
a new GstQuery. [transfer full] |
void gst_query_set_formats (GstQuery *query
,gint n_formats
,...
);
Set the formats query result fields in query
. The number of formats passed
must be equal to n_formats
.
|
a GstQuery |
|
the number of formats to set. |
|
A number of GstFormats equal to n_formats . |
void gst_query_set_formatsv (GstQuery *query
,gint n_formats
,const GstFormat *formats
);
Set the formats query result fields in query
. The number of formats passed
in the formats
array must be equal to n_formats
.
|
a GstQuery |
|
the number of formats to set. |
|
an array containing n_formats
GstFormat values. [in][array length=n_formats]
|
void gst_query_parse_n_formats (GstQuery *query
,guint *n_formats
);
Parse the number of formats in the formats query
.
|
a GstQuery |
|
the number of formats in this query. [out][allow-none] |
void gst_query_parse_nth_format (GstQuery *query
,guint nth
,GstFormat *format
);
Parse the format query and retrieve the nth
format from it into
format
. If the list contains less elements than nth
, format
will be
set to GST_FORMAT_UNDEFINED.
|
a GstQuery |
|
the nth format to retrieve. [out] |
|
a pointer to store the nth format. [out][allow-none] |
GstQuery * gst_query_new_segment (GstFormat format
);
Constructs a new segment query object. Use gst_query_unref()
when done with it. A segment query is used to discover information about the
currently configured segment for playback.
Free-function: gst_query_unref
void gst_query_set_segment (GstQuery *query
,gdouble rate
,GstFormat format
,gint64 start_value
,gint64 stop_value
);
Answer a segment query by setting the requested values. The normal playback segment of a pipeline is 0 to duration at the default rate of 1.0. If a seek was performed on the pipeline to play a different segment, this query will return the range specified in the last seek.
start_value
and stop_value
will respectively contain the configured
playback range start and stop values expressed in format
.
The values are always between 0 and the duration of the media and
start_value
<= stop_value
. rate
will contain the playback rate. For
negative rates, playback will actually happen from stop_value
to
start_value
.
void gst_query_parse_segment (GstQuery *query
,gdouble *rate
,GstFormat *format
,gint64 *start_value
,gint64 *stop_value
);
Parse a segment query answer. Any of rate
, format
, start_value
, and
stop_value
may be NULL, which will cause this value to be omitted.
See gst_query_set_segment()
for an explanation of the function arguments.
|
a GstQuery |
|
the storage for the rate of the segment, or NULL. [out][allow-none] |
|
the storage for the GstFormat of the values, or NULL. [out][allow-none] |
|
the storage for the start value, or NULL. [out][allow-none] |
|
the storage for the stop value, or NULL. [out][allow-none] |
GstQuery * gst_query_new_caps (GstCaps *filter
);
Constructs a new query object for querying the caps.
The CAPS query should return the allowable caps for a pad in the context of the element's state, its link to other elements, and the devices or files it has opened. These caps must be a subset of the pad template caps. In the NULL state with no links, the CAPS query should ideally return the same caps as the pad template. In rare circumstances, an object property can affect the caps returned by the CAPS query, but this is discouraged.
For most filters, the caps returned by CAPS query is directly affected by the allowed caps on other pads. For demuxers and decoders, the caps returned by the srcpad's getcaps function is directly related to the stream data. Again, the CAPS query should return the most specific caps it reasonably can, since this helps with autoplugging.
The filter
is used to restrict the result caps, only the caps matching
filter
should be returned from the CAPS query. Specifying a filter might
greatly reduce the amount of processing an element needs to do.
Free-function: gst_query_unref
|
a filter |
Returns : |
a new GstQuery. [transfer full] |
void gst_query_parse_caps (GstQuery *query
,GstCaps **filter
);
Get the filter from the caps query
. The caps remains valid as long as
query
remains valid.
|
The query to parse |
|
A pointer to the caps filter. [out][transfer none] |
void gst_query_set_caps_result (GstQuery *query
,GstCaps *caps
);
Set the caps
result in query
.
|
The query to use |
|
A pointer to the caps. [in] |
void gst_query_parse_caps_result (GstQuery *query
,GstCaps **caps
);
Get the caps result from query
. The caps remains valid as long as
query
remains valid.
|
The query to parse |
|
A pointer to the caps. [out][transfer none] |
GstQuery * gst_query_new_accept_caps (GstCaps *caps
);
Constructs a new query object for querying if caps
are accepted.
Free-function: gst_query_unref
void gst_query_parse_accept_caps (GstQuery *query
,GstCaps **caps
);
Get the caps from query
. The caps remains valid as long as query
remains
valid.
|
The query to parse |
|
A pointer to the caps. [out][transfer none] |
void gst_query_set_accept_caps_result (GstQuery *query
,gboolean result
);
Set result
as the result for the query
.
|
a GST_QUERY_ACCEPT_CAPS type query GstQuery |
|
the result to set |
void gst_query_parse_accept_caps_result (GstQuery *query
,gboolean *result
);
Parse the result from query
and store in result
.
|
a GST_QUERY_ACCEPT_CAPS type query GstQuery |
|
location for the result |
typedef enum { GST_BUFFERING_STREAM, GST_BUFFERING_DOWNLOAD, GST_BUFFERING_TIMESHIFT, GST_BUFFERING_LIVE } GstBufferingMode;
The different types of buffering methods.
GstQuery * gst_query_new_buffering (GstFormat format
);
Constructs a new query object for querying the buffering status of a stream.
Free-function: gst_query_unref
void gst_query_set_buffering_percent (GstQuery *query
,gboolean busy
,gint percent
);
Set the percentage of buffered data. This is a value between 0 and 100.
The busy
indicator is TRUE
when the buffering is in progress.
|
A valid GstQuery of type GST_QUERY_BUFFERING. |
|
if buffering is busy |
|
a buffering percent |
void gst_query_parse_buffering_percent (GstQuery *query
,gboolean *busy
,gint *percent
);
Get the percentage of buffered data. This is a value between 0 and 100.
The busy
indicator is TRUE
when the buffering is in progress.
|
A valid GstQuery of type GST_QUERY_BUFFERING. |
|
if buffering is busy, or NULL. [out][allow-none] |
|
a buffering percent, or NULL. [out][allow-none] |
void gst_query_set_buffering_stats (GstQuery *query
,GstBufferingMode mode
,gint avg_in
,gint avg_out
,gint64 buffering_left
);
Configures the buffering stats values in query
.
|
A valid GstQuery of type GST_QUERY_BUFFERING. |
|
a buffering mode |
|
the average input rate |
|
the average output rate |
|
amount of buffering time left in milliseconds |
void gst_query_parse_buffering_stats (GstQuery *query
,GstBufferingMode *mode
,gint *avg_in
,gint *avg_out
,gint64 *buffering_left
);
Extracts the buffering stats values from query
.
|
A valid GstQuery of type GST_QUERY_BUFFERING. |
|
a buffering mode, or NULL. [out][allow-none] |
|
the average input rate, or NULL. [out][allow-none] |
|
the average output rat, or NULLe. [out][allow-none] |
|
amount of buffering time left in milliseconds, or NULL. [out][allow-none] |
void gst_query_set_buffering_range (GstQuery *query
,GstFormat format
,gint64 start
,gint64 stop
,gint64 estimated_total
);
Set the available query result fields in query
.
|
a GstQuery |
|
the format to set for the start and stop values |
|
the start to set |
|
the stop to set |
|
estimated total amount of download time remaining in miliseconds |
void gst_query_parse_buffering_range (GstQuery *query
,GstFormat *format
,gint64 *start
,gint64 *stop
,gint64 *estimated_total
);
Parse an available query, writing the format into format
, and
other results into the passed parameters, if the respective parameters
are non-NULL
|
a GST_QUERY_BUFFERING type query GstQuery |
|
the format to set for the segment_start
and segment_end values, or NULL. [out][allow-none]
|
|
the start to set, or NULL. [out][allow-none] |
|
the stop to set, or NULL. [out][allow-none] |
|
estimated total amount of download time remaining in miliseconds, or NULL. [out][allow-none] |
gboolean gst_query_add_buffering_range (GstQuery *query
,gint64 start
,gint64 stop
);
Set the buffering-ranges array field in query
. The current last
start position of the array should be inferior to start
.
guint gst_query_get_n_buffering_ranges (GstQuery *query
);
Retrieve the number of values currently stored in the buffered-ranges array of the query's structure.
gboolean gst_query_parse_nth_buffering_range (GstQuery *query
,guint index
,gint64 *start
,gint64 *stop
);
Parse an available query and get the start and stop values stored
at the index
of the buffered ranges array.
GstQuery * gst_query_new_uri (void
);
Constructs a new query URI query object. Use gst_query_unref()
when done with it. An URI query is used to query the current URI
that is used by the source or sink.
Free-function: gst_query_unref
Returns : |
a new GstQuery. [transfer full] |
void gst_query_parse_uri (GstQuery *query
,gchar **uri
);
Parse an URI query, writing the URI into uri
as a newly
allocated string, if the respective parameters are non-NULL.
Free the string with g_free()
after usage.
|
a GstQuery |
|
the storage for the current URI (may be NULL). [out][transfer full][allow-none] |
void gst_query_set_uri (GstQuery *query
,const gchar *uri
);
Answer a URI query by setting the requested URI.
|
a GstQuery with query type GST_QUERY_URI |
|
the URI to set |
GstQuery * gst_query_new_allocation (GstCaps *caps
,gboolean need_pool
);
Constructs a new query object for querying the allocation properties.
Free-function: gst_query_unref
|
the negotiated caps |
|
return a pool |
Returns : |
a new GstQuery. [transfer full] |
void gst_query_parse_allocation (GstQuery *query
,GstCaps **caps
,gboolean *need_pool
);
Parse an allocation query, writing the requested caps in caps
and
whether a pool is needed in need_pool
, if the respective parameters
are non-NULL.
|
a GstQuery |
|
The GstCaps. [out][transfer none][allow-none] |
|
Whether a GstBufferPool is needed. [out][allow-none] |
void gst_query_add_allocation_pool (GstQuery *query
,GstBufferPool *pool
,guint size
,guint min_buffers
,guint max_buffers
);
Set the pool parameters in query
.
|
A valid GstQuery of type GST_QUERY_ALLOCATION. |
|
the GstBufferPool |
|
the size |
|
the min buffers |
|
the max buffers |
guint gst_query_get_n_allocation_pools (GstQuery *query
);
Retrieve the number of values currently stored in the pool array of the query's structure.
void gst_query_parse_nth_allocation_pool (GstQuery *query
,guint index
,GstBufferPool **pool
,guint *size
,guint *min_buffers
,guint *max_buffers
);
Get the pool parameters in query
.
Unref pool
with gst_object_unref()
when it's not needed any more.
|
A valid GstQuery of type GST_QUERY_ALLOCATION. |
|
index to parse |
|
the GstBufferPool. [out][allow-none][transfer full] |
|
the size. [out][allow-none] |
|
the min buffers. [out][allow-none] |
|
the max buffers. [out][allow-none] |
void gst_query_set_nth_allocation_pool (GstQuery *query
,guint index
,GstBufferPool *pool
,guint size
,guint min_buffers
,guint max_buffers
);
Set the pool parameters in query
.
|
index to modify |
|
A valid GstQuery of type GST_QUERY_ALLOCATION. |
|
the GstBufferPool |
|
the size |
|
the min buffers |
|
the max buffers |
void gst_query_remove_nth_allocation_pool (GstQuery *query
,guint index
);
Remove the allocation pool at index
of the allocation pool array.
|
a GST_QUERY_ALLOCATION type query GstQuery |
|
position in the allocation pool array to remove |
Since 1.2
void gst_query_add_allocation_param (GstQuery *query
,GstAllocator *allocator
,const GstAllocationParams *params
);
Add allocator
and its params
as a supported memory allocator.
|
a GST_QUERY_ALLOCATION type query GstQuery |
|
the memory allocator. [transfer none][allow-none] |
|
a GstAllocationParams. [transfer none][allow-none] |
guint gst_query_get_n_allocation_params (GstQuery *query
);
Retrieve the number of values currently stored in the allocator params array of the query's structure.
If no memory allocator is specified, the downstream element can handle the default memory allocator. The first memory allocator in the query should be generic and allow mapping to system memory, all following allocators should be ordered by preference with the preferred one first.
void gst_query_parse_nth_allocation_param (GstQuery *query
,guint index
,GstAllocator **allocator
,GstAllocationParams *params
);
Parse an available query and get the alloctor and its params
at index
of the allocator array.
|
a GST_QUERY_ALLOCATION type query GstQuery |
|
position in the allocator array to read |
|
variable to hold the result. [out][transfer full][allow-none] |
|
parameters for the allocator. [out][allow-none] |
void gst_query_set_nth_allocation_param (GstQuery *query
,guint index
,GstAllocator *allocator
,const GstAllocationParams *params
);
Parse an available query and get the alloctor and its params
at index
of the allocator array.
|
a GST_QUERY_ALLOCATION type query GstQuery |
|
position in the allocator array to set |
|
new allocator to set. [transfer none][allow-none] |
|
parameters for the allocator. [transfer none][allow-none] |
void gst_query_remove_nth_allocation_param (GstQuery *query
,guint index
);
Remove the allocation param at index
of the allocation param array.
|
a GST_QUERY_ALLOCATION type query GstQuery |
|
position in the allocation param array to remove |
Since 1.2
void gst_query_add_allocation_meta (GstQuery *query
,GType api
,const GstStructure *params
);
Add api
with params
as one of the supported metadata API to query
.
|
a GST_QUERY_ALLOCATION type query GstQuery |
|
the metadata API |
|
API specific parameters. [transfer none][allow-none] |
guint gst_query_get_n_allocation_metas (GstQuery *query
);
Retrieve the number of values currently stored in the meta API array of the query's structure.
GType gst_query_parse_nth_allocation_meta (GstQuery *query
,guint index
,const GstStructure **params
);
Parse an available query and get the metadata API
at index
of the metadata API array.
void gst_query_remove_nth_allocation_meta (GstQuery *query
,guint index
);
Remove the metadata API at index
of the metadata API array.
|
a GST_QUERY_ALLOCATION type query GstQuery |
|
position in the metadata API array to remove |
gboolean gst_query_find_allocation_meta (GstQuery *query
,GType api
,guint *index
);
Check if query
has metadata api
set. When this function returns TRUE,
index
will contain the index where the requested API and the flags can be
found.
|
a GST_QUERY_ALLOCATION type query GstQuery |
|
the metadata API |
|
the index. [out][transfer none][allow-none] |
Returns : |
TRUE when api is in the list of metadata. |
typedef enum { GST_SCHEDULING_FLAG_SEEKABLE = (1 << 0), GST_SCHEDULING_FLAG_SEQUENTIAL = (1 << 1), GST_SCHEDULING_FLAG_BANDWIDTH_LIMITED = (1 << 2) } GstSchedulingFlags;
The different scheduling flags.
GstQuery * gst_query_new_scheduling (void
);
Constructs a new query object for querying the scheduling properties.
Free-function: gst_query_unref
Returns : |
a new GstQuery. [transfer full] |
void gst_query_parse_scheduling (GstQuery *query
,GstSchedulingFlags *flags
,gint *minsize
,gint *maxsize
,gint *align
);
Set the scheduling properties.
|
A valid GstQuery of type GST_QUERY_SCHEDULING. |
|
GstSchedulingFlags. [out][allow-none] |
|
the suggested minimum size of pull requests. [out][allow-none] |
|
the suggested maximum size of pull requests:. [out][allow-none] |
|
the suggested alignment of pull requests. [out][allow-none] |
void gst_query_set_scheduling (GstQuery *query
,GstSchedulingFlags flags
,gint minsize
,gint maxsize
,gint align
);
Set the scheduling properties.
|
A valid GstQuery of type GST_QUERY_SCHEDULING. |
|
GstSchedulingFlags |
|
the suggested minimum size of pull requests |
|
the suggested maximum size of pull requests |
|
the suggested alignment of pull requests |
void gst_query_add_scheduling_mode (GstQuery *query
,GstPadMode mode
);
Add mode
as aone of the supported scheduling modes to query
.
|
a GST_QUERY_SCHEDULING type query GstQuery |
|
a GstPadMode |
guint gst_query_get_n_scheduling_modes (GstQuery *query
);
Retrieve the number of values currently stored in the scheduling mode array of the query's structure.
GstPadMode gst_query_parse_nth_scheduling_mode (GstQuery *query
,guint index
);
Parse an available query and get the scheduling mode
at index
of the scheduling modes array.
|
a GST_QUERY_SCHEDULING type query GstQuery |
|
position in the scheduling modes array to read |
Returns : |
a GstPadMode of the scheduling mode at index . |
gboolean gst_query_has_scheduling_mode (GstQuery *query
,GstPadMode mode
);
Check if query
has scheduling mode set.
When checking if upstream supports pull mode, it is usually not
enough to just check for GST_PAD_MODE_PULL with this function, you
also want to check whether the scheduling flags returned by
gst_query_parse_scheduling()
have the seeking flag set (meaning
random access is supported, not only sequential pulls).
|
a GST_QUERY_SCHEDULING type query GstQuery |
|
the scheduling mode |
Returns : |
TRUE when mode is in the list of scheduling modes. |
gboolean gst_query_has_scheduling_mode_with_flags (GstQuery *query
,GstPadMode mode
,GstSchedulingFlags flags
);
Check if query
has scheduling mode set and flags
is set in
query scheduling flags.
|
a GST_QUERY_SCHEDULING type query GstQuery |
|
the scheduling mode |
|
GstSchedulingFlags |
Returns : |
TRUE when mode is in the list of scheduling modes
and flags are compatible with query flags. |
GstQuery * gst_query_new_drain (void
);
Constructs a new query object for querying the drain state.
Free-function: gst_query_unref
Returns : |
a new GstQuery. [transfer full] |
GstQuery * gst_query_new_context (void
);
Constructs a new query object for querying the pipeline-local context.
Free-function: gst_query_unref
Returns : |
a new GstQuery. [transfer full] |
Since 1.2
void gst_query_set_context (GstQuery *query
,GstContext *context
);
Answer a context query by setting the requested context.
|
a GstQuery with query type GST_QUERY_CONTEXT |
|
the requested GstContext |
Since 1.2
void gst_query_parse_context (GstQuery *query
,GstContext **context
);
Get the context from the context query
. The context remains valid as long as
query
remains valid.
|
The query to parse |
|
A pointer to store the GstContext. [out][transfer none] |
Since 1.2
void gst_query_add_context_type (GstQuery *query
,const gchar *context_type
);
Add a new context type to query
.
|
a GST_QUERY_CONTEXT type query |
|
a context type |
Since 1.2
guint gst_query_get_n_context_types (GstQuery *query
);
Retrieve the number of values currently stored in the context-types array of the query's structure.
|
a GST_QUERY_CONTEXT type query |
Returns : |
the context-types array size as a guint. |
Since 1.2
gboolean gst_query_parse_nth_context_type (GstQuery *query
,guint i
,const gchar **context_type
);
Parse a context type from an existing GST_QUERY_CONTEXT query
from index
.
|
a GST_QUERY_CONTEXT type query |
|
the context type, or NULL. [out][transfer none][allow-none] |
Returns : |
a gboolean indicating if the parsing succeeded. |
Since 1.2