# GstMLFrame

Source: [https://docs.qualcomm.com/doc/80-70014-50/topic/ml-api-gstmlframe.html](https://docs.qualcomm.com/doc/80-70014-50/topic/ml-api-gstmlframe.html)

GstMLFrame is a convenient structure obtained from
            gst\_ml\_frame\_map(), containing mapped pointers to the tensors and the
        required information about them.

Table : Structure of GstMLFrame

| Field | Description |
| --- | --- |
| info (GstMLInfo) | The GstMLInfo |
| buffer ([GstBuffer](https://gstreamer.freedesktop.org/documentation/gstreamer/gstbuffer.html?gi-language=c)) | Mapped buffer containing the tensor memory blocks |
| map ([GstMapInfo](https://gstreamer.freedesktop.org/documentation/gstreamer/gstmemory.html?gi-language=c#GstMapInfo)) | Mappings of the tensor memory blocks |

## gst\_ml\_frame\_map

Updates the frame values using GstMLInfo and GstBuffer, which then allocates the
                frame on a stack.

1. The addressed is passed to the GstMLFrame structure that is allocated on the
                    stack.
2. The gst\_ml\_frame\_map() function fills the GstMLFrame
                    structure with various ML tensor-specific information required to access the ML
                    buffer data. All the buffer video tensors are mapped and the pointers are set in
                    the frame data.

**Prototype**

    gboolean
    gst_ml_frame_map (GstMLFrame * frame, const GstMLInfo * info, GstBuffer * buffer, GstMapFlags flags)
    Copy to clipboard

**Parameters**

| [in] | `frame` | Pointer to GstMLFrame |
| :--- | :--- | :--- |
| [in] | `info` | A GstMLInfo |
| [in] | `buffer` | A GstBuffer |
| [in] | `flags` | A GstMapFlags |

**Returns**

TRUE if the map operation was successful.

## gst\_ml\_frame\_unmap

Un-maps the memory that was previously mapped with
                    gst\_ml\_frame\_map().

**Prototype**

    void
    gst_ml_frame_unmap (GstMLFrame * frame)Copy to clipboard

**Parameters**

| [in] | `frame` | Pointer to GstMLFrame |
| :--- | :--- | :--- |

**Returns**

None

**Parent Topic:** [Machine learning APIs](https://docs.qualcomm.com/doc/80-70014-50/topic/machine-learning-apis.html)

Last Published: Oct 27, 2025

[Previous Topic
GstMLTensorMeta](https://docs.qualcomm.com/bundle/publicresource/80-70014-50/topics/ml-api-gstmltensormeta.md) [Next Topic
GstMLBufferPool](https://docs.qualcomm.com/bundle/publicresource/80-70014-50/topics/ml-api-gstmlbufferpool.md)