otc_video_capturer_callbacks
Audio device callback functions.
This struct is a set of function pointers to callback functions for events related to a video capturer.
All callbacks will not be made on the application or main thread but on an internal thread. The application should return the callback as quickly as possible to avoid blocking the internal thread.
Properties
| Name | Type | Description |
|---|---|---|
user_data |
void * | This struct member can point to data related to the video capturer which the developer might need. |
reserved |
void * | A void pointer to a memory area holding reserved resources used for the internal implementation. |
Callbacks
| Name | Description |
|---|---|
init(capturer, user_data) → {otc_bool} |
Requests that a video capturer initialize itself. |
destroy(capturer, user_data) → {otc_bool} |
Requests that a video capturer destroy itself. |
start(capturer, user_data) → {otc_bool} |
Requests that the video capturer starts capturing video. |
stop(capturer, user_data) → {otc_bool} |
Requests that the video capturer stops capturing video. |
get_capture_settings(capturer, user_data, settings) → {otc_bool} |
Request that the video capturer returns the settings being used. |
init(capturer, user_data) → {otc_bool}
Requests that a video capturer initialize itself.
Parameters:
| Name | Type | Description |
|---|---|---|
capturer |
const otc_video_capturer * | A pointer to a video capturer instance. |
user_data |
void * | Pointer to user custom data bound to this struct. |
See: : - otc_bool
Returns:
Boolean value indicating either error or success.
destroy(capturer, user_data) → {otc_bool}
Requests that a video capturer destroy itself.
Parameters:
| Name | Type | Description |
|---|---|---|
capturer |
const otc_video_capturer * | A pointer to a video capturer instance. |
user_data |
void * | Pointer to user custom data bound to this struct. |
See: : - otc_bool
Returns:
Boolean value indicating either error or success.
start(capturer, user_data) → {otc_bool}
Requests that the video capturer starts capturing video.
Parameters:
| Name | Type | Description |
|---|---|---|
capturer |
const otc_video_capturer * | A pointer to a video capturer instance. |
user_data |
void * | Pointer to user custom data bound to this struct. |
See: : - otc_bool
Returns:
Boolean value indicating either error or success.
stop(capturer, user_data) → {otc_bool}
Requests that the video capturer stops capturing video.
Parameters:
| Name | Type | Description |
|---|---|---|
capturer |
const otc_video_capturer * | A pointer to a video capturer instance. |
user_data |
void * | Pointer to user custom data bound to this struct. |
See: : - otc_bool
Returns:
Boolean value indicating either error or success.
get_capture_settings(capturer, user_data, settings) → {otc_bool}
Request that the video capturer returns the settings being used.
Parameters:
| Name | Type | Description |
|---|---|---|
capturer |
const otc_video_capturer * | A pointer to a video capturer instance. |
user_data |
void * | Pointer to user custom data bound to this struct. |
settings |
struct otc_video_capturer_settings * | A pointer to a struct holding the settings. |
See: : - otc_bool
Returns:
Boolean value indicating either error or success.