GstBaseSink

GstBase.BaseSink

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Element
                ╰──GstBase.BaseSink

GstBase.BaseSink.prototype.do_preroll

function GstBase.BaseSink.prototype.do_preroll(obj: Gst.MiniObject): {
    // javascript wrapper for 'gst_base_sink_do_preroll'
}

If the sink spawns its own thread for pulling buffers from upstream it should call this method after it has pulled a buffer. If the element needed to preroll, this function will perform the preroll and will then block until the element state is changed.

This function should be called with the PREROLL_LOCK held.

GstBase.BaseSink.prototype.get_blocksize

function GstBase.BaseSink.prototype.get_blocksize(): {
    // javascript wrapper for 'gst_base_sink_get_blocksize'
}

Get the number of bytes that the sink will pull when it is operating in pull mode.

GstBase.BaseSink.prototype.get_drop_out_of_segment

function GstBase.BaseSink.prototype.get_drop_out_of_segment(): {
    // javascript wrapper for 'gst_base_sink_get_drop_out_of_segment'
}

Checks if sink is currently configured to drop buffers which are outside the current segment

Since : 1.12

GstBase.BaseSink.prototype.get_last_sample

function GstBase.BaseSink.prototype.get_last_sample(): {
    // javascript wrapper for 'gst_base_sink_get_last_sample'
}

Get the last sample that arrived in the sink and was used for preroll or for rendering. This property can be used to generate thumbnails.

The Gst.Caps on the sample can be used to determine the type of the buffer.

Free-function: gst_sample_unref

GstBase.BaseSink.prototype.get_latency

function GstBase.BaseSink.prototype.get_latency(): {
    // javascript wrapper for 'gst_base_sink_get_latency'
}

Get the currently configured latency.

GstBase.BaseSink.prototype.get_max_bitrate

function GstBase.BaseSink.prototype.get_max_bitrate(): {
    // javascript wrapper for 'gst_base_sink_get_max_bitrate'
}

Get the maximum amount of bits per second that the sink will render.

Since : 1.2

GstBase.BaseSink.prototype.get_max_lateness

function GstBase.BaseSink.prototype.get_max_lateness(): {
    // javascript wrapper for 'gst_base_sink_get_max_lateness'
}

Gets the max lateness value. See GstBase.BaseSink.prototype.set_max_lateness for more details.

GstBase.BaseSink.prototype.get_processing_deadline

function GstBase.BaseSink.prototype.get_processing_deadline(): {
    // javascript wrapper for 'gst_base_sink_get_processing_deadline'
}

Get the processing deadline of sink. see GstBase.BaseSink.prototype.set_processing_deadline for more information about the processing deadline.

Since : 1.16

GstBase.BaseSink.prototype.get_render_delay

function GstBase.BaseSink.prototype.get_render_delay(): {
    // javascript wrapper for 'gst_base_sink_get_render_delay'
}

Get the render delay of sink. see GstBase.BaseSink.prototype.set_render_delay for more information about the render delay.

GstBase.BaseSink.prototype.get_stats

function GstBase.BaseSink.prototype.get_stats(): {
    // javascript wrapper for 'gst_base_sink_get_stats'
}

Return various GstBase.BaseSink statistics. This function returns a Gst.Structure with name application/x-gst-base-sink-stats with the following fields:

• "average-rate" G_TYPE_DOUBLE average frame rate
• "dropped" G_TYPE_UINT64 Number of dropped frames
• "rendered" G_TYPE_UINT64 Number of rendered frames

Since : 1.18

GstBase.BaseSink.prototype.get_sync

function GstBase.BaseSink.prototype.get_sync(): {
    // javascript wrapper for 'gst_base_sink_get_sync'
}

Checks if sink is currently configured to synchronize against the clock.

GstBase.BaseSink.prototype.get_throttle_time

function GstBase.BaseSink.prototype.get_throttle_time(): {
    // javascript wrapper for 'gst_base_sink_get_throttle_time'
}

Get the time that will be inserted between frames to control the maximum buffers per second.

GstBase.BaseSink.prototype.get_ts_offset

function GstBase.BaseSink.prototype.get_ts_offset(): {
    // javascript wrapper for 'gst_base_sink_get_ts_offset'
}

Get the synchronisation offset of sink.

GstBase.BaseSink.prototype.is_async_enabled

function GstBase.BaseSink.prototype.is_async_enabled(): {
    // javascript wrapper for 'gst_base_sink_is_async_enabled'
}

Checks if sink is currently configured to perform asynchronous state changes to PAUSED.

GstBase.BaseSink.prototype.is_last_sample_enabled

function GstBase.BaseSink.prototype.is_last_sample_enabled(): {
    // javascript wrapper for 'gst_base_sink_is_last_sample_enabled'
}

Checks if sink is currently configured to store the last received sample in the last-sample property.

GstBase.BaseSink.prototype.is_qos_enabled

function GstBase.BaseSink.prototype.is_qos_enabled(): {
    // javascript wrapper for 'gst_base_sink_is_qos_enabled'
}

Checks if sink is currently configured to send Quality-of-Service events upstream.

GstBase.BaseSink.prototype.query_latency

function GstBase.BaseSink.prototype.query_latency(): {
    // javascript wrapper for 'gst_base_sink_query_latency'
}

Query the sink for the latency parameters. The latency will be queried from the upstream elements. live will be true if sink is configured to synchronize against the clock. upstream_live will be true if an upstream element is live.

If both live and upstream_live are true, the sink will want to compensate for the latency introduced by the upstream elements by setting the min_latency to a strictly positive value.

This function is mostly used by subclasses.

GstBase.BaseSink.prototype.set_async_enabled

function GstBase.BaseSink.prototype.set_async_enabled(enabled: Number): {
    // javascript wrapper for 'gst_base_sink_set_async_enabled'
}

Configures sink to perform all state changes asynchronously. When async is disabled, the sink will immediately go to PAUSED instead of waiting for a preroll buffer. This feature is useful if the sink does not synchronize against the clock or when it is dealing with sparse streams.

GstBase.BaseSink.prototype.set_blocksize

function GstBase.BaseSink.prototype.set_blocksize(blocksize: Number): {
    // javascript wrapper for 'gst_base_sink_set_blocksize'
}

Set the number of bytes that the sink will pull when it is operating in pull mode.

GstBase.BaseSink.prototype.set_drop_out_of_segment

function GstBase.BaseSink.prototype.set_drop_out_of_segment(drop_out_of_segment: Number): {
    // javascript wrapper for 'gst_base_sink_set_drop_out_of_segment'
}

Configure sink to drop buffers which are outside the current segment

Since : 1.12

GstBase.BaseSink.prototype.set_last_sample_enabled

function GstBase.BaseSink.prototype.set_last_sample_enabled(enabled: Number): {
    // javascript wrapper for 'gst_base_sink_set_last_sample_enabled'
}

Configures sink to store the last received sample in the last-sample property.

GstBase.BaseSink.prototype.set_max_bitrate

function GstBase.BaseSink.prototype.set_max_bitrate(max_bitrate: Number): {
    // javascript wrapper for 'gst_base_sink_set_max_bitrate'
}

Set the maximum amount of bits per second that the sink will render.

Since : 1.2

GstBase.BaseSink.prototype.set_max_lateness

function GstBase.BaseSink.prototype.set_max_lateness(max_lateness: Number): {
    // javascript wrapper for 'gst_base_sink_set_max_lateness'
}

Sets the new max lateness value to max_lateness. This value is used to decide if a buffer should be dropped or not based on the buffer timestamp and the current clock time. A value of -1 means an unlimited time.

GstBase.BaseSink.prototype.set_processing_deadline

function GstBase.BaseSink.prototype.set_processing_deadline(processing_deadline: Number): {
    // javascript wrapper for 'gst_base_sink_set_processing_deadline'
}

Maximum amount of time (in nanoseconds) that the pipeline can take for processing the buffer. This is added to the latency of live pipelines.

This function is usually called by subclasses.

Since : 1.16

GstBase.BaseSink.prototype.set_qos_enabled

function GstBase.BaseSink.prototype.set_qos_enabled(enabled: Number): {
    // javascript wrapper for 'gst_base_sink_set_qos_enabled'
}

Configures sink to send Quality-of-Service events upstream.

GstBase.BaseSink.prototype.set_render_delay

function GstBase.BaseSink.prototype.set_render_delay(delay: Number): {
    // javascript wrapper for 'gst_base_sink_set_render_delay'
}

Set the render delay in sink to delay. The render delay is the time between actual rendering of a buffer and its synchronisation time. Some devices might delay media rendering which can be compensated for with this function.

After calling this function, this sink will report additional latency and other sinks will adjust their latency to delay the rendering of their media.

This function is usually called by subclasses.

GstBase.BaseSink.prototype.set_sync

function GstBase.BaseSink.prototype.set_sync(sync: Number): {
    // javascript wrapper for 'gst_base_sink_set_sync'
}

Configures sink to synchronize on the clock or not. When sync is false, incoming samples will be played as fast as possible. If sync is true, the timestamps of the incoming buffers will be used to schedule the exact render time of its contents.

GstBase.BaseSink.prototype.set_throttle_time

function GstBase.BaseSink.prototype.set_throttle_time(throttle: Number): {
    // javascript wrapper for 'gst_base_sink_set_throttle_time'
}

Set the time that will be inserted between rendered buffers. This can be used to control the maximum buffers per second that the sink will render.

GstBase.BaseSink.prototype.set_ts_offset

function GstBase.BaseSink.prototype.set_ts_offset(offset: Number): {
    // javascript wrapper for 'gst_base_sink_set_ts_offset'
}

Adjust the synchronisation of sink with offset. A negative value will render buffers earlier than their timestamp. A positive value will delay rendering. This function can be used to fix playback of badly timestamped buffers.

GstBase.BaseSink.prototype.wait

function GstBase.BaseSink.prototype.wait(time: Number): {
    // javascript wrapper for 'gst_base_sink_wait'
}

This function will wait for preroll to complete and will then block until time is reached. It is usually called by subclasses that use their own internal synchronisation but want to let some synchronization (like EOS) be handled by the base class.

This function should only be called with the PREROLL_LOCK held (like when receiving an EOS event in the ::event vmethod or when handling buffers in ::render).

The time argument should be the running_time of when the timeout should happen and will be adjusted with any latency and offset configured in the sink.

GstBase.BaseSink.prototype.wait_clock

function GstBase.BaseSink.prototype.wait_clock(time: Number): {
    // javascript wrapper for 'gst_base_sink_wait_clock'
}

This function will block until time is reached. It is usually called by subclasses that use their own internal synchronisation.

If time is not valid, no synchronisation is done and Gst.ClockReturn.BADTIME is returned. Likewise, if synchronisation is disabled in the element or there is no clock, no synchronisation is done and Gst.ClockReturn.BADTIME is returned.

This function should only be called with the PREROLL_LOCK held, like when receiving an EOS event in the vfunc_event vmethod or when receiving a buffer in the vfunc_render vmethod.

The time argument should be the running_time of when this method should return and is not adjusted with any latency or offset configured in the sink.

GstBase.BaseSink.prototype.wait_preroll

function GstBase.BaseSink.prototype.wait_preroll(): {
    // javascript wrapper for 'gst_base_sink_wait_preroll'
}

If the vfunc_render method performs its own synchronisation against the clock it must unblock when going from PLAYING to the PAUSED state and call this method before continuing to render the remaining data.

If the vfunc_render method can block on something else than the clock, it must also be ready to unblock immediately on the vfunc_unlock method and cause the vfunc_render method to immediately call this function. In this case, the subclass must be prepared to continue rendering where it left off if this function returns Gst.FlowReturn.OK.

This function will block until a state change to PLAYING happens (in which case this function returns Gst.FlowReturn.OK) or the processing must be stopped due to a state change to READY or a FLUSH event (in which case this function returns Gst.FlowReturn.FLUSHING).

This function should only be called with the PREROLL_LOCK held, like in the render function.

async

“async” Number

If set to true, the basesink will perform asynchronous state changes. When set to false, the sink will not signal the parent when it prerolls. Use this option when dealing with sparse streams or when synchronisation is not required.

Flags : Read / Write

blocksize

“blocksize” Number

The amount of bytes to pull when operating in pull mode.

Flags : Read / Write

enable-last-sample

“enable-last-sample” Number

Enable the last-sample property. If false, basesink doesn't keep a reference to the last buffer arrived and the last-sample property is always set to null. This can be useful if you need buffers to be released as soon as possible, eg. if you're using a buffer pool.

Flags : Read / Write

last-sample

“last-sample” Gst.Sample

The last buffer that arrived in the sink and was used for preroll or for rendering. This property can be used to generate thumbnails. This property can be null when the sink has not yet received a buffer.

Flags : Read

max-bitrate

“max-bitrate” Number

Control the maximum amount of bits that will be rendered per second. Setting this property to a value bigger than 0 will make the sink delay rendering of the buffers when it would exceed to max-bitrate.

Flags : Read / Write

Since : 1.2

max-lateness

“max-lateness” Number

Flags : Read / Write

processing-deadline

“processing-deadline” Number

Maximum amount of time (in nanoseconds) that the pipeline can take for processing the buffer. This is added to the latency of live pipelines.

Flags : Read / Write

Since : 1.16

qos

“qos” Number

Flags : Read / Write

render-delay

“render-delay” Number

The additional delay between synchronisation and actual rendering of the media. This property will add additional latency to the device in order to make other sinks compensate for the delay.

Flags : Read / Write

stats

“stats” Gst.Structure

Various GstBase.BaseSink statistics. This property returns a Gst.Structure with name application/x-gst-base-sink-stats with the following fields:

• "average-rate" G_TYPE_DOUBLE average frame rate
• "dropped" G_TYPE_UINT64 Number of dropped frames
• "rendered" G_TYPE_UINT64 Number of rendered frames

Flags : Read

Since : 1.18

sync

“sync” Number

Flags : Read / Write

throttle-time

“throttle-time” Number

The time to insert between buffers. This property can be used to control the maximum amount of buffers per second to render. Setting this property to a value bigger than 0 will make the sink create THROTTLE QoS events.

Flags : Read / Write

ts-offset

“ts-offset” Number

Controls the final synchronisation, a negative value will render the buffer earlier while a positive value delays playback. This property can be used to fix synchronisation in bad files.

Flags : Read / Write

vfunc_activate_pull

function vfunc_activate_pull(sink: GstBase.BaseSink, active: Number): {
    // javascript implementation of the 'activate_pull' virtual method
}

Subclasses should override this when they can provide an alternate method of spawning a thread to drive the pipeline in pull mode. Should start or stop the pulling thread, depending on the value of the "active" argument. Called after actually activating the sink pad in pull mode. The default implementation starts a task on the sink pad.

vfunc_event

function vfunc_event(sink: GstBase.BaseSink, event: Gst.Event): {
    // javascript implementation of the 'event' virtual method
}

Override this to handle events arriving on the sink pad

vfunc_fixate

function vfunc_fixate(sink: GstBase.BaseSink, caps: Gst.Caps): {
    // javascript implementation of the 'fixate' virtual method
}

Only useful in pull mode. Implement if you have ideas about what should be the default values for the caps you support.

vfunc_get_caps

function vfunc_get_caps(sink: GstBase.BaseSink, filter: Gst.Caps): {
    // javascript implementation of the 'get_caps' virtual method
}

Called to get sink pad caps from the subclass

vfunc_get_times

function vfunc_get_times(sink: GstBase.BaseSink, buffer: Gst.Buffer): {
    // javascript implementation of the 'get_times' virtual method
}

Called to get the start and end times for synchronising the passed buffer to the clock

vfunc_prepare

function vfunc_prepare(sink: GstBase.BaseSink, buffer: Gst.Buffer): {
    // javascript implementation of the 'prepare' virtual method
}

Called to prepare the buffer for render and preroll. This function is called before synchronisation is performed.

vfunc_prepare_list

function vfunc_prepare_list(sink: GstBase.BaseSink, buffer_list: Gst.BufferList): {
    // javascript implementation of the 'prepare_list' virtual method
}

Called to prepare the buffer list for render_list. This function is called before synchronisation is performed.

vfunc_preroll

function vfunc_preroll(sink: GstBase.BaseSink, buffer: Gst.Buffer): {
    // javascript implementation of the 'preroll' virtual method
}

Called to present the preroll buffer if desired.

vfunc_propose_allocation

function vfunc_propose_allocation(sink: GstBase.BaseSink, query: Gst.Query): {
    // javascript implementation of the 'propose_allocation' virtual method
}

configure the allocation query

vfunc_query

function vfunc_query(sink: GstBase.BaseSink, query: Gst.Query): {
    // javascript implementation of the 'query' virtual method
}

perform a Gst.Query on the element.

vfunc_render

function vfunc_render(sink: GstBase.BaseSink, buffer: Gst.Buffer): {
    // javascript implementation of the 'render' virtual method
}

Called when a buffer should be presented or output, at the correct moment if the GstBase.BaseSink has been set to sync to the clock.

vfunc_render_list

function vfunc_render_list(sink: GstBase.BaseSink, buffer_list: Gst.BufferList): {
    // javascript implementation of the 'render_list' virtual method
}

Same as render but used with buffer lists instead of buffers.

vfunc_set_caps

function vfunc_set_caps(sink: GstBase.BaseSink, caps: Gst.Caps): {
    // javascript implementation of the 'set_caps' virtual method
}

Notify subclass of changed caps

vfunc_start

function vfunc_start(sink: GstBase.BaseSink): {
    // javascript implementation of the 'start' virtual method
}

Start processing. Ideal for opening resources in the subclass

vfunc_stop

function vfunc_stop(sink: GstBase.BaseSink): {
    // javascript implementation of the 'stop' virtual method
}

Stop processing. Subclasses should use this to close resources.

vfunc_unlock

function vfunc_unlock(sink: GstBase.BaseSink): {
    // javascript implementation of the 'unlock' virtual method
}

Unlock any pending access to the resource. Subclasses should unblock any blocked function ASAP and call GstBase.BaseSink.prototype.wait_preroll

vfunc_unlock_stop

function vfunc_unlock_stop(sink: GstBase.BaseSink): {
    // javascript implementation of the 'unlock_stop' virtual method
}

Clear the previous unlock request. Subclasses should clear any state they set during vfunc_unlock, and be ready to continue where they left off after GstBase.BaseSink.prototype.wait_preroll, GstBase.BaseSink.prototype.wait or gst_wait_sink_wait_clock return or vfunc_render is called again.

vfunc_wait_event

function vfunc_wait_event(sink: GstBase.BaseSink, event: Gst.Event): {
    // javascript implementation of the 'wait_event' virtual method
}

Override this to implement custom logic to wait for the event time (for events like EOS and GAP). Subclasses should always first chain up to the default implementation.