otc_video_frame_planar_memory_callbacks
Defines a struct containing callback functions for a video frame plane memory wrapper struct.
Properties
| Name | Type | Description |
|---|---|---|
user_data |
void * | A pointer to any useful user data related to this struct. |
reserved |
void * | A void pointer to a memory area holding reserved resources used for the internal implementation. |
Callbacks
| Name | Description |
|---|---|
get_plane(user_data, plane) → {const uint8_t *} |
Called when a video frame plane is requested. |
get_plane_stride(user_data, plane) → {int} |
Called when a video frame plane stride is requested. |
release(user_data) |
Called when you can release the video frame data from memory. |
get_plane(user_data, plane) → {const uint8_t *}
Called when a video frame plane is requested. It is mandatory to implement this callback function.
Parameters:
| Name | Type | Description |
|---|---|---|
user_data |
void * | A pointer to the user data bound to this struct. |
plane |
enum otc_video_frame_plane | Given plane. |
Returns:
Pointer to video frame plane.
get_plane_stride(user_data, plane) → {int}
Called when a video frame plane stride is requested.
Parameters:
| Name | Type | Description |
|---|---|---|
user_data |
void * | A pointer to the user data bound to this struct. |
plane |
enum otc_video_frame_plane | Given plane. |
Returns:
Video frame plane stride.
release(user_data)
Called when you can release the video frame data from memory. It is not mandatory to implement this callback function.
Parameters:
| Name | Type | Description |
|---|---|---|
user_data |
void * | A pointer to the user data bound to this struct. |