otc_video_frame_planar_memory_callbacks Struct Reference

#include <video_frame.h>

Data Fields
const uint8_t *(*	get_plane )(void *user_data, enum otc_video_frame_plane plane)
int(*	get_plane_stride )(void *user_data, enum otc_video_frame_plane plane)
void(*	release )(void *user_data)
void *	user_data
void *	reserved

Detailed Description

Defines a struct containing callback functions for a video frame plane memory wrapper struct.

See also

otc_video_frame_new_planar_memory_wrapper

Field Documentation

get_plane

const uint8_t*(* get_plane) (void *user_data, enum otc_video_frame_plane plane)

Called when a video frame plane is requested. It is mandatory to implement this callback function.

Parameters

user_data	A pointer to the user data bound to this struct.
plane	Given plane.

Returns

Pointer to video frame plane.

get_plane_stride

int(* get_plane_stride) (void *user_data, enum otc_video_frame_plane plane)

Called when a video frame plane stride is requested.

Parameters

user_data	A pointer to the user data bound to this struct.
plane	Given plane.

Returns

Video frame plane stride.

release

void(* release) (void *user_data)

Called when you can release the video frame data from memory. It is not mandatory to implement this callback function.

Parameters

user_data

A pointer to the user data bound to this struct.

reserved

void* reserved

A void pointer to a memory area holding reserved resources used for the internal implementation.

user_data

void* user_data

A pointer to any useful user data related to this struct.

---

The documentation for this struct was generated from the following file:

• src/otkit/include/opentok/video_frame.h