Class (GI Class)

GstBase-1.0 ▶ GstBase ▶ Adapter

This class is for elements that receive buffers in an undesired size. While for example raw video contains one image per buffer, the same is not true for a lot of other formats, especially those that come directly from a file. So if you have undefined buffer sizes and require a specific size, this object is for you.

An adapter is created with gst_adapter_new(). It can be freed again with g_object_unref().

The theory of operation is like this: All buffers received are put into the adapter using gst_adapter_push() and the data is then read back in chunks of the desired size using gst_adapter_map()/gst_adapter_unmap() and/or gst_adapter_copy(). After the data has been processed, it is freed using gst_adapter_unmap().

Other methods such as gst_adapter_take() and gst_adapter_take_buffer() combine gst_adapter_map() and gst_adapter_unmap() in one method and are potentially more convenient for some use cases.

For example, a sink pad's chain function that needs to pass data to a library in 512-byte chunks could be implemented like this:

static GstFlowReturn
sink_pad_chain (GstPad *pad, GstObject *parent, GstBuffer *buffer)
{
  MyElement *this;
  GstAdapter *adapter;
  GstFlowReturn ret = GST_FLOW_OK;

  this = MY_ELEMENT (parent);

  adapter = this->adapter;

  // put buffer into adapter
  gst_adapter_push (adapter, buffer);

  // while we can read out 512 bytes, process them
  while (gst_adapter_available (adapter) >= 512 && ret == GST_FLOW_OK) {
    const guint8 *data = gst_adapter_map (adapter, 512);
    // use flowreturn as an error value
    ret = my_library_foo (data);
    gst_adapter_unmap (adapter);
    gst_adapter_flush (adapter, 512);
  }
  return ret;
}

For another example, a simple element inside GStreamer that uses GstBase.Adapter is the libvisual element.

An element using GstBase.Adapter in its sink pad chain function should ensure that when the FLUSH_STOP event is received, that any queued data is cleared using gst_adapter_clear(). Data should also be cleared or processed on EOS and when changing state from Gst.State.PAUSED to Gst.State.READY.

Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might need to clear the adapter after a discontinuity.

The adapter will keep track of the timestamps of the buffers that were pushed. The last seen timestamp before the current position can be queried with gst_adapter_prev_pts(). This function can optionally return the number of bytes between the start of the buffer that carried the timestamp and the current adapter position. The distance is useful when dealing with, for example, raw audio samples because it allows you to calculate the timestamp of the current adapter position by using the last seen timestamp and the amount of bytes since. Additionally, the gst_adapter_prev_pts_at_offset() can be used to determine the last seen timestamp at a particular offset in the adapter.

The adapter will also keep track of the offset of the buffers (#GST_BUFFER_OFFSET) that were pushed. The last seen offset before the current position can be queried with gst_adapter_prev_offset(). This function can optionally return the number of bytes between the start of the buffer that carried the offset and the current adapter position.

Additionally the adapter also keeps track of the PTS, DTS and buffer offset at the last discontinuity, which can be retrieved with gst_adapter_pts_at_discont(), gst_adapter_dts_at_discont() and gst_adapter_offset_at_discont(). The number of bytes that were consumed since then can be queried with gst_adapter_distance_from_discont().

A last thing to note is that while GstBase.Adapter is pretty optimized, merging buffers still might be an operation that requires a malloc() and memcpy() operation, and these operations are not the fastest. Because of this, some functions like gst_adapter_available_fast() are provided to help speed up such cases should you want to. To avoid repeated memory allocations, gst_adapter_copy() can be used to copy data into a (statically allocated) user provided buffer.

GstBase.Adapter is not MT safe. All operations on an adapter must be serialized by the caller. This is not normally a problem, however, as the normal use case of GstBase.Adapter is inside one pad's chain function, in which case access is serialized via the pad's STREAM_LOCK.

Note that gst_adapter_push() takes ownership of the buffer passed. Use gst_buffer_ref() before pushing it into the adapter if you still want to access the buffer later. The adapter will never modify the data in the buffer pushed in it.

Hierarchy (View Summary)

GObject.Object
- Adapter

Index

Constructors

constructor

Properties

$signals $gtype

Constructors

constructor

new Adapter(
properties?: Partial<GstBase.Adapter.ConstructorProps>,
...args: any[],
): GstBase.Adapter
Parameters
- Optionalproperties: Partial<GstBase.Adapter.ConstructorProps>
- ...args: any[]
Returns GstBase.Adapter
Overrides Object.constructor
- Defined in gstbase-1.0/gstbase-1.0.d.ts:585

Properties

`Internal`$signals

$signals: GstBase.Adapter.SignalSignatures

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

`Static`$gtype

$gtype: GType<GstBase.Adapter>

Methods

_init

_init(...args: any[]): void
Parameters
- ...args: any[]
Returns void
Overrides Object._init
- Defined in gstbase-1.0/gstbase-1.0.d.ts:587

available

available(): number
Gets the maximum amount of bytes available, that is it returns the maximum value that can be supplied to gst_adapter_map() without that function returning null.

Calling gst_adapter_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.

Returns number
number of bytes available in adapter
- Defined in gstbase-1.0/gstbase-1.0.d.ts:624

available_fast

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

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

Returns number
number of bytes that are available in adapter without expensive operations
- Defined in gstbase-1.0/gstbase-1.0.d.ts:634

clear

clear(): void
Removes all buffers from adapter.

Returns void
- Defined in gstbase-1.0/gstbase-1.0.d.ts:638

`Signal`connect

connect<K extends "notify">(
    signal: K,
    callback: SignalCallback<
        GstBase.Adapter,
        GstBase.Adapter.SignalSignatures[K],
    >,
): number
Type Parameters
- K extends "notify"
Parameters
- signal: K
- callback: SignalCallback<GstBase.Adapter, GstBase.Adapter.SignalSignatures[K]>
Returns number
Overrides Object.connect
- Defined in gstbase-1.0/gstbase-1.0.d.ts:594
connect(signal: string, callback: (...args: any[]) => any): number
Parameters
- signal: string
- callback: (...args: any[]) => any
Returns number
Overrides Object.connect
- Defined in gstbase-1.0/gstbase-1.0.d.ts:598

`Signal`connect_after

connect_after<K extends "notify">(
    signal: K,
    callback: SignalCallback<
        GstBase.Adapter,
        GstBase.Adapter.SignalSignatures[K],
    >,
): number
Type Parameters
- K extends "notify"
Parameters
- signal: K
- callback: SignalCallback<GstBase.Adapter, GstBase.Adapter.SignalSignatures[K]>
Returns number
Overrides Object.connect_after
- Defined in gstbase-1.0/gstbase-1.0.d.ts:600
connect_after(signal: string, callback: (...args: any[]) => any): number
Parameters
- signal: string
- callback: (...args: any[]) => any
Returns number
Overrides Object.connect_after
- Defined in gstbase-1.0/gstbase-1.0.d.ts:604

copy

copy(offset: number, size: number): GLib.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 GLib.Bytes structure which is returned. Depending on the value of the size argument an empty GLib.Bytes structure may be returned.
Parameters
- offset: number
  the bytes offset in the adapter to start from
- size: number
  the number of bytes to copy
Returns GLib.Bytes
A new GLib.Bytes structure containing the copied data.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:648

distance_from_discont

distance_from_discont(): number
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.

Returns number
The offset. Can be GST_BUFFER_OFFSET_NONE.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:658

dts_at_discont

dts_at_discont(): number
Get the DTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_CLOCK_TIME_NONE.

Returns number
The DTS at the last discont or GST_CLOCK_TIME_NONE.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:664

`Signal`emit

emit<K extends "notify">(
    signal: K,
    ...args: GjsParameters<GstBase.Adapter.SignalSignatures[K]> extends [
        any,
        ...Q[],
    ]
        ? Q
        : never,
): void
Type Parameters
- K extends "notify"
Parameters
- signal: K
- ...args: GjsParameters<GstBase.Adapter.SignalSignatures[K]> extends [any, ...Q[]]
  ? Q
  : never
Returns void
Overrides Object.emit
- Defined in gstbase-1.0/gstbase-1.0.d.ts:606
emit(signal: string, ...args: any[]): void
Parameters
- signal: string
- ...args: any[]
Returns void
Overrides Object.emit
- Defined in gstbase-1.0/gstbase-1.0.d.ts:610

flush

flush(flush: number): void
Flushes the first flush bytes in the adapter. The caller must ensure that at least this many bytes are available.

See also: gst_adapter_map(), gst_adapter_unmap()
Parameters
- flush: number
  the number of bytes to flush
Returns void
- Defined in gstbase-1.0/gstbase-1.0.d.ts:672

get_buffer

get_buffer(nbytes: number): Gst.Buffer
Returns a Gst.Buffer containing the first nbytes of the adapter, but does not flush them from the adapter. See gst_adapter_take_buffer() for details.

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

Free-function: gst_buffer_unref
Parameters
- nbytes: number
  the number of bytes to get
Returns Gst.Buffer
a Gst.Buffer containing the first nbytes of the adapter, or null if nbytes bytes are not available. gst_buffer_unref() when no longer needed.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:685

get_buffer_fast

get_buffer_fast(nbytes: number): Gst.Buffer
Returns a Gst.Buffer containing the first nbytes of the adapter, but does not flush them from the adapter. See gst_adapter_take_buffer_fast() for details.

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

Free-function: gst_buffer_unref
Parameters
- nbytes: number
  the number of bytes to get
Returns Gst.Buffer
a Gst.Buffer containing the first nbytes of the adapter, or null if nbytes bytes are not available. gst_buffer_unref() when no longer needed.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:698

get_buffer_list

get_buffer_list(nbytes: number): BufferList
Returns a Gst.BufferList of buffers containing the first nbytes bytes of the adapter but does not flush them from the adapter. See gst_adapter_take_buffer_list() for details.

Caller owns the returned list. Call gst_buffer_list_unref() to free the list after usage.
Parameters
- nbytes: number
  the number of bytes to get
Returns BufferList
a Gst.BufferList of buffers containing the first nbytes of the adapter, or null if nbytes bytes are not available
- Defined in gstbase-1.0/gstbase-1.0.d.ts:709

get_list

get_list(nbytes: number): Gst.Buffer[]
Returns a GLib.List of buffers containing the first nbytes bytes of the adapter, but does not flush them from the adapter. See gst_adapter_take_list() for details.

Caller owns returned list and contained buffers. gst_buffer_unref() each buffer in the list before freeing the list after usage.
Parameters
- nbytes: number
  the number of bytes to get
Returns Gst.Buffer[]
a GLib.List of buffers containing the first nbytes of the adapter, or null if nbytes bytes are not available
- Defined in gstbase-1.0/gstbase-1.0.d.ts:720

map

map(): Uint8Array<ArrayBufferLike>
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 gst_adapter_take(), which returns a freshly-allocated buffer that you can set as Gst.Buffer memory or the potentially more performant gst_adapter_take_buffer().

Returns null if size bytes are not available.

Returns Uint8Array<ArrayBufferLike>
a pointer to the first size bytes of data, or null
- Defined in gstbase-1.0/gstbase-1.0.d.ts:737

masked_scan_uint32

masked_scan_uint32(
    mask: number,
    pattern: number,
    offset: number,
    size: number,
): number
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 gst_adapter_masked_scan_uint32_peek() passing null for value.
Parameters
- mask: number
  mask to apply to data before matching against pattern
- pattern: number
  pattern to match (after mask is applied)
- offset: number
  offset into the adapter data from which to start scanning, returns the last scanned position.
- size: number
  number of bytes to scan from offset
Returns number
offset of the first match, or -1 if no match was found. Example: |[ // 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 ]|
- Defined in gstbase-1.0/gstbase-1.0.d.ts:757

masked_scan_uint32_peek

masked_scan_uint32_peek(
    mask: number,
    pattern: number,
    offset: number,
    size: number,
): [number, number]
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.
Parameters
- mask: number
  mask to apply to data before matching against pattern
- pattern: number
  pattern to match (after mask is applied)
- offset: number
  offset into the adapter data from which to start scanning, returns the last scanned position.
- size: number
  number of bytes to scan from offset
Returns [number, number]
offset of the first match, or -1 if no match was found.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:775

offset_at_discont

offset_at_discont(): number
Get the offset that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_BUFFER_OFFSET_NONE.

Returns number
The offset at the last discont or GST_BUFFER_OFFSET_NONE.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:781

prev_dts

prev_dts(): [number, number]
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.

Returns [number, number]
The previously seen dts.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:793

prev_dts_at_offset

prev_dts_at_offset(offset: number): [number, number]
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.
Parameters
- offset: number
  the offset in the adapter at which to get timestamp
Returns [number, number]
The previously seen dts at given offset.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:806

prev_offset

prev_offset(): [number, number]
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.

Returns [number, number]
The previous seen offset.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:818

prev_pts

prev_pts(): [number, number]
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.

Returns [number, number]
The previously seen pts.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:830

prev_pts_at_offset

prev_pts_at_offset(offset: number): [number, number]
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.
Parameters
- offset: number
  the offset in the adapter at which to get timestamp
Returns [number, number]
The previously seen pts at given offset.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:843

pts_at_discont

pts_at_discont(): number
Get the PTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_CLOCK_TIME_NONE.

Returns number
The PTS at the last discont or GST_CLOCK_TIME_NONE.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:849

push

push(buf: Gst.Buffer): void
Adds the data from buf to the data stored inside adapter and takes ownership of the buffer.
Parameters
- buf: Gst.Buffer
  a Gst.Buffer to add to queue in the adapter
Returns void
- Defined in gstbase-1.0/gstbase-1.0.d.ts:855

take

take(): Uint8Array<ArrayBufferLike>
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

Returns Uint8Array<ArrayBufferLike>
oven-fresh hot data, or null if nbytes bytes are not available
- Defined in gstbase-1.0/gstbase-1.0.d.ts:865

take_buffer

take_buffer(nbytes: number): Gst.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 gst_adapter_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() after usage.

Free-function: gst_buffer_unref
Parameters
- nbytes: number
  the number of bytes to take
Returns Gst.Buffer
a Gst.Buffer containing the first nbytes of the adapter, or null if nbytes bytes are not available. gst_buffer_unref() when no longer needed.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:889

take_buffer_fast

take_buffer_fast(nbytes: number): Gst.Buffer
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 gst_adapter_take_buffer() since it can reuse the memory in pushed buffers by subbuffering or merging. Unlike gst_adapter_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 gst_adapter_available() without making copies if possible.

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

Free-function: gst_buffer_unref
Parameters
- nbytes: number
  the number of bytes to take
Returns Gst.Buffer
a Gst.Buffer containing the first nbytes of the adapter, or null if nbytes bytes are not available. gst_buffer_unref() when no longer needed.
- Defined in gstbase-1.0/gstbase-1.0.d.ts:917

take_buffer_list

take_buffer_list(nbytes: number): BufferList
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() to free the list after usage.
Parameters
- nbytes: number
  the number of bytes to take
Returns BufferList
a Gst.BufferList of buffers containing the first nbytes of the adapter, or null if nbytes bytes are not available
- Defined in gstbase-1.0/gstbase-1.0.d.ts:929

take_list

take_list(nbytes: number): Gst.Buffer[]
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() each buffer in the list before freeing the list after usage.
Parameters
- nbytes: number
  the number of bytes to take
Returns Gst.Buffer[]
a GLib.List of buffers containing the first nbytes of the adapter, or null if nbytes bytes are not available
- Defined in gstbase-1.0/gstbase-1.0.d.ts:941

unmap

unmap(): void
Releases the memory obtained with the last gst_adapter_map().

Returns void
- Defined in gstbase-1.0/gstbase-1.0.d.ts:945

`Static`new

new(): GstBase.Adapter
Returns GstBase.Adapter
- Defined in gstbase-1.0/gstbase-1.0.d.ts:589

Methods - Inherited from GObject

bind_property

bind_property(
    source_property: string,
    target: GObject.Object,
    target_property: string,
    flags: GObject.BindingFlags,
): GObject.Binding
Creates a binding between source_property on source and target_property on target.

Whenever the source_property is changed the target_property is updated using the same value. For instance:
```
  g_object_bind_property (action, "active", widget, "sensitive", 0);
```
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

A GObject.Object can have multiple bindings.
Parameters
- source_property: string
  the property on source to bind
- target: GObject.Object
  the target GObject.Object
- target_property: string
  the property on target to bind
- flags: GObject.BindingFlags
  flags to pass to GObject.Binding
Returns GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Inherited from Object.bind_property
- Defined in gobject-2.0/gobject-2.0.d.ts:4078

bind_property_full

bind_property_full(
    source_property: string,
    target: GObject.Object,
    target_property: string,
    flags: GObject.BindingFlags,
    transform_to?: BindingTransformFunc,
    transform_from?: BindingTransformFunc,
    notify?: DestroyNotify,
): GObject.Binding
Complete version of g_object_bind_property().

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

To remove the binding, call g_binding_unbind().

A GObject.Object can have multiple bindings.

The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.
Parameters
- source_property: string
  the property on source to bind
- target: GObject.Object
  the target GObject.Object
- target_property: string
  the property on target to bind
- flags: GObject.BindingFlags
  flags to pass to GObject.Binding
- Optionaltransform_to: BindingTransformFunc
  the transformation function from the source to the target, or null to use the default
- Optionaltransform_from: BindingTransformFunc
  the transformation function from the target to the source, or null to use the default
- Optionalnotify: DestroyNotify
  a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
Returns GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Inherited from Object.bind_property_full
- Defined in gobject-2.0/gobject-2.0.d.ts:4119
bind_property_full(
    source_property: string,
    target: GObject.Object,
    target_property: string,
    flags: GObject.BindingFlags,
    transform_to: Closure<any, any>,
    transform_from: Closure<any, any>,
): GObject.Binding
Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.
Parameters
- source_property: string
  the property on source to bind
- target: GObject.Object
  the target GObject.Object
- target_property: string
  the property on target to bind
- flags: GObject.BindingFlags
  flags to pass to GObject.Binding
- transform_to: Closure<any, any>
  a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
- transform_from: Closure<any, any>
  a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
Returns GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Inherited from Object.bind_property_full
- Defined in gobject-2.0/gobject-2.0.d.ts:4144

block_signal_handler

block_signal_handler(id: number): void
Blocks a handler of an instance so it will not be called during any signal emissions
Parameters
- id: number
  Handler ID of the handler to be blocked
Returns void
Inherited from Object.block_signal_handler
- Defined in gobject-2.0/gobject-2.0.d.ts:4423

disconnect

disconnect(id: number): void
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Parameters
- id: number
  Handler ID of the handler to be disconnected
Returns void
Inherited from Object.disconnect
- Defined in gobject-2.0/gobject-2.0.d.ts:4413

force_floating

force_floating(): void
This function is intended for GObject.Object implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

Returns void
Inherited from Object.force_floating
- Defined in gobject-2.0/gobject-2.0.d.ts:4158

freeze_notify

freeze_notify(): void
Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

Returns void
Inherited from Object.freeze_notify
- Defined in gobject-2.0/gobject-2.0.d.ts:4170

get_data

get_data(key: string): any
Gets a named field from the objects table of associations (see g_object_set_data()).
Parameters
- key: string
  name of the key for that association
Returns any
the data if found, or null if no such data exists.
Inherited from Object.get_data
- Defined in gobject-2.0/gobject-2.0.d.ts:4176

get_property

get_property(property_name: string, value: any): any
Gets a property of an object.

The value can be:
- an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
- a GObject.Value initialized with the expected type of the property
- a GObject.Value initialized with a type to which the expected type of the property can be transformed
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
Parameters
- property_name: string
  The name of the property to get
- value: any
  Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
Returns any
Inherited from Object.get_property
- Defined in gobject-2.0/gobject-2.0.d.ts:4191

get_qdata

get_qdata(quark: number): any
This function gets back user data pointers stored via g_object_set_qdata().
Parameters
- quark: number
  A GLib.Quark, naming the user data pointer
Returns any
The user data pointer set, or null
Inherited from Object.get_qdata
- Defined in gobject-2.0/gobject-2.0.d.ts:4198

getv

getv(names: string[], values: any[]): void
Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
Parameters
- names: string[]
  the names of each property to get
- values: any[]
  the values of each property to get
Returns void
Inherited from Object.getv
- Defined in gobject-2.0/gobject-2.0.d.ts:4207

is_floating

is_floating(): boolean
Checks whether object has a [floating][floating-ref] reference.

Returns boolean
true if object has a floating reference
Inherited from Object.is_floating
- Defined in gobject-2.0/gobject-2.0.d.ts:4212

notify

notify(property_name: string): void
Emits a "notify" signal for the property property_name on object.

When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
Parameters
- property_name: string
  the name of a property installed on the class of object.
Returns void
Inherited from Object.notify
- Defined in gobject-2.0/gobject-2.0.d.ts:4226

notify_by_pspec

notify_by_pspec(pspec: GObject.ParamSpec): void

Emits a "notify" signal for the property specified by pspec on object.

This function omits the property name lookup, hence it is faster than g_object_notify().

One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

  typedef enum
  {
    PROP_FOO = 1,
    PROP_LAST
  } MyObjectProperty;

  static GParamSpec *properties[PROP_LAST];

  static void
  my_object_class_init (MyObjectClass *klass)
  {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
                                             0, 100,
                                             50,
                                             G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    g_object_class_install_property (gobject_class,
                                     PROP_FOO,
                                     properties[PROP_FOO]);
  }

and then notify a change on the "foo" property with:

  g_object_notify_by_pspec (self, properties[PROP_FOO]);

Parameters

pspec: GObject.ParamSpec
the GObject.ParamSpec of a property installed on the class of object.

Returns void

ref

ref(): GObject.Object
Increases the reference count of object.

Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

Returns GObject.Object
the same object
Inherited from Object.ref
- Defined in gobject-2.0/gobject-2.0.d.ts:4281

ref_sink

ref_sink(): GObject.Object
Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

Returns GObject.Object
object
Inherited from Object.ref_sink
- Defined in gobject-2.0/gobject-2.0.d.ts:4296

run_dispose

run_dispose(): void
Releases all references to other objects. This can be used to break reference cycles.

This function should only be called from object system implementations.

Returns void
Inherited from Object.run_dispose
- Defined in gobject-2.0/gobject-2.0.d.ts:4303

set

set(properties: { [key: string]: any }): void
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Parameters
- properties: { [key: string]: any }
  Object containing the properties to set
Returns void
Inherited from Object.set
- Defined in gobject-2.0/gobject-2.0.d.ts:4418

set_data

set_data(key: string, data?: any): void
Each object carries around a table of associations from strings to pointers. This function lets you set an association.

If the object already had an association with that name, the old association will be destroyed.

Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.
Parameters
- key: string
  name of the key
- Optionaldata: any
  data to associate with that key
Returns void
Inherited from Object.set_data
- Defined in gobject-2.0/gobject-2.0.d.ts:4318

set_property

set_property(property_name: string, value: any): void
Sets a property on an object.
Parameters
- property_name: string
  The name of the property to set
- value: any
  The value to set the property to
Returns void
Inherited from Object.set_property
- Defined in gobject-2.0/gobject-2.0.d.ts:4324

steal_data

steal_data(key: string): any
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
Parameters
- key: string
  name of the key
Returns any
the data if found, or null if no such data exists.
Inherited from Object.steal_data
- Defined in gobject-2.0/gobject-2.0.d.ts:4331

steal_qdata

steal_qdata(quark: number): any

This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

void
object_add_to_user_list (GObject     *object,
                         const gchar *new_string)
{
  // the quark, naming the object data
  GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
  // retrieve the old string list
  GList *list = g_object_steal_qdata (object, quark_string_list);

  // prepend new string
  list = g_list_prepend (list, g_strdup (new_string));
  // this changed 'list', so we need to set it again
  g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
  GList *node, *list = data;

  for (node = list; node; node = node->next)
    g_free (node->data);
  g_list_free (list);
}

Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

Parameters

quark: number
A GLib.Quark, naming the user data pointer

Returns any

The user data pointer set, or null

stop_emission_by_name

stop_emission_by_name(detailedName: string): void
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Parameters
- detailedName: string
  Name of the signal to stop emission of
Returns void
Inherited from Object.stop_emission_by_name
- Defined in gobject-2.0/gobject-2.0.d.ts:4433

thaw_notify

thaw_notify(): void
Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

It is an error to call this function when the freeze count is zero.

Returns void
Inherited from Object.thaw_notify
- Defined in gobject-2.0/gobject-2.0.d.ts:4385

unblock_signal_handler

unblock_signal_handler(id: number): void
Unblocks a handler so it will be called again during any signal emissions
Parameters
- id: number
  Handler ID of the handler to be unblocked
Returns void
Inherited from Object.unblock_signal_handler
- Defined in gobject-2.0/gobject-2.0.d.ts:4428

unref

unref(): void
Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

Returns void
Inherited from Object.unref
- Defined in gobject-2.0/gobject-2.0.d.ts:4395

`Virtual`vfunc_constructed

vfunc_constructed(): void
the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

Returns void
Inherited from Object.vfunc_constructed
- Defined in gobject-2.0/gobject-2.0.d.ts:3973

`Virtual`vfunc_dispatch_properties_changed

vfunc_dispatch_properties_changed(
n_pspecs: number,
pspecs: GObject.ParamSpec,
): void
emits property change notification for a bunch of properties. Overriding dispatch_properties_changed should be rarely needed.
Parameters
- n_pspecs: number
- pspecs: GObject.ParamSpec
Returns void
Inherited from Object.vfunc_dispatch_properties_changed
- Defined in gobject-2.0/gobject-2.0.d.ts:3982

`Virtual`vfunc_dispose

vfunc_dispose(): void
the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

Returns void
Inherited from Object.vfunc_dispose
- Defined in gobject-2.0/gobject-2.0.d.ts:3991

`Virtual`vfunc_finalize

vfunc_finalize(): void
instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

Returns void
Inherited from Object.vfunc_finalize
- Defined in gobject-2.0/gobject-2.0.d.ts:3998

`Virtual`vfunc_get_property

vfunc_get_property(
    property_id: number,
    value: any,
    pspec: GObject.ParamSpec,
): void
the generic getter for all properties of this type. Should be overridden for every type with properties.
Parameters
- property_id: number
- value: any
- pspec: GObject.ParamSpec
Returns void
Inherited from Object.vfunc_get_property
- Defined in gobject-2.0/gobject-2.0.d.ts:4007

`Virtual`vfunc_notify

vfunc_notify(pspec: GObject.ParamSpec): void
Emits a "notify" signal for the property property_name on object.

When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
Parameters
- pspec: GObject.ParamSpec
Returns void
Inherited from Object.vfunc_notify
- Defined in gobject-2.0/gobject-2.0.d.ts:4022

`Virtual`vfunc_set_property

vfunc_set_property(
    property_id: number,
    value: any,
    pspec: GObject.ParamSpec,
): void
the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.
Parameters
- property_id: number
- value: any
- pspec: GObject.ParamSpec
Returns void
Inherited from Object.vfunc_set_property
- Defined in gobject-2.0/gobject-2.0.d.ts:4034

watch_closure

watch_closure(closure: Closure): void
This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
Parameters
- closure: Closure
  GObject.Closure to watch
Returns void
Inherited from Object.watch_closure
- Defined in gobject-2.0/gobject-2.0.d.ts:4408

`Static`_classInit

_classInit(klass: any): any
Parameters
- klass: any
Returns any
Inherited from Object._classInit
- Defined in gobject-2.0/gobject-2.0.d.ts:3959

`Static`compat_control

compat_control(what: number, data?: any): number
Parameters
- what: number
- Optionaldata: any
Returns number
Inherited from Object.compat_control
- Defined in gobject-2.0/gobject-2.0.d.ts:3897

`Static`find_property

find_property(property_name: string): GObject.ParamSpec
Parameters
- property_name: string
  the name of the property to look up
Returns GObject.ParamSpec
Inherited from Object.find_property
- Defined in gobject-2.0/gobject-2.0.d.ts:3940

`Static`install_properties

install_properties(pspecs: GObject.ParamSpec<unknown>[]): void
Parameters
- pspecs: GObject.ParamSpec<unknown>[]
  the GParamSpecs array defining the new properties
Returns void
Inherited from Object.install_properties
- Defined in gobject-2.0/gobject-2.0.d.ts:3944

`Static`install_property

install_property(property_id: number, pspec: GObject.ParamSpec): void
Parameters
- property_id: number
  the id for the new property
- pspec: GObject.ParamSpec
  the GObject.ParamSpec for the new property
Returns void
Inherited from Object.install_property
- Defined in gobject-2.0/gobject-2.0.d.ts:3949

`Static`interface_find_property

interface_find_property(
g_iface: TypeInterface,
property_name: string,
): GObject.ParamSpec
Find the GObject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
Parameters
- g_iface: TypeInterface
  any interface vtable for the interface, or the default vtable for the interface
- property_name: string
  name of a property to look up.
Returns GObject.ParamSpec
Inherited from Object.interface_find_property
- Defined in gobject-2.0/gobject-2.0.d.ts:3907

`Static`interface_install_property

interface_install_property(
g_iface: TypeInterface,
pspec: GObject.ParamSpec,
): void
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

If pspec is a floating reference, it will be consumed.
Parameters
- g_iface: TypeInterface
  any interface vtable for the interface, or the default vtable for the interface.
- pspec: GObject.ParamSpec
  the GObject.ParamSpec for the new property
Returns void
Inherited from Object.interface_install_property
- Defined in gobject-2.0/gobject-2.0.d.ts:3928

`Static`interface_list_properties

interface_list_properties(g_iface: TypeInterface): GObject.ParamSpec<unknown>[]
Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
Parameters
- g_iface: TypeInterface
  any interface vtable for the interface, or the default vtable for the interface
Returns GObject.ParamSpec<unknown>[]
Inherited from Object.interface_list_properties
- Defined in gobject-2.0/gobject-2.0.d.ts:3936

`Static`list_properties

list_properties(): GObject.ParamSpec<unknown>[]
Returns GObject.ParamSpec<unknown>[]
Inherited from Object.list_properties
- Defined in gobject-2.0/gobject-2.0.d.ts:3950

`Static`newv

newv(object_type: GType, parameters: Parameter[]): GObject.Object
Parameters
- object_type: GType
- parameters: Parameter[]
Returns GObject.Object
Inherited from Object.newv
- Defined in gobject-2.0/gobject-2.0.d.ts:3868

`Static`override_property

override_property(property_id: number, name: string): void
Parameters
- property_id: number
  the new property ID
- name: string
  the name of a property registered in a parent class or in an interface of this class.
Returns void
Inherited from Object.override_property
- Defined in gobject-2.0/gobject-2.0.d.ts:3955

Interfaces

ConstructorProps
SignalSignatures

GstBase-1.0 ▶ GstBase ▶ Adapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Methods - Inherited from GObject

Constructors

constructor

Parameters

Returns GstBase.Adapter

Properties

Internal$signals

Static$gtype

Methods

_init

Parameters

Returns void

available

Returns number

available_fast

Returns number

clear

Returns void

Signalconnect

Type Parameters

Parameters

Returns number

Parameters

Returns number

Signalconnect_after

Type Parameters

Parameters

Returns number

Parameters

Returns number

copy

Parameters

Returns GLib.Bytes

distance_from_discont

Returns number

dts_at_discont

Returns number

Signalemit

Type Parameters

Parameters

Returns void

Parameters

Returns void

flush

Parameters

Returns void

get_buffer

Parameters

Returns Gst.Buffer

get_buffer_fast

Parameters

Returns Gst.Buffer

get_buffer_list

Parameters

Returns BufferList

get_list

Parameters

Returns Gst.Buffer[]

map

Returns Uint8Array<ArrayBufferLike>

masked_scan_uint32

Parameters

Returns number

masked_scan_uint32_peek

Parameters

Returns [number, number]

offset_at_discont

Returns number

prev_dts

Returns [number, number]

prev_dts_at_offset

Parameters

Returns [number, number]

prev_offset

`Internal`$signals

`Static`$gtype

`Signal`connect

`Signal`connect_after

`Signal`emit

`Static`new