gstanalyticsbatchmeta

## GstAnalyticsBatchBuffer

The intended use of this struct is that analytics elements read the buffer or buffer list and potentially attach new GstMeta with additional information. Only one of buffer or buffer_list is going to be set, or both are NULL.

Elements that need to modify buffer (e.g. to attach a new meta) must first call gst_buffer_make_writable and store the writable buffer in this struct. Similarly, a writable buffer_list must be ensured with gst_buffer_list_make_writable.

Modifying any other fields must be done with special care to ensure that the data flow of the stream is not broken.

It is possible for buffer and buffer_list to be NULL, e.g. if there was no buffer for this batch but there were serialized events like a gap event.

Note that serialized_events always contains all currently active serialized events and not only the changed events compared to the previous buffer.

### Members

`sticky_events` (GstEvent **) –

All sticky GstEvent that relate to this buffer

`n_sticky_events` (gsize) –

Number of sticky events.

`serialized_events` (GstEvent **) –

All non-sticky, serialized GstEvent that arrived after the previous and before this buffer

`n_serialized_events` (gsize) –

Number of serialized events.

`buffer` (GstBuffer *) –

The buffer, if any.

`buffer_list` (GstBufferList *) –

The buffer list, if any.

Since : 1.28

## GstAnalytics.BatchBuffer

The intended use of this struct is that analytics elements read the buffer or buffer list and potentially attach new Gst.Meta with additional information. Only one of buffer or buffer_list is going to be set, or both are null.

Elements that need to modify buffer (e.g. to attach a new meta) must first call gst_buffer_make_writable (not introspectable) and store the writable buffer in this struct. Similarly, a writable buffer_list must be ensured with Gst.BufferList.prototype.make_writable.

Modifying any other fields must be done with special care to ensure that the data flow of the stream is not broken.

It is possible for buffer and buffer_list to be null, e.g. if there was no buffer for this batch but there were serialized events like a gap event.

Note that serialized_events always contains all currently active serialized events and not only the changed events compared to the previous buffer.

### Members

`sticky_events` ([ Gst.Event ]) –

All sticky Gst.Event that relate to this buffer

`n_sticky_events` (Number) –

Number of sticky events.

`serialized_events` ([ Gst.Event ]) –

All non-sticky, serialized Gst.Event that arrived after the previous and before this buffer

`n_serialized_events` (Number) –

Number of serialized events.

`buffer` (Gst.Buffer) –

The buffer, if any.

`buffer_list` (Gst.BufferList) –

The buffer list, if any.

Since : 1.28

## GstAnalytics.BatchBuffer

The intended use of this struct is that analytics elements read the buffer or buffer list and potentially attach new Gst.Meta with additional information. Only one of buffer or buffer_list is going to be set, or both are None.

Elements that need to modify buffer (e.g. to attach a new meta) must first call gst_buffer_make_writable (not introspectable) and store the writable buffer in this struct. Similarly, a writable buffer_list must be ensured with Gst.BufferList.make_writable.

Modifying any other fields must be done with special care to ensure that the data flow of the stream is not broken.

It is possible for buffer and buffer_list to be None, e.g. if there was no buffer for this batch but there were serialized events like a gap event.

Note that serialized_events always contains all currently active serialized events and not only the changed events compared to the previous buffer.

### Members

`sticky_events` ([ Gst.Event ]) –

All sticky Gst.Event that relate to this buffer

`n_sticky_events` (int) –

Number of sticky events.

`serialized_events` ([ Gst.Event ]) –

All non-sticky, serialized Gst.Event that arrived after the previous and before this buffer

`n_serialized_events` (int) –

Number of serialized events.

`buffer` (Gst.Buffer) –

The buffer, if any.

`buffer_list` (Gst.BufferList) –

The buffer list, if any.

Since : 1.28

### Methods

#### gst_analytics_batch_buffer_get_caps

    GstCaps *
    gst_analytics_batch_buffer_get_caps (GstAnalyticsBatchBuffer * buffer)

Gets the GstCaps from a buffer

Parameters:

`buffer` –

A GstAnalyticsBatchBuffer

Returns ( [nullable][transfer: none]) –

The GstCaps if there are any

Since : 1.28

#### GstAnalytics.BatchBuffer.prototype.get_caps

    function GstAnalytics.BatchBuffer.prototype.get_caps(): {
        // javascript wrapper for 'gst_analytics_batch_buffer_get_caps'
    }

Gets the Gst.Caps from a buffer

Parameters:

`buffer` (GstAnalytics.BatchBuffer) –

A GstAnalytics.BatchBuffer

Returns (Gst.Caps) –

The Gst.Caps if there are any

Since : 1.28

#### GstAnalytics.BatchBuffer.get_caps

    def GstAnalytics.BatchBuffer.get_caps (self):
        #python wrapper for 'gst_analytics_batch_buffer_get_caps'

Gets the Gst.Caps from a buffer

Parameters:

`buffer` (GstAnalytics.BatchBuffer) –

A GstAnalytics.BatchBuffer

Returns (Gst.Caps) –

The Gst.Caps if there are any

Since : 1.28

#### gst_analytics_batch_buffer_get_segment

    const GstSegment *
    gst_analytics_batch_buffer_get_segment (GstAnalyticsBatchBuffer * buffer)

Gets the GstSegment from a buffer

Parameters:

`buffer` –

A GstAnalyticsBatchBuffer

Returns ( [nullable][transfer: none]) –

The GstSegment if there is one

Since : 1.28

#### GstAnalytics.BatchBuffer.prototype.get_segment

    function GstAnalytics.BatchBuffer.prototype.get_segment(): {
        // javascript wrapper for 'gst_analytics_batch_buffer_get_segment'
    }

Gets the Gst.Segment from a buffer

Parameters:

`buffer` (GstAnalytics.BatchBuffer) –

A GstAnalytics.BatchBuffer

Returns (Gst.Segment) –

The Gst.Segment if there is one

Since : 1.28

#### GstAnalytics.BatchBuffer.get_segment

    def GstAnalytics.BatchBuffer.get_segment (self):
        #python wrapper for 'gst_analytics_batch_buffer_get_segment'

Gets the Gst.Segment from a buffer

Parameters:

`buffer` (GstAnalytics.BatchBuffer) –

A GstAnalytics.BatchBuffer

Returns (Gst.Segment) –

The Gst.Segment if there is one

Since : 1.28

#### gst_analytics_batch_buffer_get_stream_id

    const gchar *
    gst_analytics_batch_buffer_get_stream_id (GstAnalyticsBatchBuffer * buffer)

Gets the current stream id from a buffer

Parameters:

`buffer` –

A GstAnalyticsBatchBuffer

Returns ( [nullable][transfer: none]) –

The stream id if there is any

Since : 1.28

#### GstAnalytics.BatchBuffer.prototype.get_stream_id

    function GstAnalytics.BatchBuffer.prototype.get_stream_id(): {
        // javascript wrapper for 'gst_analytics_batch_buffer_get_stream_id'
    }

Gets the current stream id from a buffer

Parameters:

`buffer` (GstAnalytics.BatchBuffer) –

A GstAnalytics.BatchBuffer

Returns (String) –

The stream id if there is any

Since : 1.28

#### GstAnalytics.BatchBuffer.get_stream_id

    def GstAnalytics.BatchBuffer.get_stream_id (self):
        #python wrapper for 'gst_analytics_batch_buffer_get_stream_id'

Gets the current stream id from a buffer

Parameters:

`buffer` (GstAnalytics.BatchBuffer) –

A GstAnalytics.BatchBuffer

Returns (str) –

The stream id if there is any

Since : 1.28

## GstAnalyticsBatchMeta

This meta represents a batch of buffers from one or more streams together with the relevant events to be able to interpret the buffers and to be able to reconstruct the original streams.

When used for multiple streams and batching them temporarily, caps of type `multistream/x-analytics-batch(meta:GstAnalyticsBatchMeta)` should be used, with the original caps of each stream in an array-typed `streams` field. The original caps of each stream might be extended by additional fields and the order of the streams in the array corresponds to the order of the streams array of the meta. In this case, empty buffers would be used without any GstMemory and

When used for a single stream, the original caps might be used together with the `meta:GstAnalyticsBatchMeta` caps feature and potentially extended by additional fields to describe the kind of batching and its configuration, e.g. that each batch is made of 25% overlapping 320x320 slices of the original video frame.

The timestamp, duration and other metadata of each batch can be retrieved from the parent buffer of this meta.

### Members

`meta` (GstMeta) –

parent

`streams` (GstAnalyticsBatchStream *) –

GstAnalyticsBatchStream for this batch

`n_streams` (gsize) –

Number of streams

Since : 1.28

## GstAnalytics.BatchMeta

This meta represents a batch of buffers from one or more streams together with the relevant events to be able to interpret the buffers and to be able to reconstruct the original streams.

When used for multiple streams and batching them temporarily, caps of type `multistream/x-analytics-batch(meta:GstAnalyticsBatchMeta)` should be used, with the original caps of each stream in an array-typed `streams` field. The original caps of each stream might be extended by additional fields and the order of the streams in the array corresponds to the order of the streams array of the meta. In this case, empty buffers would be used without any Gst.Memory and

When used for a single stream, the original caps might be used together with the `meta:GstAnalyticsBatchMeta` caps feature and potentially extended by additional fields to describe the kind of batching and its configuration, e.g. that each batch is made of 25% overlapping 320x320 slices of the original video frame.

The timestamp, duration and other metadata of each batch can be retrieved from the parent buffer of this meta.

### Members

`meta` (Gst.Meta) –

parent

`streams` ([ GstAnalytics.BatchStream ]) –

GstAnalytics.BatchStream for this batch

`n_streams` (Number) –

Number of streams

Since : 1.28

## GstAnalytics.BatchMeta

This meta represents a batch of buffers from one or more streams together with the relevant events to be able to interpret the buffers and to be able to reconstruct the original streams.

When used for multiple streams and batching them temporarily, caps of type `multistream/x-analytics-batch(meta:GstAnalyticsBatchMeta)` should be used, with the original caps of each stream in an array-typed `streams` field. The original caps of each stream might be extended by additional fields and the order of the streams in the array corresponds to the order of the streams array of the meta. In this case, empty buffers would be used without any Gst.Memory and

When used for a single stream, the original caps might be used together with the `meta:GstAnalyticsBatchMeta` caps feature and potentially extended by additional fields to describe the kind of batching and its configuration, e.g. that each batch is made of 25% overlapping 320x320 slices of the original video frame.

The timestamp, duration and other metadata of each batch can be retrieved from the parent buffer of this meta.

### Members

`meta` (Gst.Meta) –

parent

`streams` ([ GstAnalytics.BatchStream ]) –

GstAnalytics.BatchStream for this batch

`n_streams` (int) –

Number of streams

Since : 1.28

### Functions

#### gst_analytics_batch_meta_get_info

    const GstMetaInfo *
    gst_analytics_batch_meta_get_info ()

Returns –
No description available

Since : 1.28

## GstAnalyticsBatchStream

### Members

`index` (guint) –

Index of the stream in the meta's stream array

`buffers` (GstAnalyticsBatchBuffer *) –

GstAnalyticsBatchBuffer in this batch for this stream

`n_buffers` (gsize) –

Number of buffers

Since : 1.28

## GstAnalytics.BatchStream

### Members

`index` (Number) –

Index of the stream in the meta's stream array

`buffers` ([ GstAnalytics.BatchBuffer ]) –

GstAnalytics.BatchBuffer in this batch for this stream

`n_buffers` (Number) –

Number of buffers

Since : 1.28

## GstAnalytics.BatchStream

### Members

`index` (int) –

Index of the stream in the meta's stream array

`buffers` ([ GstAnalytics.BatchBuffer ]) –

GstAnalytics.BatchBuffer in this batch for this stream

`n_buffers` (int) –

Number of buffers

Since : 1.28

## Functions

### gst_analytics_batch_meta_api_get_type

    GType
    gst_analytics_batch_meta_api_get_type ()

Returns –
No description available

Since : 1.28

### gst_buffer_add_analytics_batch_meta

    GstAnalyticsBatchMeta *
    gst_buffer_add_analytics_batch_meta (GstBuffer * buffer)

Adds a GstAnalyticsBatchMeta to a buffer or returns the existing one

Parameters:

`buffer` –

A writable GstBuffer

Returns ( [transfer: none]) –

The new GstAnalyticsBatchMeta

Since : 1.28

### GstAnalytics.prototype.buffer_add_analytics_batch_meta

    function GstAnalytics.prototype.buffer_add_analytics_batch_meta(buffer: Gst.Buffer): {
        // javascript wrapper for 'gst_buffer_add_analytics_batch_meta'
    }

Adds a GstAnalytics.BatchMeta to a buffer or returns the existing one

Parameters:

`buffer` (Gst.Buffer) –

A writable Gst.Buffer

Returns (GstAnalytics.BatchMeta) –

The new GstAnalytics.BatchMeta

Since : 1.28

### GstAnalytics.buffer_add_analytics_batch_meta

    def GstAnalytics.buffer_add_analytics_batch_meta (buffer):
        #python wrapper for 'gst_buffer_add_analytics_batch_meta'

Adds a GstAnalytics.BatchMeta to a buffer or returns the existing one

Parameters:

`buffer` (Gst.Buffer) –

A writable Gst.Buffer

Returns (GstAnalytics.BatchMeta) –

The new GstAnalytics.BatchMeta

Since : 1.28

### gst_buffer_get_analytics_batch_meta

    GstAnalyticsBatchMeta *
    gst_buffer_get_analytics_batch_meta (GstBuffer * buffer)

Gets the GstAnalyticsBatchMeta from a buffer

Parameters:

`buffer` –

A GstBuffer

Returns ( [nullable][transfer: none]) –

The GstAnalyticsBatchMeta if there is one

Since : 1.28

### GstAnalytics.prototype.buffer_get_analytics_batch_meta

    function GstAnalytics.prototype.buffer_get_analytics_batch_meta(buffer: Gst.Buffer): {
        // javascript wrapper for 'gst_buffer_get_analytics_batch_meta'
    }

Gets the GstAnalytics.BatchMeta from a buffer

Parameters:

`buffer` (Gst.Buffer) –

A Gst.Buffer

Returns (GstAnalytics.BatchMeta) –

The GstAnalytics.BatchMeta if there is one

Since : 1.28

### GstAnalytics.buffer_get_analytics_batch_meta

    def GstAnalytics.buffer_get_analytics_batch_meta (buffer):
        #python wrapper for 'gst_buffer_get_analytics_batch_meta'

Gets the GstAnalytics.BatchMeta from a buffer

Parameters:

`buffer` (Gst.Buffer) –

A Gst.Buffer

Returns (GstAnalytics.BatchMeta) –

The GstAnalytics.BatchMeta if there is one

Since : 1.28

## Constants

### GST_ANALYTICS_BATCH_META_API_TYPE

    #define GST_ANALYTICS_BATCH_META_API_TYPE \
      (gst_analytics_batch_meta_api_get_type())

The Analytics Batch Meta API type

Since : 1.28

### GST_ANALYTICS_BATCH_META_INFO

    #define GST_ANALYTICS_BATCH_META_INFO \
      (gst_analytics_batch_meta_get_info())

The Analytics Batch Meta API Info

Since : 1.28

### GST_CAPS_FEATURE_META_GST_ANALYTICS_BATCH_META

    #define GST_CAPS_FEATURE_META_GST_ANALYTICS_BATCH_META "meta:GstAnalyticsBatchMeta"

The caps feature to be used on streams that make use of this meta.

Since : 1.28

### GstAnalytics.CAPS_FEATURE_META_GST_ANALYTICS_BATCH_META

The caps feature to be used on streams that make use of this meta.

Since : 1.28

### GstAnalytics.CAPS_FEATURE_META_GST_ANALYTICS_BATCH_META

The caps feature to be used on streams that make use of this meta.

Since : 1.28

The results of the search are