#include <video_capturer.h>
| Data Fields | |
| otc_bool(* | init )(const otc_video_capturer *capturer, void *user_data) |
| otc_bool(* | destroy )(const otc_video_capturer *capturer, void *user_data) |
| otc_bool(* | start )(const otc_video_capturer *capturer, void *user_data) |
| otc_bool(* | stop )(const otc_video_capturer *capturer, void *user_data) |
| otc_bool(* | get_capture_settings )(const otc_video_capturer *capturer, void *user_data, struct otc_video_capturer_settings *settings) |
| void * | user_data |
| void * | reserved |
Detailed Description
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.
Field Documentation
destroy
| otc_bool(* destroy) (const otc_video_capturer *capturer, void *user_data) |
Requests that a video capturer destroy itself.
Parameters : | | | | --- | --- | | capturer | A pointer to a video capturer instance. | | user_data | Pointer to user custom data bound to this struct. |
Returns : Boolean value indicating either error or success.
See also : otc_bool
get_capture_settings
| otc_bool(* get_capture_settings) (const otc_video_capturer *capturer, void *user_data, struct otc_video_capturer_settings *settings) |
Request that the video capturer returns the settings being used.
Parameters : | | | | --- | --- | | capturer | A pointer to a video capturer instance. | | user_data | Pointer to user custom data bound to this struct. | | settings | A pointer to a struct holding the settings. |
Returns : Boolean value indicating either error or success.
See also : otc_bool
init
| otc_bool(* init) (const otc_video_capturer *capturer, void *user_data) |
Requests that a video capturer initialize itself.
Parameters : | | | | --- | --- | | capturer | A pointer to a video capturer instance. | | user_data | Pointer to user custom data bound to this struct. |
Returns : Boolean value indicating either error or success.
See also : otc_bool
reserved
| void* reserved |
A void pointer to a memory area holding reserved resources used for the internal implementation.
start
| otc_bool(* start) (const otc_video_capturer *capturer, void *user_data) |
Requests that the video capturer starts capturing video.
Parameters : | | | | --- | --- | | capturer | A pointer to a video capturer instance. | | user_data | Pointer to user custom data bound to this struct. |
Returns : Boolean value indicating either error or success.
See also : otc_bool
stop
| otc_bool(* stop) (const otc_video_capturer *capturer, void *user_data) |
Requests that the video capturer stops capturing video.
Parameters : | | | | --- | --- | | capturer | A pointer to a video capturer instance. | | user_data | Pointer to user custom data bound to this struct. |
Returns : Boolean value indicating either error or success.
See also : otc_bool
user_data
| void* user_data |
This struct member can point to data related to the video capturer which the developer might need.