GstAppSrc

GstApp.AppSrc

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Element
                ╰──GstBase.BaseSrc
                    ╰──GstApp.AppSrc

GstApp.AppSrc.prototype.end_of_stream

function GstApp.AppSrc.prototype.end_of_stream(): {
    // javascript wrapper for 'gst_app_src_end_of_stream'
}

Indicates to the appsrc element that the last buffer queued in the element is the last buffer of the stream.

GstApp.AppSrc.prototype.get_caps

function GstApp.AppSrc.prototype.get_caps(): {
    // javascript wrapper for 'gst_app_src_get_caps'
}

Get the configured caps on appsrc.

GstApp.AppSrc.prototype.get_current_level_buffers

function GstApp.AppSrc.prototype.get_current_level_buffers(): {
    // javascript wrapper for 'gst_app_src_get_current_level_buffers'
}

Get the number of currently queued buffers inside appsrc.

Since : 1.20

GstApp.AppSrc.prototype.get_current_level_bytes

function GstApp.AppSrc.prototype.get_current_level_bytes(): {
    // javascript wrapper for 'gst_app_src_get_current_level_bytes'
}

Get the number of currently queued bytes inside appsrc.

Since : 1.2

GstApp.AppSrc.prototype.get_current_level_time

function GstApp.AppSrc.prototype.get_current_level_time(): {
    // javascript wrapper for 'gst_app_src_get_current_level_time'
}

Get the amount of currently queued time inside appsrc.

Since : 1.20

GstApp.AppSrc.prototype.get_duration

function GstApp.AppSrc.prototype.get_duration(): {
    // javascript wrapper for 'gst_app_src_get_duration'
}

Get the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is not known.

Since : 1.10

GstApp.AppSrc.prototype.get_emit_signals

function GstApp.AppSrc.prototype.get_emit_signals(): {
    // javascript wrapper for 'gst_app_src_get_emit_signals'
}

Check if appsrc will emit the "new-preroll" and "new-buffer" signals.

GstApp.AppSrc.prototype.get_latency

function GstApp.AppSrc.prototype.get_latency(): {
    // javascript wrapper for 'gst_app_src_get_latency'
}

Retrieve the min and max latencies in min and max respectively.

GstApp.AppSrc.prototype.get_leaky_type

function GstApp.AppSrc.prototype.get_leaky_type(): {
    // javascript wrapper for 'gst_app_src_get_leaky_type'
}

Returns the currently set GstApp.AppLeakyType. See GstApp.AppSrc.prototype.set_leaky_type for more details.

Since : 1.20

GstApp.AppSrc.prototype.get_max_buffers

function GstApp.AppSrc.prototype.get_max_buffers(): {
    // javascript wrapper for 'gst_app_src_get_max_buffers'
}

Get the maximum amount of buffers that can be queued in appsrc.

Since : 1.20

GstApp.AppSrc.prototype.get_max_bytes

function GstApp.AppSrc.prototype.get_max_bytes(): {
    // javascript wrapper for 'gst_app_src_get_max_bytes'
}

Get the maximum amount of bytes that can be queued in appsrc.

GstApp.AppSrc.prototype.get_max_time

function GstApp.AppSrc.prototype.get_max_time(): {
    // javascript wrapper for 'gst_app_src_get_max_time'
}

Get the maximum amount of time that can be queued in appsrc.

Since : 1.20

GstApp.AppSrc.prototype.get_size

function GstApp.AppSrc.prototype.get_size(): {
    // javascript wrapper for 'gst_app_src_get_size'
}

Get the size of the stream in bytes. A value of -1 means that the size is not known.

GstApp.AppSrc.prototype.get_stream_type

function GstApp.AppSrc.prototype.get_stream_type(): {
    // javascript wrapper for 'gst_app_src_get_stream_type'
}

Get the stream type. Control the stream type of appsrc with GstApp.AppSrc.prototype.set_stream_type.

GstApp.AppSrc.prototype.push_buffer

function GstApp.AppSrc.prototype.push_buffer(buffer: Gst.Buffer): {
    // javascript wrapper for 'gst_app_src_push_buffer'
}

Adds a buffer to the queue of buffers that the appsrc element will push to its source pad. This function takes ownership of the buffer.

When the block property is TRUE, this function can block until free space becomes available in the queue.

GstApp.AppSrc.prototype.push_buffer_list

function GstApp.AppSrc.prototype.push_buffer_list(buffer_list: Gst.BufferList): {
    // javascript wrapper for 'gst_app_src_push_buffer_list'
}

Adds a buffer list to the queue of buffers and buffer lists that the appsrc element will push to its source pad. This function takes ownership of buffer_list.

When the block property is TRUE, this function can block until free space becomes available in the queue.

Since : 1.14

GstApp.AppSrc.prototype.push_sample

function GstApp.AppSrc.prototype.push_sample(sample: Gst.Sample): {
    // javascript wrapper for 'gst_app_src_push_sample'
}

Extract a buffer from the provided sample and adds it to the queue of buffers that the appsrc element will push to its source pad. Any previous caps that were set on appsrc will be replaced by the caps associated with the sample if not equal.

This function does not take ownership of the sample so the sample needs to be unreffed after calling this function.

When the block property is TRUE, this function can block until free space becomes available in the queue.

Since : 1.6

GstApp.AppSrc.prototype.set_caps

function GstApp.AppSrc.prototype.set_caps(caps: Gst.Caps): {
    // javascript wrapper for 'gst_app_src_set_caps'
}

Set the capabilities on the appsrc element. This function takes a copy of the caps structure. After calling this method, the source will only produce caps that match caps. caps must be fixed and the caps on the buffers must match the caps or left NULL.

GstApp.AppSrc.prototype.set_duration

function GstApp.AppSrc.prototype.set_duration(duration: Number): {
    // javascript wrapper for 'gst_app_src_set_duration'
}

Set the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is not known.

Since : 1.10

GstApp.AppSrc.prototype.set_emit_signals

function GstApp.AppSrc.prototype.set_emit_signals(emit: Number): {
    // javascript wrapper for 'gst_app_src_set_emit_signals'
}

Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is by default disabled because signal emission is expensive and unneeded when the application prefers to operate in pull mode.

GstApp.AppSrc.prototype.set_latency

function GstApp.AppSrc.prototype.set_latency(min: Number, max: Number): {
    // javascript wrapper for 'gst_app_src_set_latency'
}

Configure the min and max latency in src. If min is set to -1, the default latency calculations for pseudo-live sources will be used.

GstApp.AppSrc.prototype.set_leaky_type

function GstApp.AppSrc.prototype.set_leaky_type(leaky: GstApp.AppLeakyType): {
    // javascript wrapper for 'gst_app_src_set_leaky_type'
}

When set to any other value than GST_APP_LEAKY_TYPE_NONE then the appsrc will drop any buffers that are pushed into it once its internal queue is full. The selected type defines whether to drop the oldest or new buffers.

Since : 1.20

GstApp.AppSrc.prototype.set_max_buffers

function GstApp.AppSrc.prototype.set_max_buffers(max: Number): {
    // javascript wrapper for 'gst_app_src_set_max_buffers'
}

Set the maximum amount of buffers that can be queued in appsrc. After the maximum amount of buffers are queued, appsrc will emit the "enough-data" signal.

Since : 1.20

GstApp.AppSrc.prototype.set_max_bytes

function GstApp.AppSrc.prototype.set_max_bytes(max: Number): {
    // javascript wrapper for 'gst_app_src_set_max_bytes'
}

Set the maximum amount of bytes that can be queued in appsrc. After the maximum amount of bytes are queued, appsrc will emit the "enough-data" signal.

GstApp.AppSrc.prototype.set_max_time

function GstApp.AppSrc.prototype.set_max_time(max: Number): {
    // javascript wrapper for 'gst_app_src_set_max_time'
}

Set the maximum amount of time that can be queued in appsrc. After the maximum amount of time are queued, appsrc will emit the "enough-data" signal.

Since : 1.20

GstApp.AppSrc.prototype.set_size

function GstApp.AppSrc.prototype.set_size(size: Number): {
    // javascript wrapper for 'gst_app_src_set_size'
}

Set the size of the stream in bytes. A value of -1 means that the size is not known.

GstApp.AppSrc.prototype.set_stream_type

function GstApp.AppSrc.prototype.set_stream_type(type: GstApp.AppStreamType): {
    // javascript wrapper for 'gst_app_src_set_stream_type'
}

Set the stream type on appsrc. For seekable streams, the "seek" signal must be connected to.

A stream_type stream

enough-data

function enough_data_callback(self: GstApp.AppSrc, user_data: Object): {
    // javascript callback for the 'enough-data' signal
}

Signal that the source has enough data. It is recommended that the application stops calling push-buffer until the need-data signal is emitted again to avoid excessive buffer queueing.

Flags: Run Last

need-data

function need_data_callback(self: GstApp.AppSrc, length: Number, user_data: Object): {
    // javascript callback for the 'need-data' signal
}

Signal that the source needs more data. In the callback or from another thread you should call push-buffer or end-of-stream.

length is just a hint and when it is set to -1, any number of bytes can be pushed into appsrc.

You can call push-buffer multiple times until the enough-data signal is fired.

Flags: Run Last

seek-data

function seek_data_callback(self: GstApp.AppSrc, offset: Number, user_data: Object): {
    // javascript callback for the 'seek-data' signal
}

Seek to the given offset. The next push-buffer should produce buffers from the new offset. This callback is only called for seekable stream types.

Flags: Run Last

end-of-stream

let ret = self.emit ("end-of-stream", user_data);

Notify appsrc that no more buffer are available.

Flags: Run Last / Action

push-buffer

let ret = self.emit ("push-buffer", buffer, user_data);

Adds a buffer to the queue of buffers that the appsrc element will push to its source pad.

This function does not take ownership of the buffer, but it takes a reference so the buffer can be unreffed at any time after calling this function.

When the block property is TRUE, this function can block until free space becomes available in the queue.

Flags: Run Last / Action

push-buffer-list

let ret = self.emit ("push-buffer-list", buffer_list, user_data);

Adds a buffer list to the queue of buffers and buffer lists that the appsrc element will push to its source pad.

This function does not take ownership of the buffer list, but it takes a reference so the buffer list can be unreffed at any time after calling this function.

When the block property is TRUE, this function can block until free space becomes available in the queue.

Flags: Run Last / Action

Since : 1.14

push-sample

let ret = self.emit ("push-sample", sample, user_data);

Extract a buffer from the provided sample and adds the extracted buffer to the queue of buffers that the appsrc element will push to its source pad. This function set the appsrc caps based on the caps in the sample and reset the caps if they change. Only the caps and the buffer of the provided sample are used and not for example the segment in the sample.

This function does not take ownership of the sample, but it takes a reference so the sample can be unreffed at any time after calling this function.

When the block property is TRUE, this function can block until free space becomes available in the queue.

Flags: Run Last / Action

Since : 1.6

block

“block” Number

When max-bytes are queued and after the enough-data signal has been emitted, block any further push-buffer calls until the amount of queued bytes drops below the max-bytes limit.

Flags : Read / Write

caps

“caps” Gst.Caps

The GstCaps that will negotiated downstream and will be put on outgoing buffers.

Flags : Read / Write

current-level-buffers

“current-level-buffers” Number

The number of currently queued buffers inside appsrc.

Flags : Read

Since : 1.20

current-level-bytes

“current-level-bytes” Number

The number of currently queued bytes inside appsrc.

Flags : Read

Since : 1.2

current-level-time

“current-level-time” Number

The amount of currently queued time inside appsrc.

Flags : Read

Since : 1.20

duration

“duration” Number

The total duration in nanoseconds of the data stream. If the total duration is known, it is recommended to configure it with this property.

Flags : Read / Write

Since : 1.10

emit-signals

“emit-signals” Number

Make appsrc emit the "need-data", "enough-data" and "seek-data" signals. This option is by default enabled for backwards compatibility reasons but can disabled when needed because signal emission is expensive.

Flags : Read / Write

format

“format” Gst.Format

The format to use for segment events. When the source is producing timestamped buffers this property should be set to GST_FORMAT_TIME.

Flags : Read / Write

handle-segment-change

“handle-segment-change” Number

When enabled, appsrc will check GstSegment in GstSample which was pushed via GstApp.AppSrc.prototype.push_sample or "push-sample" signal action. If a GstSegment is changed, corresponding segment event will be followed by next data flow.

FIXME: currently only GST_FORMAT_TIME format is supported and therefore GstAppSrc::format should be time. However, possibly GstApp.AppSrc can support other formats.

Flags : Read / Write

Since : 1.18

is-live

“is-live” Number

Instruct the source to behave like a live source. This includes that it will only push out buffers in the PLAYING state.

Flags : Read / Write

leaky-type

“leaky-type” GstApp.AppLeakyType

When set to any other value than GST_APP_LEAKY_TYPE_NONE then the appsrc will drop any buffers that are pushed into it once its internal queue is full. The selected type defines whether to drop the oldest or new buffers.

Flags : Read / Write

Since : 1.20

max-buffers

“max-buffers” Number

The maximum amount of buffers that can be queued internally. After the maximum amount of buffers are queued, appsrc will emit the "enough-data" signal.

Flags : Read / Write

Since : 1.20

max-bytes

“max-bytes” Number

The maximum amount of bytes that can be queued internally. After the maximum amount of bytes are queued, appsrc will emit the "enough-data" signal.

Flags : Read / Write

max-latency

“max-latency” Number

Flags : Read / Write

max-time

“max-time” Number

The maximum amount of time that can be queued internally. After the maximum amount of time are queued, appsrc will emit the "enough-data" signal.

Flags : Read / Write

Since : 1.20

min-latency

“min-latency” Number

The minimum latency of the source. A value of -1 will use the default latency calculations of GstBase.BaseSrc.

Flags : Read / Write

min-percent

“min-percent” Number

Make appsrc emit the "need-data" signal when the amount of bytes in the queue drops below this percentage of max-bytes.

Flags : Read / Write

size

“size” Number

The total size in bytes of the data stream. If the total size is known, it is recommended to configure it with this property.

Flags : Read / Write

stream-type

“stream-type” GstApp.AppStreamType

The type of stream that this source is producing. For seekable streams the application should connect to the seek-data signal.

Flags : Read / Write

vfunc_end_of_stream

function vfunc_end_of_stream(appsrc: GstApp.AppSrc): {
    // javascript implementation of the 'end_of_stream' virtual method
}

vfunc_enough_data

function vfunc_enough_data(appsrc: GstApp.AppSrc): {
    // javascript implementation of the 'enough_data' virtual method
}

vfunc_need_data

function vfunc_need_data(appsrc: GstApp.AppSrc, length: Number): {
    // javascript implementation of the 'need_data' virtual method
}

vfunc_push_buffer

function vfunc_push_buffer(appsrc: GstApp.AppSrc, buffer: Gst.Buffer): {
    // javascript implementation of the 'push_buffer' virtual method
}

vfunc_push_buffer_list

function vfunc_push_buffer_list(appsrc: GstApp.AppSrc, buffer_list: Gst.BufferList): {
    // javascript implementation of the 'push_buffer_list' virtual method
}

vfunc_push_sample

function vfunc_push_sample(appsrc: GstApp.AppSrc, sample: Gst.Sample): {
    // javascript implementation of the 'push_sample' virtual method
}

vfunc_seek_data

function vfunc_seek_data(appsrc: GstApp.AppSrc, offset: Number): {
    // javascript implementation of the 'seek_data' virtual method
}

GstApp.AppLeakyType

Buffer dropping scheme to avoid the element's internal queue to block when full.

Since : 1.20

GstApp.AppStreamType

The stream type.