GstBaseSrc

GstBase.BaseSrc

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Element
                ╰──GstBase.BaseSrc
                    ╰──GstBase.PushSrc

GstBase.BaseSrc.prototype.get_allocator

function GstBase.BaseSrc.prototype.get_allocator(): {
    // javascript wrapper for 'gst_base_src_get_allocator'
}

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

Unref the allocator after usage.

GstBase.BaseSrc.prototype.get_blocksize

function GstBase.BaseSrc.prototype.get_blocksize(): {
    // javascript wrapper for 'gst_base_src_get_blocksize'
}

Get the number of bytes that src will push out with each buffer.

GstBase.BaseSrc.prototype.get_buffer_pool

function GstBase.BaseSrc.prototype.get_buffer_pool(): {
    // javascript wrapper for 'gst_base_src_get_buffer_pool'
}

GstBase.BaseSrc.prototype.get_do_timestamp

function GstBase.BaseSrc.prototype.get_do_timestamp(): {
    // javascript wrapper for 'gst_base_src_get_do_timestamp'
}

Query if src timestamps outgoing buffers based on the current running_time.

GstBase.BaseSrc.prototype.is_async

function GstBase.BaseSrc.prototype.is_async(): {
    // javascript wrapper for 'gst_base_src_is_async'
}

Get the current async behaviour of src. See also GstBase.BaseSrc.prototype.set_async.

GstBase.BaseSrc.prototype.is_live

function GstBase.BaseSrc.prototype.is_live(): {
    // javascript wrapper for 'gst_base_src_is_live'
}

Check if an element is in live mode.

GstBase.BaseSrc.prototype.negotiate

function GstBase.BaseSrc.prototype.negotiate(): {
    // javascript wrapper for 'gst_base_src_negotiate'
}

Negotiates src pad caps with downstream elements. Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again if vfunc_negotiate fails.

Do not call this in the vfunc_fill vmethod. Call this in vfunc_create or in vfunc_alloc, before any buffer is allocated.

Since : 1.18

GstBase.BaseSrc.prototype.new_seamless_segment

function GstBase.BaseSrc.prototype.new_seamless_segment(start: Number, stop: Number, time: Number): {
    // javascript wrapper for 'gst_base_src_new_seamless_segment'
}

Prepare a new seamless segment for emission downstream. This function must only be called by derived sub-classes, and only from the vfunc_create function, as the stream-lock needs to be held.

The format for the new segment will be the current format of the source, as configured with GstBase.BaseSrc.prototype.set_format

deprecated : 1.18: Use gst_base_src_new_segment()

GstBase.BaseSrc.prototype.new_segment

function GstBase.BaseSrc.prototype.new_segment(segment: Gst.Segment): {
    // javascript wrapper for 'gst_base_src_new_segment'
}

Prepare a new segment for emission downstream. This function must only be called by derived sub-classes, and only from the vfunc_create function, as the stream-lock needs to be held.

The format for the segment must be identical with the current format of the source, as configured with GstBase.BaseSrc.prototype.set_format.

The format of src must not be Gst.Format.UNDEFINED and the format should be configured via GstBase.BaseSrc.prototype.set_format before calling this method.

Since : 1.18

GstBase.BaseSrc.prototype.push_segment

function GstBase.BaseSrc.prototype.push_segment(segment: Gst.Segment): {
    // javascript wrapper for 'gst_base_src_push_segment'
}

Send a new segment downstream. This function must only be called by derived sub-classes, and only from the vfunc_create function, as the stream-lock needs to be held. This method also requires that an out caps has been configured, so GstBase.BaseSrc.prototype.set_caps needs to have been called before.

The format for the segment must be identical with the current format of the source, as configured with GstBase.BaseSrc.prototype.set_format.

The format of src must not be Gst.Format.UNDEFINED and the format should be configured via GstBase.BaseSrc.prototype.set_format before calling this method.

This is a variant of GstBase.BaseSrc.prototype.new_segment sending the segment right away, which can be useful to ensure events ordering.

Since : 1.24

GstBase.BaseSrc.prototype.query_latency

function GstBase.BaseSrc.prototype.query_latency(): {
    // javascript wrapper for 'gst_base_src_query_latency'
}

Query the source for the latency parameters. live will be true when src is configured as a live source. min_latency and max_latency will be set to the difference between the running time and the timestamp of the first buffer.

This function is mostly used by subclasses.

GstBase.BaseSrc.prototype.set_async

function GstBase.BaseSrc.prototype.set_async(async: Number): {
    // javascript wrapper for 'gst_base_src_set_async'
}

Configure async behaviour in src, no state change will block. The open, close, start, stop, play and pause virtual methods will be executed in a different thread and are thus allowed to perform blocking operations. Any blocking operation should be unblocked with the unlock vmethod.

GstBase.BaseSrc.prototype.set_automatic_eos

function GstBase.BaseSrc.prototype.set_automatic_eos(automatic_eos: Number): {
    // javascript wrapper for 'gst_base_src_set_automatic_eos'
}

If automatic_eos is true, src will automatically go EOS if a buffer after the total size is returned. By default this is true but sources that can't return an authoritative size and only know that they're EOS when trying to read more should set this to false.

When src operates in Gst.Format.TIME, GstBase.BaseSrc will send an EOS when a buffer outside of the currently configured segment is pushed if automatic_eos is true. Since 1.16, if automatic_eos is false an EOS will be pushed only when the vfunc_create implementation returns Gst.FlowReturn.EOS.

Since : 1.4

GstBase.BaseSrc.prototype.set_blocksize

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

Set the number of bytes that src will push out with each buffer. When blocksize is set to -1, a default length will be used.

GstBase.BaseSrc.prototype.set_caps

function GstBase.BaseSrc.prototype.set_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_base_src_set_caps'
}

Set new caps on the basesrc source pad.

GstBase.BaseSrc.prototype.set_do_timestamp

function GstBase.BaseSrc.prototype.set_do_timestamp(timestamp: Number): {
    // javascript wrapper for 'gst_base_src_set_do_timestamp'
}

Configure src to automatically timestamp outgoing buffers based on the current running_time of the pipeline. This property is mostly useful for live sources.

GstBase.BaseSrc.prototype.set_dynamic_size

function GstBase.BaseSrc.prototype.set_dynamic_size(dynamic: Number): {
    // javascript wrapper for 'gst_base_src_set_dynamic_size'
}

If not dynamic, size is only updated when needed, such as when trying to read past current tracked size. Otherwise, size is checked for upon each read.

GstBase.BaseSrc.prototype.set_format

function GstBase.BaseSrc.prototype.set_format(format: Gst.Format): {
    // javascript wrapper for 'gst_base_src_set_format'
}

Sets the default format of the source. This will be the format used for sending SEGMENT events and for performing seeks.

If a format of GST_FORMAT_BYTES is set, the element will be able to operate in pull mode if the vfunc_is_seekable returns true.

This function must only be called in states < Gst.State.PAUSED.

GstBase.BaseSrc.prototype.set_live

function GstBase.BaseSrc.prototype.set_live(live: Number): {
    // javascript wrapper for 'gst_base_src_set_live'
}

If the element listens to a live source, live should be set to true.

A live source will not produce data in the PAUSED state and will therefore not be able to participate in the PREROLL phase of a pipeline. To signal this fact to the application and the pipeline, the state change return value of the live source will be GST_STATE_CHANGE_NO_PREROLL.

GstBase.BaseSrc.prototype.start_complete

function GstBase.BaseSrc.prototype.start_complete(ret: Gst.FlowReturn): {
    // javascript wrapper for 'gst_base_src_start_complete'
}

Complete an asynchronous start operation. When the subclass overrides the start method, it should call GstBase.BaseSrc.prototype.start_complete when the start operation completes either from the same thread or from an asynchronous helper thread.

GstBase.BaseSrc.prototype.start_wait

function GstBase.BaseSrc.prototype.start_wait(): {
    // javascript wrapper for 'gst_base_src_start_wait'
}

Wait until the start operation completes.

GstBase.BaseSrc.prototype.submit_buffer_list

function GstBase.BaseSrc.prototype.submit_buffer_list(buffer_list: Gst.BufferList): {
    // javascript wrapper for 'gst_base_src_submit_buffer_list'
}

Subclasses can call this from their create virtual method implementation to submit a buffer list to be pushed out later. This is useful in cases where the create function wants to produce multiple buffers to be pushed out in one go in form of a Gst.BufferList, which can reduce overhead drastically, especially for packetised inputs (for data streams where the packetisation/chunking is not important it is usually more efficient to return larger buffers instead).

Subclasses that use this function from their create function must return Gst.FlowReturn.OK and no buffer from their create virtual method implementation. If a buffer is returned after a buffer list has also been submitted via this function the behaviour is undefined.

Subclasses must only call this function once per create function call and subclasses must only call this function when the source operates in push mode.

Since : 1.14

GstBase.BaseSrc.prototype.wait_playing

function GstBase.BaseSrc.prototype.wait_playing(): {
    // javascript wrapper for 'gst_base_src_wait_playing'
}

If the vfunc_create 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 produce the remaining data.

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).

automatic-eos

“automatic-eos” Number

See GstBase.BaseSrc.prototype.set_automatic_eos

Flags : Read / Write

Since : 1.24

blocksize

“blocksize” Number

Flags : Read / Write

do-timestamp

“do-timestamp” Number

Flags : Read / Write

num-buffers

“num-buffers” Number

Flags : Read / Write

typefind

“typefind” Number

Flags : Read / Write

vfunc_alloc

function vfunc_alloc(src: GstBase.BaseSrc, offset: Number, size: Number): {
    // javascript implementation of the 'alloc' virtual method
}

Ask the subclass to allocate a buffer with for offset and size. The default implementation will create a new buffer from the negotiated allocator.

vfunc_create

function vfunc_create(src: GstBase.BaseSrc, offset: Number, size: Number, buf: Gst.Buffer): {
    // javascript implementation of the 'create' virtual method
}

Ask the subclass to create a buffer with offset and size. When the subclass returns GST_FLOW_OK, it MUST return a buffer of the requested size unless fewer bytes are available because an EOS condition is near. No buffer should be returned when the return value is different from GST_FLOW_OK. A return value of GST_FLOW_EOS signifies that the end of stream is reached. The default implementation will call vfunc_alloc and then call vfunc_fill.

vfunc_decide_allocation

function vfunc_decide_allocation(src: GstBase.BaseSrc, query: Gst.Query): {
    // javascript implementation of the 'decide_allocation' virtual method
}

configure the allocation query

vfunc_do_seek

function vfunc_do_seek(src: GstBase.BaseSrc, segment: Gst.Segment): {
    // javascript implementation of the 'do_seek' virtual method
}

Perform seeking on the resource to the indicated segment.

vfunc_event

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

Override this to implement custom event handling.

vfunc_fill

function vfunc_fill(src: GstBase.BaseSrc, offset: Number, size: Number, buf: Gst.Buffer): {
    // javascript implementation of the 'fill' virtual method
}

Ask the subclass to fill the buffer with data for offset and size. The passed buffer is guaranteed to hold the requested amount of bytes.

vfunc_fixate

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

Called during negotiation if caps need fixating. Implement instead of setting a fixate function on the source pad.

vfunc_get_caps

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

Called to get the caps to report

vfunc_get_size

function vfunc_get_size(src: GstBase.BaseSrc): {
    // javascript implementation of the 'get_size' virtual method
}

Return the total size of the resource, in the format set by GstBase.BaseSrc.prototype.set_format.

vfunc_get_times

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

Given a buffer, return the start and stop time when it should be pushed out. The base class will sync on the clock using these times.

vfunc_is_seekable

function vfunc_is_seekable(src: GstBase.BaseSrc): {
    // javascript implementation of the 'is_seekable' virtual method
}

Check if the source can seek

vfunc_negotiate

function vfunc_negotiate(src: GstBase.BaseSrc): {
    // javascript implementation of the 'negotiate' virtual method
}

Negotiated the caps with the peer.

vfunc_prepare_seek_segment

function vfunc_prepare_seek_segment(src: GstBase.BaseSrc, seek: Gst.Event, segment: Gst.Segment): {
    // javascript implementation of the 'prepare_seek_segment' virtual method
}

Prepare the Gst.Segment that will be passed to the vfunc_do_seek vmethod for executing a seek request. Sub-classes should override this if they support seeking in formats other than the configured native format. By default, it tries to convert the seek arguments to the configured native format and prepare a segment in that format.

vfunc_query

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

Handle a requested query.

vfunc_set_caps

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

Notify subclass of changed output caps

vfunc_start

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

Start processing. Subclasses should open resources and prepare to produce data. Implementation should call GstBase.BaseSrc.prototype.start_complete when the operation completes, either from the current thread or any other thread that finishes the start operation asynchronously.

vfunc_stop

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

Stop processing. Subclasses should use this to close resources.

vfunc_unlock

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

Unlock any pending access to the resource. Subclasses should unblock any blocked function ASAP. In particular, any create() function in progress should be unblocked and should return GST_FLOW_FLUSHING. Any future vfunc_create function call should also return GST_FLOW_FLUSHING until the vfunc_unlock_stop function has been called.

vfunc_unlock_stop

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

Clear the previous unlock request. Subclasses should clear any state they set during vfunc_unlock, such as clearing command queues.

GstBase.BaseSrcFlags

The Gst.Element flags that a basesrc element may have.