native_avscreen_capture_base.h
Overview
The native_avscreen_capture_base.h file declares the common structs, character constants, and enums used for running screen capture.
Since
10
Related Modules
Summary
Structs
| Name | Description |
|---|---|
| OH_AudioCaptureInfo | Defines audio capturing information. |
| OH_AudioEncInfo | Defines audio encoding information. NOTE: This struct is reserved and will be provided in later versions. |
| OH_AudioInfo | Defines audio capturing parameters. |
| OH_VideoCaptureInfo | Defines video capturing information. |
| OH_VideoEncInfo | Defines video encoding information. NOTE: This struct is reserved and will be provided in later versions. |
| OH_VideoInfo | Defines video capturing parameters. |
| OH_RecorderInfo | Defines recording file information. |
| OH_AVScreenCaptureConfig | Defines the screen capture configuration. |
| OH_AVScreenCaptureCallback | Defines all the asynchronous callback function pointers of an OH_AVScreenCapture instance. |
| OH_Rect | Defines the width, height, and image information of the rectangle used for screen capture. |
| OH_AudioBuffer | Defines the configuration such as the size, type, and timestamp of audio data. |
Types
| Name | Description |
|---|---|
| OH_NativeBuffer | Defines the native video stream class for screen capture. |
| OH_AVScreenCapture | Defines a screen capture instance used to obtain original video and audio streams. |
| OH_CaptureMode | Defines an enum that enumerates the screen capture modes. |
| OH_AudioCaptureSourceType | Defines an enum that enumerates the audio source types during screen capture. |
| OH_AudioCodecFormat | Defines an enum that enumerates the audio encoding formats. |
| OH_VideoCodecFormat | Defines an enum that enumerates the video encoding formats. |
| OH_DataType | Defines an enum that enumerates the data types of screen capture streams. |
| OH_VideoSourceType | Defines an enum that enumerates the video source formats. |
| OH_ContainerFormatType | Defines an enum that enumerates the types of files generated during screen capture. NOTE: This type is reserved and will be provided in later versions. |
| OH_AudioCaptureInfo | Defines audio capturing information. |
| OH_AudioEncInfo | Defines audio encoding information. NOTE: This type is reserved and will be provided in later versions. |
| OH_AudioInfo | Defines audio capturing parameters. |
| OH_VideoCaptureInfo | Defines video capturing information. |
| OH_VideoEncInfo | Defines video encoding information. NOTE: This type is reserved and will be provided in later versions. |
| OH_VideoInfo | Defines video capturing parameters. |
| OH_RecorderInfo | Defines recording file information. |
| OH_AVScreenCaptureConfig | Defines the screen recording configuration. |
| (*OH_AVScreenCaptureOnError) (OH_AVScreenCapture *capture, int32_t errorCode) | Defines a pointer to a callback function that is called when an error occurs during the running of an OH_AVScreenCapture instance. |
| (*OH_AVScreenCaptureOnAudioBufferAvailable) (OH_AVScreenCapture *capture, bool isReady, OH_AudioCaptureSourceType type) | Defines a pointer to a callback function that is called when an audio buffer is available during the running of an OH_AVScreenCapture instance. |
| (*OH_AVScreenCaptureOnVideoBufferAvailable) (OH_AVScreenCapture *capture, bool isReady) | Defines a pointer to a callback function that is called when a video buffer is available during the running of an OH_AVScreenCapture instance. |
| OH_AVScreenCaptureCallback | Defines all the asynchronous callback function pointers of an OH_AVScreenCapture instance. |
| OH_Rect | Defines the width, height, and image information of the rectangle used for screen capture. |
| OH_AudioBuffer | Defines the configuration such as the size, type, and timestamp of audio data. |
Enums
| Name | Description |
|---|---|
| OH_CaptureMode { OH_CAPTURE_HOME_SCREEN = 0, OH_CAPTURE_SPECIFIED_SCREEN = 1, OH_CAPTURE_SPECIFIED_WINDOW = 2, OH_CAPTURE_INVAILD = -1 } | Enumerates the screen capture modes. |
| OH_AudioCaptureSourceType { OH_SOURCE_INVALID = -1, OH_SOURCE_DEFAULT = 0, OH_MIC = 1, OH_ALL_PLAYBACK = 2, OH_APP_PLAYBACK = 3 } |
Enumerates the audio source types during screen capture. |
| OH_AudioCodecFormat { OH_AUDIO_DEFAULT = 0, OH_AAC_LC = 3, OH_AUDIO_CODEC_FORMAT_BUTT } | Enumerates the audio encoding formats. |
| OH_VideoCodecFormat { OH_VIDEO_DEFAULT = 0, OH_H264 = 2, OH_H265 = 4, OH_MPEG4 = 6, OH_VP8 = 8, OH_VP9 = 10, OH_VIDEO_CODEC_FORMAT_BUTT } |
Enumerates the video encoding formats. |
| OH_DataType { OH_ORIGINAL_STREAM = 0, OH_ENCODED_STREAM = 1, OH_CAPTURE_FILE = 2, OH_INVAILD = -1 } | Enumerates the data sources of screen capture streams. |
| OH_VideoSourceType { OH_VIDEO_SOURCE_SURFACE_YUV = 0, OH_VIDEO_SOURCE_SURFACE_ES, OH_VIDEO_SOURCE_SURFACE_RGBA, OH_VIDEO_SOURCE_BUTT } | Enumerates the video source formats. |
| OH_ContainerFormatType { CFT_MPEG_4A = 0, CFT_MPEG_4 = 1 } | Enumerates the types of files generated during screen capture. NOTE: This enum is reserved and will be provided in later versions. |