Video capturer. More...
#include "config.h" #include "video_frame.h"
| Data Structures | |
| struct | otc_video_capturer_settings |
| struct | otc_video_capturer_callbacks |
| Typedefs | |
| typedef struct otc_video_capturer | otc_video_capturer |
| Functions | |
| otc_status | otc_video_capturer_provide_frame (const otc_video_capturer *capturer, int rotation, const otc_video_frame *frame) |
| otc_status const | otc_video_capturer_set_content_hint (const otc_video_capturer *capturer, enum otc_video_capturer_content_hint_type content_hint) |
| enum otc_video_capturer_content_hint_type const | otc_video_capturer_get_content_hint (const otc_video_capturer *capturer) |
Detailed Description
Video capturer.
This file includes the type definition for a video capturer along with several function declarations useful when working with it.
Typedef Documentation
otc_video_capturer
| typedef struct otc_video_capturer otc_video_capturer |
Video capturer type definition.
Enumeration Type Documentation
otc_video_capturer_content_hint_type
Defines values for the content_hint parameter of the otc_video_capturer_set_content_hint function.
| Enumerator | |
|---|---|
| OTC_VIDEO_CAPTURER_CONTENT_HINT_TYPE_NONE | No hint provided. Default value "none" will be used. |
| OTC_VIDEO_CAPTURER_CONTENT_HINT_TYPE_MOTION | value = "motion" |
| OTC_VIDEO_CAPTURER_CONTENT_HINT_TYPE_DETAIL | value = "detail". |
| OTC_VIDEO_CAPTURER_CONTENT_HINT_TYPE_TEXT | value = "text". |
Function Documentation
otc_video_capturer_get_content_hint()
| enum otc_video_capturer_content_hint_type const otc_video_capturer_get_content_hint | ( | const otc_video_capturer * | capturer | ) |
Returns the content_hint value for the capturer video source.
Parameters : | | | | --- | --- | | capturer | The pointer to the capturer. |
Returns : Enum value of type otc_video_capturer_content_hint_type
otc_video_capturer_provide_frame()
| otc_status otc_video_capturer_provide_frame | ( | const otc_video_capturer * | capturer, |
| int | rotation, | ||
| const otc_video_frame * | frame | ||
| ) |
Provides a video frame to the video capturer.
Parameters : | | | | --- | --- | | capturer | A pointer to the video capturer instance. | | rotation | The rotation of the video frame. | | frame | A pointer to the video frame instance to be provided. |
Returns : Return value indicating either error or success.
See also : otc_video_frame
otc_video_capturer_set_content_hint()
| otc_status const otc_video_capturer_set_content_hint | ( | const otc_video_capturer * | capturer, |
| enum otc_video_capturer_content_hint_type | content_hint | ||
| ) |
Sets the video content hint to one of the enum values in otc_video_capturer_content_hint_type. If the API receives any value other than the enum values specified above, then we log a warning about the same.
Parameters : | | | | --- | --- | | capturer | The pointer to the capturer | | content_hint | Enum value of type otc_video_capturer_content_hint_type. |
Returns : Return value indicating either failure or success.