# GstAnalyticsGroupMtd

This type of metadata define a group of GstAnalyticsMtd. It allows to describe results as composition. Group members are ordered within the group and the semantic_tag allow to define a specific group meaning. For example with a semantic_tag = "posture/hand-21-kp", first member represent the "wrist", second is the thumb first joint.

## GstAnalyticsGroupMtd

Handle containing data required by gst_analytics_group_mtd APIs. This type is generally expected to be allocated on the stack.

### Members

`id` (guint) –

Instance identifier

`meta` (GstAnalyticsRelationMeta *) –

Instance of GstAnalyticsRelationMeta where the analytics-metadata identified by id is stored

Since : 1.30

## GstAnalytics.GroupMtd

Handle containing data required by gst_analytics_group_mtd APIs. This type is generally expected to be allocated on the stack.

### Members

`id` (Number) –

Instance identifier

`meta` (GstAnalytics.RelationMeta) –

Instance of GstAnalytics.RelationMeta where the analytics-metadata identified by id is stored

Since : 1.30

## GstAnalytics.GroupMtd

Handle containing data required by gst_analytics_group_mtd APIs. This type is generally expected to be allocated on the stack.

### Members

`id` (int) –

Instance identifier

`meta` (GstAnalytics.RelationMeta) –

Instance of GstAnalytics.RelationMeta where the analytics-metadata identified by id is stored

Since : 1.30

### Methods

#### gst_analytics_group_mtd_add_member

    gboolean
    gst_analytics_group_mtd_add_member (GstAnalyticsGroupMtd * handle,
                                        guint an_meta_id)

Adding a member to the group.

Parameters:

`handle` –

handle of GstAnalyticsMtd where to add a member

`an_meta_id` –

ID of GstAnalyticsMtd to add as a member

Returns –

Member added successfully

Since : 1.30

#### GstAnalytics.GroupMtd.prototype.add_member

    function GstAnalytics.GroupMtd.prototype.add_member(an_meta_id: Number): {
        // javascript wrapper for 'gst_analytics_group_mtd_add_member'
    }

Adding a member to the group.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle of GstAnalytics.Mtd where to add a member

`an_meta_id` (Number) –

ID of GstAnalytics.Mtd to add as a member

Returns (Number) –

Member added successfully

Since : 1.30

#### GstAnalytics.GroupMtd.add_member

    def GstAnalytics.GroupMtd.add_member (self, an_meta_id):
        #python wrapper for 'gst_analytics_group_mtd_add_member'

Adding a member to the group.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle of GstAnalytics.Mtd where to add a member

`an_meta_id` (int) –

ID of GstAnalytics.Mtd to add as a member

Returns (bool) –

Member added successfully

Since : 1.30

#### gst_analytics_group_mtd_get_member

    gboolean
    gst_analytics_group_mtd_get_member (const GstAnalyticsGroupMtd * handle,
                                        gsize index,
                                        GstAnalyticsMtd * member)

Get a member from the group by index. Members are ordered within the group according to the semantic tag meaning.

Parameters:

`handle` –

handle

`index` –

Index of the member to retrieve

`member` ( [out][not nullable]) –

Handle updated to the member at index

Returns –

TRUE if member was retrieved successfully, FALSE otherwise (invalid index or error).

Since : 1.30

#### GstAnalytics.GroupMtd.prototype.get_member

    function GstAnalytics.GroupMtd.prototype.get_member(index: Number): {
        // javascript wrapper for 'gst_analytics_group_mtd_get_member'
    }

Get a member from the group by index. Members are ordered within the group according to the semantic tag meaning.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle

`index` (Number) –

Index of the member to retrieve

Returns a tuple made of:

(Number ) –

TRUE if member was retrieved successfully, FALSE otherwise (invalid index or error).

`member` (GstAnalytics.Mtd ) –

TRUE if member was retrieved successfully, FALSE otherwise (invalid index or error).

Since : 1.30

#### GstAnalytics.GroupMtd.get_member

    def GstAnalytics.GroupMtd.get_member (self, index):
        #python wrapper for 'gst_analytics_group_mtd_get_member'

Get a member from the group by index. Members are ordered within the group according to the semantic tag meaning.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle

`index` (int) –

Index of the member to retrieve

Returns a tuple made of:

(bool ) –

TRUE if member was retrieved successfully, FALSE otherwise (invalid index or error).

`member` (GstAnalytics.Mtd ) –

TRUE if member was retrieved successfully, FALSE otherwise (invalid index or error).

Since : 1.30

#### gst_analytics_group_mtd_get_member_count

    gsize
    gst_analytics_group_mtd_get_member_count (const GstAnalyticsGroupMtd * handle)

Get the number of members in the group.

Parameters:

`handle` –

handle

Returns –

Number of members in the group, or 0 on error.

Since : 1.30

#### GstAnalytics.GroupMtd.prototype.get_member_count

    function GstAnalytics.GroupMtd.prototype.get_member_count(): {
        // javascript wrapper for 'gst_analytics_group_mtd_get_member_count'
    }

Get the number of members in the group.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle

Returns (Number) –

Number of members in the group, or 0 on error.

Since : 1.30

#### GstAnalytics.GroupMtd.get_member_count

    def GstAnalytics.GroupMtd.get_member_count (self):
        #python wrapper for 'gst_analytics_group_mtd_get_member_count'

Get the number of members in the group.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle

Returns (int) –

Number of members in the group, or 0 on error.

Since : 1.30

#### gst_analytics_group_mtd_has_semantic_tag

    gboolean
    gst_analytics_group_mtd_has_semantic_tag (const GstAnalyticsGroupMtd * handle,
                                              const gchar * tag)

Check if the group's semantic tag matches tag. An empty or unset tag never matches.

Parameters:

`handle` –

handle

`tag` –

tag string to compare against

Returns –

TRUE if the group's semantic tag equals tag.

Since : 1.30

#### GstAnalytics.GroupMtd.prototype.has_semantic_tag

    function GstAnalytics.GroupMtd.prototype.has_semantic_tag(tag: String): {
        // javascript wrapper for 'gst_analytics_group_mtd_has_semantic_tag'
    }

Check if the group's semantic tag matches tag. An empty or unset tag never matches.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle

`tag` (String) –

tag string to compare against

Returns (Number) –

true if the group's semantic tag equals tag.

Since : 1.30

#### GstAnalytics.GroupMtd.has_semantic_tag

    def GstAnalytics.GroupMtd.has_semantic_tag (self, tag):
        #python wrapper for 'gst_analytics_group_mtd_has_semantic_tag'

Check if the group's semantic tag matches tag. An empty or unset tag never matches.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle

`tag` (str) –

tag string to compare against

Returns (bool) –

True if the group's semantic tag equals tag.

Since : 1.30

#### gst_analytics_group_mtd_iterate

    gboolean
    gst_analytics_group_mtd_iterate (const GstAnalyticsGroupMtd * handle,
                                     gpointer * state,
                                     GstAnalyticsMtdType type,
                                     GstAnalyticsMtd * member)

Iterate over members in the group. If type is specified, only members matching that type are returned. Initialize state to NULL to start iteration.

Parameters:

`handle` –

Instance of GstAnalyticsGroupMtd to iterate

`state` ( [inout]) –

Opaque data to store iteration state, initialize to NULL, no need to free it.

`type` –

Type of GstAnalyticsMtd to iterate on or use GST_ANALYTICS_MTD_TYPE_ANY for any.

`member` ( [out][not nullable]) –

Handle updated to iterated group member.

Returns –

TRUE if a member was retrieved, FALSE when iteration is complete or an error occurred.

Since : 1.30

#### GstAnalytics.GroupMtd.prototype.iterate

    function GstAnalytics.GroupMtd.prototype.iterate(state: Object, type: Number): {
        // javascript wrapper for 'gst_analytics_group_mtd_iterate'
    }

Iterate over members in the group. If type is specified, only members matching that type are returned. Initialize state to NULL to start iteration.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

Instance of GstAnalyticsGroupMtd to iterate

`state` (Object) –

Opaque data to store iteration state, initialize to NULL, no need to free it.

`type` (Number) –

Type of GstAnalyticsMtd to iterate on or use GstAnalytics.MTD_TYPE_ANY for any.

Returns a tuple made of:

(Number ) –

TRUE if a member was retrieved, FALSE when iteration is complete or an error occurred.

`state` (Object ) –

TRUE if a member was retrieved, FALSE when iteration is complete or an error occurred.

`member` (GstAnalytics.Mtd ) –

TRUE if a member was retrieved, FALSE when iteration is complete or an error occurred.

Since : 1.30

#### GstAnalytics.GroupMtd.iterate

    def GstAnalytics.GroupMtd.iterate (self, state, type):
        #python wrapper for 'gst_analytics_group_mtd_iterate'

Iterate over members in the group. If type is specified, only members matching that type are returned. Initialize state to NULL to start iteration.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

Instance of GstAnalyticsGroupMtd to iterate

`state` (object) –

Opaque data to store iteration state, initialize to NULL, no need to free it.

`type` (int) –

Type of GstAnalyticsMtd to iterate on or use GstAnalytics.MTD_TYPE_ANY for any.

Returns a tuple made of:

(bool ) –

TRUE if a member was retrieved, FALSE when iteration is complete or an error occurred.

`state` (object ) –

TRUE if a member was retrieved, FALSE when iteration is complete or an error occurred.

`member` (GstAnalytics.Mtd ) –

TRUE if a member was retrieved, FALSE when iteration is complete or an error occurred.

Since : 1.30

#### gst_analytics_group_mtd_semantic_tag_has_prefix

    gboolean
    gst_analytics_group_mtd_semantic_tag_has_prefix (const GstAnalyticsGroupMtd * handle,
                                                     const gchar * prefix)

Check if the group's semantic tag starts with prefix. An empty or unset tag never matches.

Parameters:

`handle` –

handle

`prefix` –

prefix string to test against

Returns –

TRUE if the group's semantic tag starts with prefix.

Since : 1.30

#### GstAnalytics.GroupMtd.prototype.semantic_tag_has_prefix

    function GstAnalytics.GroupMtd.prototype.semantic_tag_has_prefix(prefix: String): {
        // javascript wrapper for 'gst_analytics_group_mtd_semantic_tag_has_prefix'
    }

Check if the group's semantic tag starts with prefix. An empty or unset tag never matches.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle

`prefix` (String) –

prefix string to test against

Returns (Number) –

true if the group's semantic tag starts with prefix.

Since : 1.30

#### GstAnalytics.GroupMtd.semantic_tag_has_prefix

    def GstAnalytics.GroupMtd.semantic_tag_has_prefix (self, prefix):
        #python wrapper for 'gst_analytics_group_mtd_semantic_tag_has_prefix'

Check if the group's semantic tag starts with prefix. An empty or unset tag never matches.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle

`prefix` (str) –

prefix string to test against

Returns (bool) –

True if the group's semantic tag starts with prefix.

Since : 1.30

#### gst_analytics_group_mtd_set_semantic_tag

    gboolean
    gst_analytics_group_mtd_set_semantic_tag (GstAnalyticsGroupMtd * handle,
                                              const char* tag)

Set grouping semantic tag. This gives a context to understand the grouping. For example "hand-21-kp", "human-pose-17-kp" that give a specific context allowing to understand the grouping semantic. Pass NULL to clear the tag.

Parameters:

`handle` –

handle of GstAnalyticsMtd where to set semantic_tag

`tag` ( [nullable]) –

string representing a semantic type of grouping, or NULL to clear the tag

Returns –

TRUE is semantic_tag was set successfully

Since : 1.30

#### GstAnalytics.GroupMtd.prototype.set_semantic_tag

    function GstAnalytics.GroupMtd.prototype.set_semantic_tag(tag: String): {
        // javascript wrapper for 'gst_analytics_group_mtd_set_semantic_tag'
    }

Set grouping semantic tag. This gives a context to understand the grouping. For example "hand-21-kp", "human-pose-17-kp" that give a specific context allowing to understand the grouping semantic. Pass null to clear the tag.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle of GstAnalytics.Mtd where to set semantic_tag

`tag` (String) –

string representing a semantic type of grouping, or null to clear the tag

Returns (Number) –

TRUE is semantic_tag was set successfully

Since : 1.30

#### GstAnalytics.GroupMtd.set_semantic_tag

    def GstAnalytics.GroupMtd.set_semantic_tag (self, tag):
        #python wrapper for 'gst_analytics_group_mtd_set_semantic_tag'

Set grouping semantic tag. This gives a context to understand the grouping. For example "hand-21-kp", "human-pose-17-kp" that give a specific context allowing to understand the grouping semantic. Pass None to clear the tag.

Parameters:

`handle` (GstAnalytics.GroupMtd) –

handle of GstAnalytics.Mtd where to set semantic_tag

`tag` (str) –

string representing a semantic type of grouping, or None to clear the tag

Returns (bool) –

TRUE is semantic_tag was set successfully

Since : 1.30

### Functions

#### gst_analytics_group_mtd_get_mtd_type

    GstAnalyticsMtdType
    gst_analytics_group_mtd_get_mtd_type ()

Get an id identifying GstAnalyticsMtd type.

Returns –

opaque id of GstAnalyticsMtd type

Since : 1.30

#### GstAnalytics.GroupMtd.prototype.get_mtd_type

    function GstAnalytics.GroupMtd.prototype.get_mtd_type(): {
        // javascript wrapper for 'gst_analytics_group_mtd_get_mtd_type'
    }

Get an id identifying GstAnalytics.Mtd type.

Returns (Number) –

opaque id of GstAnalytics.Mtd type

Since : 1.30

#### GstAnalytics.GroupMtd.get_mtd_type

    def GstAnalytics.GroupMtd.get_mtd_type ():
        #python wrapper for 'gst_analytics_group_mtd_get_mtd_type'

Get an id identifying GstAnalytics.Mtd type.

Returns (int) –

opaque id of GstAnalytics.Mtd type

Since : 1.30

The results of the search are