GstAudioDecoder

GstAudio.AudioDecoder

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Element
                ╰──GstAudio.AudioDecoder

GstAudio.AudioDecoder.prototype.allocate_output_buffer

function GstAudio.AudioDecoder.prototype.allocate_output_buffer(size: Number): {
    // javascript wrapper for 'gst_audio_decoder_allocate_output_buffer'
}

Helper function that allocates a buffer to hold an audio frame for dec's current output format.

GstAudio.AudioDecoder.prototype.finish_frame

function GstAudio.AudioDecoder.prototype.finish_frame(buf: Gst.Buffer, frames: Number): {
    // javascript wrapper for 'gst_audio_decoder_finish_frame'
}

Collects decoded data and pushes it downstream.

buf may be NULL in which case the indicated number of frames are discarded and considered to have produced no output (e.g. lead-in or setup frames). Otherwise, source pad caps must be set when it is called with valid data in buf.

Note that a frame received in vfunc_handle_frame() may be invalidated by a call to this function.

GstAudio.AudioDecoder.prototype.finish_subframe

function GstAudio.AudioDecoder.prototype.finish_subframe(buf: Gst.Buffer): {
    // javascript wrapper for 'gst_audio_decoder_finish_subframe'
}

Collects decoded data and pushes it downstream. This function may be called multiple times for a given input frame.

buf may be NULL in which case it is assumed that the current input frame is finished. This is equivalent to calling GstAudio.AudioDecoder.prototype.finish_subframe with a NULL buffer and frames=1 after having pushed out all decoded audio subframes using this function.

When called with valid data in buf the source pad caps must have been set already.

Note that a frame received in vfunc_handle_frame() may be invalidated by a call to this function.

Since : 1.16

GstAudio.AudioDecoder.prototype.get_allocator

function GstAudio.AudioDecoder.prototype.get_allocator(): {
    // javascript wrapper for 'gst_audio_decoder_get_allocator'
}

Lets GstAudio.AudioDecoder sub-classes to know the memory allocator used by the base class and its params.

Unref the allocator after use it.

GstAudio.AudioDecoder.prototype.get_audio_info

function GstAudio.AudioDecoder.prototype.get_audio_info(): {
    // javascript wrapper for 'gst_audio_decoder_get_audio_info'
}

GstAudio.AudioDecoder.prototype.get_delay

function GstAudio.AudioDecoder.prototype.get_delay(): {
    // javascript wrapper for 'gst_audio_decoder_get_delay'
}

GstAudio.AudioDecoder.prototype.get_drainable

function GstAudio.AudioDecoder.prototype.get_drainable(): {
    // javascript wrapper for 'gst_audio_decoder_get_drainable'
}

Queries decoder drain handling.

GstAudio.AudioDecoder.prototype.get_estimate_rate

function GstAudio.AudioDecoder.prototype.get_estimate_rate(): {
    // javascript wrapper for 'gst_audio_decoder_get_estimate_rate'
}

GstAudio.AudioDecoder.prototype.get_latency

function GstAudio.AudioDecoder.prototype.get_latency(): {
    // javascript wrapper for 'gst_audio_decoder_get_latency'
}

Sets the variables pointed to by min and max to the currently configured latency.

GstAudio.AudioDecoder.prototype.get_max_errors

function GstAudio.AudioDecoder.prototype.get_max_errors(): {
    // javascript wrapper for 'gst_audio_decoder_get_max_errors'
}

GstAudio.AudioDecoder.prototype.get_min_latency

function GstAudio.AudioDecoder.prototype.get_min_latency(): {
    // javascript wrapper for 'gst_audio_decoder_get_min_latency'
}

Queries decoder's latency aggregation.

GstAudio.AudioDecoder.prototype.get_needs_format

function GstAudio.AudioDecoder.prototype.get_needs_format(): {
    // javascript wrapper for 'gst_audio_decoder_get_needs_format'
}

Queries decoder required format handling.

GstAudio.AudioDecoder.prototype.get_parse_state

function GstAudio.AudioDecoder.prototype.get_parse_state(): {
    // javascript wrapper for 'gst_audio_decoder_get_parse_state'
}

Return current parsing (sync and eos) state.

GstAudio.AudioDecoder.prototype.get_plc

function GstAudio.AudioDecoder.prototype.get_plc(): {
    // javascript wrapper for 'gst_audio_decoder_get_plc'
}

Queries decoder packet loss concealment handling.

GstAudio.AudioDecoder.prototype.get_plc_aware

function GstAudio.AudioDecoder.prototype.get_plc_aware(): {
    // javascript wrapper for 'gst_audio_decoder_get_plc_aware'
}

GstAudio.AudioDecoder.prototype.get_tolerance

function GstAudio.AudioDecoder.prototype.get_tolerance(): {
    // javascript wrapper for 'gst_audio_decoder_get_tolerance'
}

Queries current audio jitter tolerance threshold.

GstAudio.AudioDecoder.prototype.merge_tags

function GstAudio.AudioDecoder.prototype.merge_tags(tags: Gst.TagList, mode: Gst.TagMergeMode): {
    // javascript wrapper for 'gst_audio_decoder_merge_tags'
}

Sets the audio decoder tags and how they should be merged with any upstream stream tags. This will override any tags previously-set with GstAudio.AudioDecoder.prototype.merge_tags.

Note that this is provided for convenience, and the subclass is not required to use this and can still do tag handling on its own.

GstAudio.AudioDecoder.prototype.negotiate

function GstAudio.AudioDecoder.prototype.negotiate(): {
    // javascript wrapper for 'gst_audio_decoder_negotiate'
}

Negotiate with downstream elements to currently configured GstAudio.AudioInfo. Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if negotiate fails.

GstAudio.AudioDecoder.prototype.proxy_getcaps

function GstAudio.AudioDecoder.prototype.proxy_getcaps(caps: Gst.Caps, filter: Gst.Caps): {
    // javascript wrapper for 'gst_audio_decoder_proxy_getcaps'
}

Returns caps that express caps (or sink template caps if caps == NULL) restricted to rate/channels/... combinations supported by downstream elements.

Since : 1.6

GstAudio.AudioDecoder.prototype.set_allocation_caps

function GstAudio.AudioDecoder.prototype.set_allocation_caps(allocation_caps: Gst.Caps): {
    // javascript wrapper for 'gst_audio_decoder_set_allocation_caps'
}

Sets a caps in allocation query which are different from the set pad's caps. Use this function before calling GstAudio.AudioDecoder.prototype.negotiate. Setting to null the allocation query will use the caps from the pad.

Since : 1.10

GstAudio.AudioDecoder.prototype.set_drainable

function GstAudio.AudioDecoder.prototype.set_drainable(enabled: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_drainable'
}

Configures decoder drain handling. If drainable, subclass might be handed a NULL buffer to have it return any leftover decoded data. Otherwise, it is not considered so capable and will only ever be passed real data.

MT safe.

GstAudio.AudioDecoder.prototype.set_estimate_rate

function GstAudio.AudioDecoder.prototype.set_estimate_rate(enabled: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_estimate_rate'
}

Allows baseclass to perform byte to time estimated conversion.

GstAudio.AudioDecoder.prototype.set_latency

function GstAudio.AudioDecoder.prototype.set_latency(min: Number, max: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_latency'
}

Sets decoder latency. If the provided values changed from previously provided ones, this will also post a LATENCY message on the bus so the pipeline can reconfigure its global latency.

GstAudio.AudioDecoder.prototype.set_max_errors

function GstAudio.AudioDecoder.prototype.set_max_errors(num: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_max_errors'
}

Sets numbers of tolerated decoder errors, where a tolerated one is then only warned about, but more than tolerated will lead to fatal error. You can set -1 for never returning fatal errors. Default is set to GST_AUDIO_DECODER_MAX_ERRORS.

GstAudio.AudioDecoder.prototype.set_min_latency

function GstAudio.AudioDecoder.prototype.set_min_latency(num: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_min_latency'
}

Sets decoder minimum aggregation latency.

MT safe.

GstAudio.AudioDecoder.prototype.set_needs_format

function GstAudio.AudioDecoder.prototype.set_needs_format(enabled: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_needs_format'
}

Configures decoder format needs. If enabled, subclass needs to be negotiated with format caps before it can process any data. It will then never be handed any data before it has been configured. Otherwise, it might be handed data without having been configured and is then expected being able to do so either by default or based on the input data.

MT safe.

GstAudio.AudioDecoder.prototype.set_output_caps

function GstAudio.AudioDecoder.prototype.set_output_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_audio_decoder_set_output_caps'
}

Configure output caps on the srcpad of dec. Similar to GstAudio.AudioDecoder.prototype.set_output_format, but allows subclasses to specify output caps that can't be expressed via GstAudio.AudioInfo e.g. caps that have caps features.

Since : 1.16

GstAudio.AudioDecoder.prototype.set_output_format

function GstAudio.AudioDecoder.prototype.set_output_format(info: GstAudio.AudioInfo): {
    // javascript wrapper for 'gst_audio_decoder_set_output_format'
}

Configure output info on the srcpad of dec.

GstAudio.AudioDecoder.prototype.set_plc

function GstAudio.AudioDecoder.prototype.set_plc(enabled: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_plc'
}

Enable or disable decoder packet loss concealment, provided subclass and codec are capable and allow handling plc.

MT safe.

GstAudio.AudioDecoder.prototype.set_plc_aware

function GstAudio.AudioDecoder.prototype.set_plc_aware(plc: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_plc_aware'
}

Indicates whether or not subclass handles packet loss concealment (plc).

GstAudio.AudioDecoder.prototype.set_tolerance

function GstAudio.AudioDecoder.prototype.set_tolerance(tolerance: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_tolerance'
}

Configures decoder audio jitter tolerance threshold.

MT safe.

GstAudio.AudioDecoder.prototype.set_use_default_pad_acceptcaps

function GstAudio.AudioDecoder.prototype.set_use_default_pad_acceptcaps(use: Number): {
    // javascript wrapper for 'gst_audio_decoder_set_use_default_pad_acceptcaps'
}

Lets GstAudio.AudioDecoder sub-classes decide if they want the sink pad to use the default pad query handler to reply to accept-caps queries.

By setting this to true it is possible to further customize the default handler with GST_PAD_SET_ACCEPT_INTERSECT (not introspectable) and GST_PAD_SET_ACCEPT_TEMPLATE (not introspectable)

Since : 1.6

max-errors

“max-errors” Number

Maximum number of tolerated consecutive decode errors. See GstAudio.AudioDecoder.prototype.set_max_errors for more details.

Flags : Read / Write

Since : 1.18

min-latency

“min-latency” Number

Flags : Read / Write

plc

“plc” Number

Flags : Read / Write

tolerance

“tolerance” Number

Flags : Read / Write

vfunc_close

function vfunc_close(dec: GstAudio.AudioDecoder): {
    // javascript implementation of the 'close' virtual method
}

Optional. Called when the element changes to GST_STATE_NULL. Allows closing external resources.

vfunc_decide_allocation

function vfunc_decide_allocation(dec: GstAudio.AudioDecoder, query: Gst.Query): {
    // javascript implementation of the 'decide_allocation' virtual method
}

Optional. Setup the allocation parameters for allocating output buffers. The passed in query contains the result of the downstream allocation query. Subclasses should chain up to the parent implementation to invoke the default handler.

vfunc_flush

function vfunc_flush(dec: GstAudio.AudioDecoder, hard: Number): {
    // javascript implementation of the 'flush' virtual method
}

Optional. Instructs subclass to clear any codec caches and discard any pending samples and not yet returned decoded data. hard indicates whether a FLUSH is being processed, or otherwise a DISCONT (or conceptually similar).

vfunc_getcaps

function vfunc_getcaps(dec: GstAudio.AudioDecoder, filter: Gst.Caps): {
    // javascript implementation of the 'getcaps' virtual method
}

Optional. Allows for a custom sink getcaps implementation. If not implemented, default returns gst_audio_decoder_proxy_getcaps applied to sink template caps.

vfunc_handle_frame

function vfunc_handle_frame(dec: GstAudio.AudioDecoder, buffer: Gst.Buffer): {
    // javascript implementation of the 'handle_frame' virtual method
}

Provides input data (or NULL to clear any remaining data) to subclass. Input data ref management is performed by base class, subclass should not care or intervene, and input data is only valid until next call to base class, most notably a call to GstAudio.AudioDecoder.prototype.finish_frame.

vfunc_negotiate

function vfunc_negotiate(dec: GstAudio.AudioDecoder): {
    // javascript implementation of the 'negotiate' virtual method
}

Optional. Negotiate with downstream and configure buffer pools, etc. Subclasses should chain up to the parent implementation to invoke the default handler.

vfunc_open

function vfunc_open(dec: GstAudio.AudioDecoder): {
    // javascript implementation of the 'open' virtual method
}

Optional. Called when the element changes to GST_STATE_READY. Allows opening external resources.

vfunc_parse

function vfunc_parse(dec: GstAudio.AudioDecoder, adapter: GstBase.Adapter): {
    // javascript implementation of the 'parse' virtual method
}

Optional. Allows chopping incoming data into manageable units (frames) for subsequent decoding. This division is at subclass discretion and may or may not correspond to 1 (or more) frames as defined by audio format.

vfunc_pre_push

function vfunc_pre_push(dec: GstAudio.AudioDecoder, buffer: Gst.Buffer): {
    // javascript implementation of the 'pre_push' virtual method
}

Optional. Called just prior to pushing (encoded data) buffer downstream. Subclass has full discretionary access to buffer, and a not OK flow return will abort downstream pushing.

vfunc_propose_allocation

function vfunc_propose_allocation(dec: GstAudio.AudioDecoder, query: Gst.Query): {
    // javascript implementation of the 'propose_allocation' virtual method
}

Optional. Propose buffer allocation parameters for upstream elements. Subclasses should chain up to the parent implementation to invoke the default handler.

vfunc_set_format

function vfunc_set_format(dec: GstAudio.AudioDecoder, caps: Gst.Caps): {
    // javascript implementation of the 'set_format' virtual method
}

Notifies subclass of incoming data format (caps).

vfunc_sink_event

function vfunc_sink_event(dec: GstAudio.AudioDecoder, event: Gst.Event): {
    // javascript implementation of the 'sink_event' virtual method
}

Optional. Event handler on the sink pad. Subclasses should chain up to the parent implementation to invoke the default handler.

vfunc_sink_query

function vfunc_sink_query(dec: GstAudio.AudioDecoder, query: Gst.Query): {
    // javascript implementation of the 'sink_query' virtual method
}

Optional. Query handler on the sink pad. This function should return TRUE if the query could be performed. Subclasses should chain up to the parent implementation to invoke the default handler. Since: 1.6

vfunc_src_event

function vfunc_src_event(dec: GstAudio.AudioDecoder, event: Gst.Event): {
    // javascript implementation of the 'src_event' virtual method
}

Optional. Event handler on the src pad. Subclasses should chain up to the parent implementation to invoke the default handler.

vfunc_src_query

function vfunc_src_query(dec: GstAudio.AudioDecoder, query: Gst.Query): {
    // javascript implementation of the 'src_query' virtual method
}

Optional. Query handler on the source pad. This function should return TRUE if the query could be performed. Subclasses should chain up to the parent implementation to invoke the default handler. Since: 1.6

vfunc_start

function vfunc_start(dec: GstAudio.AudioDecoder): {
    // javascript implementation of the 'start' virtual method
}

Optional. Called when the element starts processing. Allows opening external resources.

vfunc_stop

function vfunc_stop(dec: GstAudio.AudioDecoder): {
    // javascript implementation of the 'stop' virtual method
}

Optional. Called when the element stops processing. Allows closing external resources.

vfunc_transform_meta

function vfunc_transform_meta(enc: GstAudio.AudioDecoder, outbuf: Gst.Buffer, meta: Gst.Meta, inbuf: Gst.Buffer): {
    // javascript implementation of the 'transform_meta' virtual method
}

Optional. Transform the metadata on the input buffer to the output buffer. By default this method copies all meta without tags and meta with only the "audio" tag. subclasses can implement this method and return true if the metadata is to be copied. Since: 1.6

GstAudio.AUDIO_DECODER_MAX_ERRORS

Default maximum number of errors tolerated before signaling error.

GstAudio.AUDIO_DECODER_SINK_NAME

The name of the templates for the sink pad.

GstAudio.AUDIO_DECODER_SRC_NAME

The name of the templates for the source pad.