GstQuery

Gst.Query

Gst.Query.prototype.new_accept_caps

function Gst.Query.prototype.new_accept_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_query_new_accept_caps'
}

Constructs a new query object for querying if caps are accepted.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_allocation

function Gst.Query.prototype.new_allocation(caps: Gst.Caps, need_pool: Number): {
    // javascript wrapper for 'gst_query_new_allocation'
}

Constructs a new query object for querying the allocation properties.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_bitrate

function Gst.Query.prototype.new_bitrate(): {
    // javascript wrapper for 'gst_query_new_bitrate'
}

Constructs a new query object for querying the bitrate.

Free-function: gst_query_unref (not introspectable)

Since : 1.16

Gst.Query.prototype.new_buffering

function Gst.Query.prototype.new_buffering(format: Gst.Format): {
    // javascript wrapper for 'gst_query_new_buffering'
}

Constructs a new query object for querying the buffering status of a stream.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_caps

function Gst.Query.prototype.new_caps(filter: Gst.Caps): {
    // javascript wrapper for 'gst_query_new_caps'
}

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 (not introspectable)

Gst.Query.prototype.new_context

function Gst.Query.prototype.new_context(context_type: String): {
    // javascript wrapper for 'gst_query_new_context'
}

Constructs a new query object for querying the pipeline-local context.

Free-function: gst_query_unref (not introspectable)

Since : 1.2

Gst.Query.prototype.new_convert

function Gst.Query.prototype.new_convert(src_format: Gst.Format, value: Number, dest_format: Gst.Format): {
    // javascript wrapper for 'gst_query_new_convert'
}

Constructs a new convert query object. Use gst_query_unref (not introspectable) when done with it. A convert query is used to ask for a conversion between one format and another.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_custom

function Gst.Query.prototype.new_custom(type: Gst.QueryType, structure: Gst.Structure): {
    // javascript wrapper for 'gst_query_new_custom'
}

Constructs a new custom query object. Use gst_query_unref (not introspectable) when done with it.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_drain

function Gst.Query.prototype.new_drain(): {
    // javascript wrapper for 'gst_query_new_drain'
}

Constructs a new query object for querying the drain state.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_duration

function Gst.Query.prototype.new_duration(format: Gst.Format): {
    // javascript wrapper for 'gst_query_new_duration'
}

Constructs a new stream duration query object to query in the given format. Use gst_query_unref (not introspectable) when done with it. A duration query will give the total length of the stream.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_formats

function Gst.Query.prototype.new_formats(): {
    // javascript wrapper for 'gst_query_new_formats'
}

Constructs a new query object for querying formats of the stream.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_latency

function Gst.Query.prototype.new_latency(): {
    // javascript wrapper for 'gst_query_new_latency'
}

Constructs a new latency query object. Use gst_query_unref (not introspectable) 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 (not introspectable)

Gst.Query.prototype.new_position

function Gst.Query.prototype.new_position(format: Gst.Format): {
    // javascript wrapper for 'gst_query_new_position'
}

Constructs a new query stream position query object. Use gst_query_unref (not introspectable) 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 (not introspectable)

Gst.Query.prototype.new_scheduling

function Gst.Query.prototype.new_scheduling(): {
    // javascript wrapper for 'gst_query_new_scheduling'
}

Constructs a new query object for querying the scheduling properties.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_seeking

function Gst.Query.prototype.new_seeking(format: Gst.Format): {
    // javascript wrapper for 'gst_query_new_seeking'
}

Constructs a new query object for querying seeking properties of the stream.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_segment

function Gst.Query.prototype.new_segment(format: Gst.Format): {
    // javascript wrapper for 'gst_query_new_segment'
}

Constructs a new segment query object. Use gst_query_unref (not introspectable) when done with it. A segment query is used to discover information about the currently configured segment for playback.

Free-function: gst_query_unref (not introspectable)

Gst.Query.prototype.new_selectable

function Gst.Query.prototype.new_selectable(): {
    // javascript wrapper for 'gst_query_new_selectable'
}

Constructs a new query object for querying the stream selection capability.

Free-function: gst_query_unref (not introspectable)

Since : 1.22

Gst.Query.prototype.new_uri

function Gst.Query.prototype.new_uri(): {
    // javascript wrapper for 'gst_query_new_uri'
}

Constructs a new query URI query object. Use gst_query_unref (not introspectable) 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 (not introspectable)

Gst.Query.prototype.add_allocation_meta

function Gst.Query.prototype.add_allocation_meta(api: GObject.Type, params: Gst.Structure): {
    // javascript wrapper for 'gst_query_add_allocation_meta'
}

Add api with params as one of the supported metadata API to query.

Gst.Query.prototype.add_allocation_param

function Gst.Query.prototype.add_allocation_param(allocator: Gst.Allocator, params: Gst.AllocationParams): {
    // javascript wrapper for 'gst_query_add_allocation_param'
}

Add allocator and its params as a supported memory allocator.

Gst.Query.prototype.add_allocation_pool

function Gst.Query.prototype.add_allocation_pool(pool: Gst.BufferPool, size: Number, min_buffers: Number, max_buffers: Number): {
    // javascript wrapper for 'gst_query_add_allocation_pool'
}

Set the pool parameters in query.

Gst.Query.prototype.add_buffering_range

function Gst.Query.prototype.add_buffering_range(start: Number, stop: Number): {
    // javascript wrapper for 'gst_query_add_buffering_range'
}

Set the buffering-ranges array field in query. The current last start position of the array should be inferior to start.

Gst.Query.prototype.add_scheduling_mode

function Gst.Query.prototype.add_scheduling_mode(mode: Gst.PadMode): {
    // javascript wrapper for 'gst_query_add_scheduling_mode'
}

Add mode as one of the supported scheduling modes to query.

Gst.Query.prototype.find_allocation_meta

function Gst.Query.prototype.find_allocation_meta(api: GObject.Type): {
    // javascript wrapper for 'gst_query_find_allocation_meta'
}

Check if query has metadata api set. When this function returns true, index will contain the index where the requested API and the parameters can be found.

Gst.Query.prototype.get_n_allocation_metas

function Gst.Query.prototype.get_n_allocation_metas(): {
    // javascript wrapper for 'gst_query_get_n_allocation_metas'
}

Retrieve the number of values currently stored in the meta API array of the query's structure.

Gst.Query.prototype.get_n_allocation_params

function Gst.Query.prototype.get_n_allocation_params(): {
    // javascript wrapper for 'gst_query_get_n_allocation_params'
}

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.

Gst.Query.prototype.get_n_allocation_pools

function Gst.Query.prototype.get_n_allocation_pools(): {
    // javascript wrapper for 'gst_query_get_n_allocation_pools'
}

Retrieve the number of values currently stored in the pool array of the query's structure.

Gst.Query.prototype.get_n_buffering_ranges

function Gst.Query.prototype.get_n_buffering_ranges(): {
    // javascript wrapper for 'gst_query_get_n_buffering_ranges'
}

Retrieve the number of values currently stored in the buffered-ranges array of the query's structure.

Gst.Query.prototype.get_n_scheduling_modes

function Gst.Query.prototype.get_n_scheduling_modes(): {
    // javascript wrapper for 'gst_query_get_n_scheduling_modes'
}

Retrieve the number of values currently stored in the scheduling mode array of the query's structure.

Gst.Query.prototype.get_structure

function Gst.Query.prototype.get_structure(): {
    // javascript wrapper for 'gst_query_get_structure'
}

Get the structure of a query.

Gst.Query.prototype.has_scheduling_mode

function Gst.Query.prototype.has_scheduling_mode(mode: Gst.PadMode): {
    // javascript wrapper for 'gst_query_has_scheduling_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.prototype.parse_scheduling have the seeking flag set (meaning random access is supported, not only sequential pulls).

Gst.Query.prototype.has_scheduling_mode_with_flags

function Gst.Query.prototype.has_scheduling_mode_with_flags(mode: Gst.PadMode, flags: Gst.SchedulingFlags): {
    // javascript wrapper for 'gst_query_has_scheduling_mode_with_flags'
}

Check if query has scheduling mode set and flags is set in query scheduling flags.

Gst.Query.prototype.parse_accept_caps

function Gst.Query.prototype.parse_accept_caps(): {
    // javascript wrapper for 'gst_query_parse_accept_caps'
}

Get the caps from query. The caps remains valid as long as query remains valid.

Gst.Query.prototype.parse_accept_caps_result

function Gst.Query.prototype.parse_accept_caps_result(): {
    // javascript wrapper for 'gst_query_parse_accept_caps_result'
}

Parse the result from query and store in result.

Gst.Query.prototype.parse_allocation

function Gst.Query.prototype.parse_allocation(): {
    // javascript wrapper for 'gst_query_parse_allocation'
}

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.

Pool details can be retrieved using Gst.Query.prototype.get_n_allocation_pools and Gst.Query.prototype.parse_nth_allocation_pool.

Gst.Query.prototype.parse_bitrate

function Gst.Query.prototype.parse_bitrate(): {
    // javascript wrapper for 'gst_query_parse_bitrate'
}

Get the results of a bitrate query. See also Gst.Query.prototype.set_bitrate.

Since : 1.16

Gst.Query.prototype.parse_buffering_percent

function Gst.Query.prototype.parse_buffering_percent(): {
    // javascript wrapper for 'gst_query_parse_buffering_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.

Gst.Query.prototype.parse_buffering_range

function Gst.Query.prototype.parse_buffering_range(): {
    // javascript wrapper for 'gst_query_parse_buffering_range'
}

Parse an available query, writing the format into format, and other results into the passed parameters, if the respective parameters are non-%NULL

Gst.Query.prototype.parse_buffering_stats

function Gst.Query.prototype.parse_buffering_stats(): {
    // javascript wrapper for 'gst_query_parse_buffering_stats'
}

Extracts the buffering stats values from query.

Gst.Query.prototype.parse_caps

function Gst.Query.prototype.parse_caps(): {
    // javascript wrapper for 'gst_query_parse_caps'
}

Get the filter from the caps query. The caps remains valid as long as query remains valid.

Gst.Query.prototype.parse_caps_result

function Gst.Query.prototype.parse_caps_result(): {
    // javascript wrapper for 'gst_query_parse_caps_result'
}

Get the caps result from query. The caps remains valid as long as query remains valid.

Gst.Query.prototype.parse_context

function Gst.Query.prototype.parse_context(): {
    // javascript wrapper for 'gst_query_parse_context'
}

Get the context from the context query. The context remains valid as long as query remains valid.

Since : 1.2

Gst.Query.prototype.parse_context_type

function Gst.Query.prototype.parse_context_type(): {
    // javascript wrapper for 'gst_query_parse_context_type'
}

Parse a context type from an existing GST_QUERY_CONTEXT query.

Since : 1.2

Gst.Query.prototype.parse_convert

function Gst.Query.prototype.parse_convert(): {
    // javascript wrapper for 'gst_query_parse_convert'
}

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.

Gst.Query.prototype.parse_duration

function Gst.Query.prototype.parse_duration(): {
    // javascript wrapper for 'gst_query_parse_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.

Gst.Query.prototype.parse_latency

function Gst.Query.prototype.parse_latency(): {
    // javascript wrapper for 'gst_query_parse_latency'
}

Parse a latency query answer.

Gst.Query.prototype.parse_n_formats

function Gst.Query.prototype.parse_n_formats(): {
    // javascript wrapper for 'gst_query_parse_n_formats'
}

Parse the number of formats in the formats query.

Gst.Query.prototype.parse_nth_allocation_meta

function Gst.Query.prototype.parse_nth_allocation_meta(index: Number): {
    // javascript wrapper for 'gst_query_parse_nth_allocation_meta'
}

Parse an available query and get the metadata API at index of the metadata API array.

Gst.Query.prototype.parse_nth_allocation_param

function Gst.Query.prototype.parse_nth_allocation_param(index: Number): {
    // javascript wrapper for 'gst_query_parse_nth_allocation_param'
}

Parse an available query and get the allocator and its params at index of the allocator array.

Gst.Query.prototype.parse_nth_allocation_pool

function Gst.Query.prototype.parse_nth_allocation_pool(index: Number): {
    // javascript wrapper for 'gst_query_parse_nth_allocation_pool'
}

Get the pool parameters in query.

Unref pool with Gst.Object.prototype.unref when it's not needed any more.

Gst.Query.prototype.parse_nth_buffering_range

function Gst.Query.prototype.parse_nth_buffering_range(index: Number): {
    // javascript wrapper for 'gst_query_parse_nth_buffering_range'
}

Parse an available query and get the start and stop values stored at the index of the buffered ranges array.

Gst.Query.prototype.parse_nth_format

function Gst.Query.prototype.parse_nth_format(nth: Number): {
    // javascript wrapper for 'gst_query_parse_nth_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.

Gst.Query.prototype.parse_nth_scheduling_mode

function Gst.Query.prototype.parse_nth_scheduling_mode(index: Number): {
    // javascript wrapper for 'gst_query_parse_nth_scheduling_mode'
}

Parse an available query and get the scheduling mode at index of the scheduling modes array.

Gst.Query.prototype.parse_position

function Gst.Query.prototype.parse_position(): {
    // javascript wrapper for 'gst_query_parse_position'
}

Parse a position query, writing the format into format, and the position into cur, if the respective parameters are non-%NULL.

Gst.Query.prototype.parse_scheduling

function Gst.Query.prototype.parse_scheduling(): {
    // javascript wrapper for 'gst_query_parse_scheduling'
}

Set the scheduling properties.

Gst.Query.prototype.parse_seeking

function Gst.Query.prototype.parse_seeking(): {
    // javascript wrapper for 'gst_query_parse_seeking'
}

Parse a seeking query, writing the format into format, and other results into the passed parameters, if the respective parameters are non-%NULL

Gst.Query.prototype.parse_segment

function Gst.Query.prototype.parse_segment(): {
    // javascript wrapper for 'gst_query_parse_segment'
}

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.prototype.set_segment for an explanation of the function arguments.

Gst.Query.prototype.parse_selectable

function Gst.Query.prototype.parse_selectable(): {
    // javascript wrapper for 'gst_query_parse_selectable'
}

Get the results of a selectable query. See also Gst.Query.prototype.set_selectable.

Since : 1.22

Gst.Query.prototype.parse_uri

function Gst.Query.prototype.parse_uri(): {
    // javascript wrapper for 'gst_query_parse_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 GLib.prototype.free after usage.

Gst.Query.prototype.parse_uri_redirection

function Gst.Query.prototype.parse_uri_redirection(): {
    // javascript wrapper for 'gst_query_parse_uri_redirection'
}

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 GLib.prototype.free after usage.

Since : 1.2

Gst.Query.prototype.parse_uri_redirection_permanent

function Gst.Query.prototype.parse_uri_redirection_permanent(): {
    // javascript wrapper for 'gst_query_parse_uri_redirection_permanent'
}

Parse an URI query, and set permanent to true if there is a redirection and it should be considered permanent. If a redirection is permanent, applications should update their internal storage of the URI, otherwise they should make all future requests to the original URI.

Since : 1.4

Gst.Query.prototype.ref

function Gst.Query.prototype.ref(): {
    // javascript wrapper for 'gst_query_ref'
}

Increases the refcount of the given query by one.

Gst.Query.prototype.remove_nth_allocation_meta

function Gst.Query.prototype.remove_nth_allocation_meta(index: Number): {
    // javascript wrapper for 'gst_query_remove_nth_allocation_meta'
}

Remove the metadata API at index of the metadata API array.

Gst.Query.prototype.remove_nth_allocation_param

function Gst.Query.prototype.remove_nth_allocation_param(index: Number): {
    // javascript wrapper for 'gst_query_remove_nth_allocation_param'
}

Remove the allocation param at index of the allocation param array.

Since : 1.2

Gst.Query.prototype.remove_nth_allocation_pool

function Gst.Query.prototype.remove_nth_allocation_pool(index: Number): {
    // javascript wrapper for 'gst_query_remove_nth_allocation_pool'
}

Remove the allocation pool at index of the allocation pool array.

Since : 1.2

Gst.Query.prototype.set_accept_caps_result

function Gst.Query.prototype.set_accept_caps_result(result: Number): {
    // javascript wrapper for 'gst_query_set_accept_caps_result'
}

Set result as the result for the query.

Gst.Query.prototype.set_bitrate

function Gst.Query.prototype.set_bitrate(nominal_bitrate: Number): {
    // javascript wrapper for 'gst_query_set_bitrate'
}

Set the results of a bitrate query. The nominal bitrate is the average bitrate expected over the length of the stream as advertised in file headers (or similar).

Since : 1.16

Gst.Query.prototype.set_buffering_percent

function Gst.Query.prototype.set_buffering_percent(busy: Number, percent: Number): {
    // javascript wrapper for 'gst_query_set_buffering_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.

Gst.Query.prototype.set_buffering_range

function Gst.Query.prototype.set_buffering_range(format: Gst.Format, start: Number, stop: Number, estimated_total: Number): {
    // javascript wrapper for 'gst_query_set_buffering_range'
}

Set the available query result fields in query.

Gst.Query.prototype.set_buffering_stats

function Gst.Query.prototype.set_buffering_stats(mode: Gst.BufferingMode, avg_in: Number, avg_out: Number, buffering_left: Number): {
    // javascript wrapper for 'gst_query_set_buffering_stats'
}

Configures the buffering stats values in query.

Gst.Query.prototype.set_caps_result

function Gst.Query.prototype.set_caps_result(caps: Gst.Caps): {
    // javascript wrapper for 'gst_query_set_caps_result'
}

Set the caps result in query.

Gst.Query.prototype.set_context

function Gst.Query.prototype.set_context(context: Gst.Context): {
    // javascript wrapper for 'gst_query_set_context'
}

Answer a context query by setting the requested context.

Since : 1.2

Gst.Query.prototype.set_convert

function Gst.Query.prototype.set_convert(src_format: Gst.Format, src_value: Number, dest_format: Gst.Format, dest_value: Number): {
    // javascript wrapper for 'gst_query_set_convert'
}

Answer a convert query by setting the requested values.

Gst.Query.prototype.set_duration

function Gst.Query.prototype.set_duration(format: Gst.Format, duration: Number): {
    // javascript wrapper for 'gst_query_set_duration'
}

Answer a duration query by setting the requested value in the given format.