GstAdapter

GstBase.Adapter

GObject.Object
    ╰──GstBase.Adapter

GstBase.Adapter.prototype.new

function GstBase.Adapter.prototype.new(): {
    // javascript wrapper for 'gst_adapter_new'
}

Creates a new GstBase.Adapter. Free with GObject.Object.prototype.unref.

GstBase.Adapter.prototype.available

function GstBase.Adapter.prototype.available(): {
    // javascript wrapper for 'gst_adapter_available'
}

Gets the maximum amount of bytes available, that is it returns the maximum value that can be supplied to GstBase.Adapter.prototype.map without that function returning null.

Calling GstBase.Adapter.prototype.map with the amount of bytes returned by this function may require expensive operations (like copying the data into a temporary buffer) in some cases.

GstBase.Adapter.prototype.available_fast

function GstBase.Adapter.prototype.available_fast(): {
    // javascript wrapper for 'gst_adapter_available_fast'
}

Gets the maximum number of bytes that can be retrieved in a single map operation without merging buffers.

Calling GstBase.Adapter.prototype.map with the amount of bytes returned by this function will never require any expensive operations (like copying the data into a temporary buffer).

GstBase.Adapter.prototype.clear

function GstBase.Adapter.prototype.clear(): {
    // javascript wrapper for 'gst_adapter_clear'
}

Removes all buffers from adapter.

GstBase.Adapter.prototype.copy_bytes

function GstBase.Adapter.prototype.copy_bytes(offset: Number, size: Number): {
    // javascript wrapper for 'gst_adapter_copy_bytes'
}

Similar to gst_adapter_copy, but more suitable for language bindings. size bytes of data starting at offset will be copied out of the buffers contained in adapter and into a new GBytes (not introspectable) structure which is returned. Depending on the value of the size argument an empty GBytes (not introspectable) structure may be returned.

Since : 1.4

GstBase.Adapter.prototype.distance_from_discont

function GstBase.Adapter.prototype.distance_from_discont(): {
    // javascript wrapper for 'gst_adapter_distance_from_discont'
}

Get the distance in bytes since the last buffer with the Gst.BufferFlags.DISCONT flag.

The distance will be reset to 0 for all buffers with Gst.BufferFlags.DISCONT on them, and then calculated for all other following buffers based on their size.

Since : 1.10

GstBase.Adapter.prototype.dts_at_discont

function GstBase.Adapter.prototype.dts_at_discont(): {
    // javascript wrapper for 'gst_adapter_dts_at_discont'
}

Get the DTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_CLOCK_TIME_NONE.

Since : 1.10

GstBase.Adapter.prototype.flush

function GstBase.Adapter.prototype.flush(flush: Number): {
    // javascript wrapper for 'gst_adapter_flush'
}

Flushes the first flush bytes in the adapter. The caller must ensure that at least this many bytes are available.

See also: GstBase.Adapter.prototype.map, GstBase.Adapter.prototype.unmap

GstBase.Adapter.prototype.get_buffer

function GstBase.Adapter.prototype.get_buffer(nbytes: Number): {
    // javascript wrapper for 'gst_adapter_get_buffer'
}

Returns a Gst.Buffer containing the first nbytes of the adapter, but does not flush them from the adapter. See GstBase.Adapter.prototype.take_buffer for details.

Caller owns a reference to the returned buffer. gst_buffer_unref (not introspectable) after usage.

Free-function: gst_buffer_unref

Since : 1.6

GstBase.Adapter.prototype.get_buffer_fast

function GstBase.Adapter.prototype.get_buffer_fast(nbytes: Number): {
    // javascript wrapper for 'gst_adapter_get_buffer_fast'
}

Returns a Gst.Buffer containing the first nbytes of the adapter, but does not flush them from the adapter. See GstBase.Adapter.prototype.take_buffer_fast for details.

Caller owns a reference to the returned buffer. gst_buffer_unref (not introspectable) after usage.

Free-function: gst_buffer_unref

Since : 1.6

GstBase.Adapter.prototype.get_buffer_list

function GstBase.Adapter.prototype.get_buffer_list(nbytes: Number): {
    // javascript wrapper for 'gst_adapter_get_buffer_list'
}

Returns a Gst.BufferList of buffers containing the first nbytes bytes of the adapter but does not flush them from the adapter. See GstBase.Adapter.prototype.take_buffer_list for details.

Caller owns the returned list. Call gst_buffer_list_unref (not introspectable) to free the list after usage.

Since : 1.6

GstBase.Adapter.prototype.get_list

function GstBase.Adapter.prototype.get_list(nbytes: Number): {
    // javascript wrapper for 'gst_adapter_get_list'
}

Returns a GLib.List of buffers containing the first nbytes bytes of the adapter, but does not flush them from the adapter. See GstBase.Adapter.prototype.take_list for details.

Caller owns returned list and contained buffers. gst_buffer_unref (not introspectable) each buffer in the list before freeing the list after usage.

Since : 1.6

GstBase.Adapter.prototype.map

function GstBase.Adapter.prototype.map(): {
    // javascript wrapper for 'gst_adapter_map'
}

Gets the first size bytes stored in the adapter. The returned pointer is valid until the next function is called on the adapter.

Note that setting the returned pointer as the data of a Gst.Buffer is incorrect for general-purpose plugins. The reason is that if a downstream element stores the buffer so that it has access to it outside of the bounds of its chain function, the buffer will have an invalid data pointer after your element flushes the bytes. In that case you should use GstBase.Adapter.prototype.take, which returns a freshly-allocated buffer that you can set as Gst.Buffer memory or the potentially more performant GstBase.Adapter.prototype.take_buffer.

Returns null if size bytes are not available.

GstBase.Adapter.prototype.masked_scan_uint32

function GstBase.Adapter.prototype.masked_scan_uint32(mask: Number, pattern: Number, offset: Number, size: Number): {
    // javascript wrapper for 'gst_adapter_masked_scan_uint32'
}

Scan for pattern pattern with applied mask mask in the adapter data, starting from offset offset.

The bytes in pattern and mask are interpreted left-to-right, regardless of endianness. All four bytes of the pattern must be present in the adapter for it to match, even if the first or last bytes are masked out.

It is an error to call this function without making sure that there is enough data (offset+size bytes) in the adapter.

This function calls GstBase.Adapter.prototype.masked_scan_uint32_peek passing null for value.

 // Assume the adapter contains 0x00 0x01 0x02 ... 0xfe 0xff

 gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 0, 256);
 // -> returns 0
 gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 1, 255);
 // -> returns -1
 gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x01020304, 1, 255);
 // -> returns 1
 gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0001, 0, 256);
 // -> returns -1
 gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0203, 0, 256);
 // -> returns 0
 gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 256);
 // -> returns 2
 gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
 // -> returns -1

GstBase.Adapter.prototype.masked_scan_uint32_peek

function GstBase.Adapter.prototype.masked_scan_uint32_peek(mask: Number, pattern: Number, offset: Number, size: Number): {
    // javascript wrapper for 'gst_adapter_masked_scan_uint32_peek'
}

Scan for pattern pattern with applied mask mask in the adapter data, starting from offset offset. If a match is found, the value that matched is returned through value, otherwise value is left untouched.

The bytes in pattern and mask are interpreted left-to-right, regardless of endianness. All four bytes of the pattern must be present in the adapter for it to match, even if the first or last bytes are masked out.

It is an error to call this function without making sure that there is enough data (offset+size bytes) in the adapter.

GstBase.Adapter.prototype.offset_at_discont

function GstBase.Adapter.prototype.offset_at_discont(): {
    // javascript wrapper for 'gst_adapter_offset_at_discont'
}

Get the offset that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_BUFFER_OFFSET_NONE.

Since : 1.10

GstBase.Adapter.prototype.prev_dts

function GstBase.Adapter.prototype.prev_dts(): {
    // javascript wrapper for 'gst_adapter_prev_dts'
}

Get the dts that was before the current byte in the adapter. When distance is given, the amount of bytes between the dts and the current position is returned.

The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with a dts is added to the adapter, the dts and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.

GstBase.Adapter.prototype.prev_dts_at_offset

function GstBase.Adapter.prototype.prev_dts_at_offset(offset: Number): {
    // javascript wrapper for 'gst_adapter_prev_dts_at_offset'
}

Get the dts that was before the byte at offset offset in the adapter. When distance is given, the amount of bytes between the dts and the current position is returned.

The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with a dts is added to the adapter, the dts and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.

Since : 1.2

GstBase.Adapter.prototype.prev_offset

function GstBase.Adapter.prototype.prev_offset(): {
    // javascript wrapper for 'gst_adapter_prev_offset'
}

Get the offset that was before the current byte in the adapter. When distance is given, the amount of bytes between the offset and the current position is returned.

The offset is reset to GST_BUFFER_OFFSET_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with an offset is added to the adapter, the offset and distance returned are GST_BUFFER_OFFSET_NONE and 0 respectively.

Since : 1.10

GstBase.Adapter.prototype.prev_pts

function GstBase.Adapter.prototype.prev_pts(): {
    // javascript wrapper for 'gst_adapter_prev_pts'
}

Get the pts that was before the current byte in the adapter. When distance is given, the amount of bytes between the pts and the current position is returned.

The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with a pts is added to the adapter, the pts and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.

GstBase.Adapter.prototype.prev_pts_at_offset

function GstBase.Adapter.prototype.prev_pts_at_offset(offset: Number): {
    // javascript wrapper for 'gst_adapter_prev_pts_at_offset'
}

Get the pts that was before the byte at offset offset in the adapter. When distance is given, the amount of bytes between the pts and the current position is returned.

The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with a pts is added to the adapter, the pts and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.

Since : 1.2

GstBase.Adapter.prototype.pts_at_discont

function GstBase.Adapter.prototype.pts_at_discont(): {
    // javascript wrapper for 'gst_adapter_pts_at_discont'
}

Get the PTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_CLOCK_TIME_NONE.

Since : 1.10

GstBase.Adapter.prototype.push

function GstBase.Adapter.prototype.push(buf: Gst.Buffer): {
    // javascript wrapper for 'gst_adapter_push'
}

Adds the data from buf to the data stored inside adapter and takes ownership of the buffer.

GstBase.Adapter.prototype.take

function GstBase.Adapter.prototype.take(): {
    // javascript wrapper for 'gst_adapter_take'
}

Returns a freshly allocated buffer containing the first nbytes bytes of the adapter. The returned bytes will be flushed from the adapter.

Caller owns returned value. g_free after usage.

Free-function: g_free

GstBase.Adapter.prototype.take_buffer

function GstBase.Adapter.prototype.take_buffer(nbytes: Number): {
    // javascript wrapper for 'gst_adapter_take_buffer'
}

Returns a Gst.Buffer containing the first nbytes bytes of the adapter. The returned bytes will be flushed from the adapter. This function is potentially more performant than GstBase.Adapter.prototype.take since it can reuse the memory in pushed buffers by subbuffering or merging. This function will always return a buffer with a single memory region.

Note that no assumptions should be made as to whether certain buffer flags such as the DISCONT flag are set on the returned buffer, or not. The caller needs to explicitly set or unset flags that should be set or unset.

Since 1.6 this will also copy over all GstMeta of the input buffers except for meta with the Gst.MetaFlags.POOLED flag or with the "memory" tag.

Caller owns a reference to the returned buffer. gst_buffer_unref (not introspectable) after usage.

Free-function: gst_buffer_unref

GstBase.Adapter.prototype.take_buffer_fast

function GstBase.Adapter.prototype.take_buffer_fast(nbytes: Number): {
    // javascript wrapper for 'gst_adapter_take_buffer_fast'
}

Returns a Gst.Buffer containing the first nbytes of the adapter. The returned bytes will be flushed from the adapter. This function is potentially more performant than GstBase.Adapter.prototype.take_buffer since it can reuse the memory in pushed buffers by subbuffering or merging. Unlike GstBase.Adapter.prototype.take_buffer, the returned buffer may be composed of multiple non-contiguous Gst.Memory objects, no copies are made.

Note that no assumptions should be made as to whether certain buffer flags such as the DISCONT flag are set on the returned buffer, or not. The caller needs to explicitly set or unset flags that should be set or unset.

This will also copy over all GstMeta of the input buffers except for meta with the Gst.MetaFlags.POOLED flag or with the "memory" tag.

This function can return buffer up to the return value of GstBase.Adapter.prototype.available without making copies if possible.

Caller owns a reference to the returned buffer. gst_buffer_unref (not introspectable) after usage.

Free-function: gst_buffer_unref

Since : 1.2

GstBase.Adapter.prototype.take_buffer_list

function GstBase.Adapter.prototype.take_buffer_list(nbytes: Number): {
    // javascript wrapper for 'gst_adapter_take_buffer_list'
}

Returns a Gst.BufferList of buffers containing the first nbytes bytes of the adapter. The returned bytes will be flushed from the adapter. When the caller can deal with individual buffers, this function is more performant because no memory should be copied.

Caller owns the returned list. Call gst_buffer_list_unref (not introspectable) to free the list after usage.

Since : 1.6

GstBase.Adapter.prototype.take_list

function GstBase.Adapter.prototype.take_list(nbytes: Number): {
    // javascript wrapper for 'gst_adapter_take_list'
}

Returns a GLib.List of buffers containing the first nbytes bytes of the adapter. The returned bytes will be flushed from the adapter. When the caller can deal with individual buffers, this function is more performant because no memory should be copied.

Caller owns returned list and contained buffers. gst_buffer_unref (not introspectable) each buffer in the list before freeing the list after usage.

GstBase.Adapter.prototype.unmap

function GstBase.Adapter.prototype.unmap(): {
    // javascript wrapper for 'gst_adapter_unmap'
}

Releases the memory obtained with the last GstBase.Adapter.prototype.map.