GstPipeline

Gst.Pipeline

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Element
                ╰──Gst.Bin
                    ╰──Gst.Pipeline

Gst.Pipeline.prototype.new

function Gst.Pipeline.prototype.new(name: String): {
    // javascript wrapper for 'gst_pipeline_new'
}

Create a new pipeline with the given name.

Gst.Pipeline.prototype.auto_clock

function Gst.Pipeline.prototype.auto_clock(): {
    // javascript wrapper for 'gst_pipeline_auto_clock'
}

Let pipeline select a clock automatically. This is the default behaviour.

Use this function if you previous forced a fixed clock with Gst.Pipeline.prototype.use_clock and want to restore the default pipeline clock selection algorithm.

MT safe.

Gst.Pipeline.prototype.get_auto_flush_bus

function Gst.Pipeline.prototype.get_auto_flush_bus(): {
    // javascript wrapper for 'gst_pipeline_get_auto_flush_bus'
}

Check if pipeline will automatically flush messages when going to the NULL state.

Gst.Pipeline.prototype.get_bus

function Gst.Pipeline.prototype.get_bus(): {
    // javascript wrapper for 'gst_pipeline_get_bus'
}

Gets the Gst.Bus of pipeline. The bus allows applications to receive Gst.Message packets.

Gst.Pipeline.prototype.get_configured_latency

function Gst.Pipeline.prototype.get_configured_latency(): {
    // javascript wrapper for 'gst_pipeline_get_configured_latency'
}

Return the configured latency on pipeline.

Since : 1.24

Gst.Pipeline.prototype.get_delay

function Gst.Pipeline.prototype.get_delay(): {
    // javascript wrapper for 'gst_pipeline_get_delay'
}

Get the configured delay (see Gst.Pipeline.prototype.set_delay).

Gst.Pipeline.prototype.get_latency

function Gst.Pipeline.prototype.get_latency(): {
    // javascript wrapper for 'gst_pipeline_get_latency'
}

Gets the latency that should be configured on the pipeline. See Gst.Pipeline.prototype.set_latency.

Since : 1.6

Gst.Pipeline.prototype.get_pipeline_clock

function Gst.Pipeline.prototype.get_pipeline_clock(): {
    // javascript wrapper for 'gst_pipeline_get_pipeline_clock'
}

Gets the current clock used by pipeline.

Unlike Gst.Element.prototype.get_clock, this function will always return a clock, even if the pipeline is not in the PLAYING state.

Since : 1.6

Gst.Pipeline.prototype.is_live

function Gst.Pipeline.prototype.is_live(): {
    // javascript wrapper for 'gst_pipeline_is_live'
}

Check if pipeline is live.

Since : 1.24

Gst.Pipeline.prototype.set_auto_flush_bus

function Gst.Pipeline.prototype.set_auto_flush_bus(auto_flush: Number): {
    // javascript wrapper for 'gst_pipeline_set_auto_flush_bus'
}

Usually, when a pipeline goes from READY to NULL state, it automatically flushes all pending messages on the bus, which is done for refcounting purposes, to break circular references.

This means that applications that update state using (async) bus messages (e.g. do certain things when a pipeline goes from PAUSED to READY) might not get to see messages when the pipeline is shut down, because they might be flushed before they can be dispatched in the main thread. This behaviour can be disabled using this function.

It is important that all messages on the bus are handled when the automatic flushing is disabled else memory leaks will be introduced.

MT safe.

Gst.Pipeline.prototype.set_delay

function Gst.Pipeline.prototype.set_delay(delay: Number): {
    // javascript wrapper for 'gst_pipeline_set_delay'
}

Set the expected delay needed for all elements to perform the PAUSED to PLAYING state change. delay will be added to the base time of the elements so that they wait an additional delay amount of time before starting to process buffers and cannot be Gst.CLOCK_TIME_NONE.

This option is used for tuning purposes and should normally not be used.

MT safe.

Gst.Pipeline.prototype.set_latency

function Gst.Pipeline.prototype.set_latency(latency: Number): {
    // javascript wrapper for 'gst_pipeline_set_latency'
}

Sets the latency that should be configured on the pipeline. Setting GST_CLOCK_TIME_NONE will restore the default behaviour of using the minimum latency from the LATENCY query. Setting this is usually not required and the pipeline will figure out an appropriate latency automatically.

Setting a too low latency, especially lower than the minimum latency from the LATENCY query, will most likely cause the pipeline to fail.

Since : 1.6

Gst.Pipeline.prototype.use_clock

function Gst.Pipeline.prototype.use_clock(clock: Gst.Clock): {
    // javascript wrapper for 'gst_pipeline_use_clock'
}

Force pipeline to use the given clock. The pipeline will always use the given clock even if new clock providers are added to this pipeline.

If clock is null all clocking will be disabled which will make the pipeline run as fast as possible.

MT safe.

auto-flush-bus

“auto-flush-bus” Number

Whether or not to automatically flush all messages on the pipeline's bus when going from READY to NULL state. Please see Gst.Pipeline.prototype.set_auto_flush_bus for more information on this option.

Flags : Read / Write

delay

“delay” Number

The expected delay needed for elements to spin up to the PLAYING state expressed in nanoseconds. see Gst.Pipeline.prototype.set_delay for more information on this option.

Flags : Read / Write

latency

“latency” Number

Latency to configure on the pipeline. See Gst.Pipeline.prototype.set_latency.

Flags : Read / Write

Since : 1.6

Gst.PipelineFlags

Pipeline flags