未验证 提交 8feffb1f 编写于 作者: Z zengyawen 提交者: Gitee

增加预留接口说明

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 c327778c
......@@ -29,10 +29,10 @@
| 名称 | 描述 |
| -------- | -------- |
| [OH_AudioCaptureInfo](_o_h___audio_capture_info.md) | 音频录制信息。 |
| [OH_AudioEncInfo](_o_h___audio_enc_info.md) | 音频编码信息。 |
| [OH_AudioEncInfo](_o_h___audio_enc_info.md) | 音频编码信息。<br>**说明:** 预留接口,将在后续版本提供。 |
| [OH_AudioInfo](_o_h___audio_info.md) | 音频录制参数。 |
| [OH_VideoCaptureInfo](_o_h___video_capture_info.md) | 视频采集信息。 |
| [OH_VideoEncInfo](_o_h___video_enc_info.md) | 视频编码参数。 |
| [OH_VideoEncInfo](_o_h___video_enc_info.md) | 视频编码信息。 <br>**说明:** 预留接口,将在后续版本提供。|
| [OH_VideoInfo](_o_h___video_info.md) | 视频录制参数。 |
| [OH_RecorderInfo](_o_h___recorder_info.md) | 录制文件信息。 |
| [OH_AVScreenCaptureConfig](_o_h___a_v_screen_capture_config.md) | 屏幕录制配置参数。 |
......@@ -55,10 +55,10 @@
| [OH_VideoSourceType](#oh_videosourcetype) | 枚举,表示视频源格式。 |
| [OH_ContainerFormatType](#oh_containerformattype) | 枚举,表示屏幕录制生成的文件类型。 |
| [OH_AudioCaptureInfo](#oh_audiocaptureinfo) | 音频录制信息。 |
| [OH_AudioEncInfo](#oh_audioencinfo) | 音频编码信息。 |
| [OH_AudioEncInfo](#oh_audioencinfo) | 音频编码信息。 <br>**说明:** 预留接口,将在后续版本提供。|
| [OH_AudioInfo](#oh_audioinfo) | 音频录制参数。 |
| [OH_VideoCaptureInfo](#oh_videocaptureinfo) | 视频采集信息。 |
| [OH_VideoEncInfo](#oh_videoencinfo) | 视频编码参数。 |
| [OH_VideoEncInfo](#oh_videoencinfo) | 视频编码信息。<br>**说明:** 预留接口,将在后续版本提供。 |
| [OH_VideoInfo](#oh_videoinfo) | 视频录制参数。 |
| [OH_RecorderInfo](#oh_recorderinfo) | 录制文件信息。 |
| [OH_AVScreenCaptureConfig](#oh_avscreencaptureconfig) | 屏幕录制配置参数。 |
......@@ -93,8 +93,8 @@
| [OH_AVScreenCapture_Init](#oh_avscreencapture_init) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture, [OH_AVScreenCaptureConfig](_o_h___a_v_screen_capture_config.md) config) | 初始化OH_AVScreenCapture相关参数。 |
| [OH_AVScreenCapture_StartScreenCapture](#oh_avscreencapture_startscreencapture) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture) | 开始录屏,调用后可以通过回调的监听(OH_AVScreenCaptureOnAudioBufferAvailable,OH_AVScreenCaptureOnVideoBufferAvailable)来监听当前是否有码流的产生。 |
| [OH_AVScreenCapture_StopScreenCapture](#oh_avscreencapture_stopscreencapture) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture) | 结束录屏,调用后针对调用该接口的应用会停止录屏或屏幕共享,释放麦克风。 |
| [OH_AVScreenCapture_StartScreenRecording](#oh_avscreencapture_startscreenrecording) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture) | 启动录屏。 |
| [OH_AVScreenCapture_StopScreenRecording](#oh_avscreencapture_stopscreenrecording) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture) | 停止录屏。 |
| [OH_AVScreenCapture_StartScreenRecording](#oh_avscreencapture_startscreenrecording) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture) | 启动录屏。<br>**说明:** 预留接口,将在后续版本提供。 |
| [OH_AVScreenCapture_StopScreenRecording](#oh_avscreencapture_stopscreenrecording) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture) | 停止录屏。 <br>**说明:** 预留接口,将在后续版本提供。|
| [OH_AVScreenCapture_AcquireAudioBuffer](#oh_avscreencapture_acquireaudiobuffer) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture, [OH_AudioBuffer](_o_h___audio_buffer.md) \*\*audiobuffer, [OH_AudioCaptureSourceType](#oh_audiocapturesourcetype) type) | 获取音频buffer,应用在调用时,需要对audiobuffer分配对应结构体大小的内存,否则会影响拿到音频buffer的获取。 |
| [OH_AVScreenCapture_AcquireVideoBuffer](#oh_avscreencapture_acquirevideobuffer) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture, int32_t \*fence, int64_t \*timestamp, struct [OH_Rect](_o_h___rect.md) \*region) | 获取视频buffer,应用在调用时,通过此接口来获取到视频的buffer以及时间戳等信息。 |
| [OH_AVScreenCapture_ReleaseAudioBuffer](#oh_avscreencapture_releaseaudiobuffer) (struct [OH_AVScreenCapture](#oh_avscreencapture) \*capture, [OH_AudioCaptureSourceType](#oh_audiocapturesourcetype) type) | 根据音频类型释放buffer。 |
......@@ -177,6 +177,10 @@ typedef struct OH_AudioEncInfoOH_AudioEncInfo
音频编码信息。
> **说明:**
>
> 预留接口,将在后续版本提供。
**系统能力:**
SystemCapability.Multimedia.Media.AVScreenCapture
......@@ -462,6 +466,10 @@ typedef struct OH_VideoEncInfoOH_VideoEncInfo
视频编码参数。
> **说明:**
>
> 预留接口,将在后续版本提供。
**系统能力:**
SystemCapability.Multimedia.Media.AVScreenCapture
......@@ -591,8 +599,8 @@ SystemCapability.Multimedia.Media.AVScreenCapture
| 枚举值 | 描述 |
| -------- | -------- |
| OH_CAPTURE_HOME_SCREEN | 录制主屏幕。 |
| OH_CAPTURE_SPECIFIED_SCREEN | 录制指定屏幕。 |
| OH_CAPTURE_SPECIFIED_WINDOW | 录制指定窗口。 |
| OH_CAPTURE_SPECIFIED_SCREEN | 录制指定屏幕。<br>**说明:** 预留接口,将在后续版本提供。 |
| OH_CAPTURE_SPECIFIED_WINDOW | 录制指定窗口。 <br>**说明:** 预留接口,将在后续版本提供。|
| OH_CAPTURE_INVAILD | 无效模式。 |
......@@ -633,8 +641,8 @@ SystemCapability.Multimedia.Media.AVScreenCapture
| 枚举值 | 描述 |
| -------- | -------- |
| OH_ORIGINAL_STREAM | 原始流格式,如YUV/RGBA/PCM等。 |
| OH_ENCODED_STREAM | 编码格式,如H264/AAC等。 |
| OH_CAPTURE_FILE | 保存文件格式,目前仅支持mp4。 |
| OH_ENCODED_STREAM | 编码格式,如H264/AAC等。 <br>**说明:** 预留接口,将在后续版本提供。 |
| OH_CAPTURE_FILE | 保存文件格式,支持mp4。<br>**说明:** 预留接口,将在后续版本提供。 |
| OH_INVAILD | 无效格式。 |
......@@ -955,6 +963,10 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StartScreenRecording (struct OH_A
启动录屏。
> **说明:**
>
> 预留接口,将在后续版本提供。
**参数:**
| 名称 | 描述 |
......@@ -1005,6 +1017,10 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StopScreenRecording (struct OH_AV
停止录屏。
> **说明:**
>
> 预留接口,将在后续版本提供。
**参数:**
| 名称 | 描述 |
......
......@@ -27,7 +27,7 @@
| [dataType](#datatype) | [OH_DataType](_a_v_screen_capture.md#oh_datatype)<br/>屏幕录制流的数据格式。 |
| [audioInfo](#audioinfo) | [OH_AudioInfo](_o_h___audio_info.md)<br/>音频录制参数。 |
| [videoInfo](#videoinfo) | [OH_VideoInfo](_o_h___video_info.md)<br/>视频录制参数。 |
| [recorderInfo](#recorderinfo) | [OH_RecorderInfo](_o_h___recorder_info.md)<br/>录制文件参数,当数据格式为OH_CAPTURE_FILE时,必须设置。 |
| [recorderInfo](#recorderinfo) | [OH_RecorderInfo](_o_h___recorder_info.md)<br/>录制文件参数,当数据格式为OH_CAPTURE_FILE时,必须设置。<br>**说明:** 预留接口,将在后续版本提供。 |
## 结构体成员变量说明
......@@ -76,6 +76,10 @@ OH_RecorderInfo OH_AVScreenCaptureConfig::recorderInfo
录制文件参数,当数据格式为OH_CAPTURE_FILE时,必须设置。
> **说明:**
>
> 预留接口,将在后续版本提供。
### videoInfo
......
......@@ -5,6 +5,10 @@
音频编码信息。
> **说明:**
>
> 预留接口,将在后续版本提供。
**系统能力**:SystemCapability.Multimedia.Media.AVScreenCapture
**起始版本:**
......
......@@ -25,7 +25,7 @@
| -------- | -------- |
| [micCapInfo](#miccapinfo) | [OH_AudioCaptureInfo](_o_h___audio_capture_info.md)<br/>麦克风的音频参数。 |
| [innerCapInfo](#innercapinfo) | [OH_AudioCaptureInfo](_o_h___audio_capture_info.md)<br/>内录的音频参数。 |
| [audioEncInfo](#audioencinfo) | [OH_AudioEncInfo](_o_h___audio_enc_info.md)<br/>音频录制信息, 当dataType为OH_ORIGINAL_STREAM时不需要设置。 |
| [audioEncInfo](#audioencinfo) | [OH_AudioEncInfo](_o_h___audio_enc_info.md)<br/>音频录制信息, 当dataType为OH_ORIGINAL_STREAM时不需要设置。<br>**说明:** 预留接口,将在后续版本提供。 |
## 结构体成员变量说明
......@@ -41,6 +41,10 @@ OH_AudioEncInfo OH_AudioInfo::audioEncInfo
音频录制信息, 当dataType为OH_ORIGINAL_STREAM时不需要设置。
> **说明:**
>
> 预留接口,将在后续版本提供。
### innerCapInfo
......
......@@ -23,9 +23,9 @@
| 名称 | 描述 |
| -------- | -------- |
| [displayId](#displayid) | uint64_t<br/>录制物理屏id,使用该参数需要在capturemode为CAPTURE_SPECIFIED_SCREEN模式下使用。 |
| [missionIDs](#missionids) | int32_t \*<br/>指定窗口id列表,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。 |
| [missionIDsLen](#missionidslen) | int32_t<br/>指定窗口ID长度,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。 |
| [displayId](#displayid) | uint64_t<br/>录制物理屏id,使用该参数需要在capturemode为CAPTURE_SPECIFIED_SCREEN模式下使用。<br>**说明:** 预留接口,将在后续版本提供。 |
| [missionIDs](#missionids) | int32_t \*<br/>指定窗口id列表,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。 <br>**说明:** 预留接口,将在后续版本提供。|
| [missionIDsLen](#missionidslen) | int32_t<br/>指定窗口ID长度,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。<br>**说明:** 预留接口,将在后续版本提供。 |
| [videoFrameWidth](#videoframewidth) | int32_t<br/>采集视频的宽度设置。 |
| [videoFrameHeight](#videoframeheight) | int32_t<br/>采集视频的高度设置。 |
| [videoSource](#videosource) | [OH_VideoSourceType](_a_v_screen_capture.md#oh_videosourcetype)<br/>视频采集格式设置,目前仅支持RGBA格式。 |
......@@ -44,6 +44,10 @@ uint64_t OH_VideoCaptureInfo::displayId
录制物理屏id,使用该参数需要在capturemode为CAPTURE_SPECIFIED_SCREEN模式下使用。
> **说明:**
>
> 预留接口,将在后续版本提供。
### missionIDs
......@@ -55,6 +59,9 @@ int32_t* OH_VideoCaptureInfo::missionIDs
指定窗口id列表,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。
> **说明:**
>
> 预留接口,将在后续版本提供。
### missionIDsLen
......@@ -66,6 +73,10 @@ int32_t OH_VideoCaptureInfo::missionIDsLen
指定窗口ID长度,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。
> **说明:**
>
> 预留接口,将在后续版本提供。
### videoFrameHeight
......
......@@ -5,6 +5,10 @@
视频编码参数。
> **说明:**
>
> 预留接口,将在后续版本提供。
**系统能力**:SystemCapability.Multimedia.Media.AVScreenCapture
**起始版本:**
......
......@@ -24,7 +24,7 @@
| 名称 | 描述 |
| -------- | -------- |
| [videoCapInfo](#videocapinfo) | [OH_VideoCaptureInfo](_o_h___video_capture_info.md)<br/>视频采集信息。 |
| [videoEncInfo](#videoencinfo) | [OH_VideoEncInfo](_o_h___video_enc_info.md)<br/>视频编码参数。 |
| [videoEncInfo](#videoencinfo) | [OH_VideoEncInfo](_o_h___video_enc_info.md)<br/>视频编码参数。 <br>**说明:** 预留接口,将在后续版本提供。|
## 结构体成员变量说明
......@@ -50,3 +50,7 @@ OH_VideoEncInfo OH_VideoInfo::videoEncInfo
**描述:**
视频编码参数。
> **说明:**
>
> 预留接口,将在后续版本提供。
......@@ -25,8 +25,8 @@
| [OH_AVScreenCapture_Init](_a_v_screen_capture.md#oh_avscreencapture_init) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture, [OH_AVScreenCaptureConfig](_o_h___a_v_screen_capture_config.md) config) | 初始化OH_AVScreenCapture相关参数。 |
| [OH_AVScreenCapture_StartScreenCapture](_a_v_screen_capture.md#oh_avscreencapture_startscreencapture) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture) | 开始录屏,调用后可以通过回调的监听(OH_AVScreenCaptureOnAudioBufferAvailable,OH_AVScreenCaptureOnVideoBufferAvailable)来监听当前是否有码流的产生。 |
| [OH_AVScreenCapture_StopScreenCapture](_a_v_screen_capture.md#oh_avscreencapture_stopscreencapture) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture) | 结束录屏,调用后针对调用该接口的应用会停止录屏或屏幕共享,释放麦克风。 |
| [OH_AVScreenCapture_StartScreenRecording](_a_v_screen_capture.md#oh_avscreencapture_startscreenrecording) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture) | 启动录屏。 |
| [OH_AVScreenCapture_StopScreenRecording](_a_v_screen_capture.md#oh_avscreencapture_stopscreenrecording) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture) | 停止录屏。 |
| [OH_AVScreenCapture_StartScreenRecording](_a_v_screen_capture.md#oh_avscreencapture_startscreenrecording) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture) | 启动录屏。<br>**说明:** 预留接口,将在后续版本提供。 |
| [OH_AVScreenCapture_StopScreenRecording](_a_v_screen_capture.md#oh_avscreencapture_stopscreenrecording) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture) | 停止录屏。<br>**说明:** 预留接口,将在后续版本提供。 |
| [OH_AVScreenCapture_AcquireAudioBuffer](_a_v_screen_capture.md#oh_avscreencapture_acquireaudiobuffer) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture, [OH_AudioBuffer](_o_h___audio_buffer.md) \*\*audiobuffer, [OH_AudioCaptureSourceType](_a_v_screen_capture.md#oh_audiocapturesourcetype) type) | 获取音频buffer,应用在调用时,需要对audiobuffer分配对应结构体大小的内存,否则会影响拿到音频buffer的获取。 |
| [OH_AVScreenCapture_AcquireVideoBuffer](_a_v_screen_capture.md#oh_avscreencapture_acquirevideobuffer) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture, int32_t \*fence, int64_t \*timestamp, struct [OH_Rect](_o_h___rect.md) \*region) | 获取视频buffer,应用在调用时,通过此接口来获取到视频的buffer以及时间戳等信息。 |
| [OH_AVScreenCapture_ReleaseAudioBuffer](_a_v_screen_capture.md#oh_avscreencapture_releaseaudiobuffer) (struct [OH_AVScreenCapture](_a_v_screen_capture.md#oh_avscreencapture) \*capture, [OH_AudioCaptureSourceType](_a_v_screen_capture.md#oh_audiocapturesourcetype) type) | 根据音频类型释放buffer。 |
......
......@@ -22,10 +22,10 @@
| 名称 | 描述 |
| -------- | -------- |
| [OH_AudioCaptureInfo](_o_h___audio_capture_info.md) | 音频录制信息。 |
| [OH_AudioEncInfo](_o_h___audio_enc_info.md) | 音频编码信息。 |
| [OH_AudioEncInfo](_o_h___audio_enc_info.md) | 音频编码信息。<br>**说明:** 预留接口,将在后续版本提供。 |
| [OH_AudioInfo](_o_h___audio_info.md) | 音频录制参数。 |
| [OH_VideoCaptureInfo](_o_h___video_capture_info.md) | 视频采集信息。 |
| [OH_VideoEncInfo](_o_h___video_enc_info.md) | 视频编码参数。 |
| [OH_VideoEncInfo](_o_h___video_enc_info.md) | 视频编码信息。<br>**说明:** 预留接口,将在后续版本提供。 |
| [OH_VideoInfo](_o_h___video_info.md) | 视频录制参数。 |
| [OH_RecorderInfo](_o_h___recorder_info.md) | 录制文件信息。 |
| [OH_AVScreenCaptureConfig](_o_h___a_v_screen_capture_config.md) | 屏幕录制配置参数。 |
......@@ -48,10 +48,10 @@
| [OH_VideoSourceType](_a_v_screen_capture.md#oh_videosourcetype) | 枚举,表示视频源格式。 |
| [OH_ContainerFormatType](_a_v_screen_capture.md#oh_containerformattype) | 枚举,表示屏幕录制生成的文件类型。 |
| [OH_AudioCaptureInfo](_a_v_screen_capture.md#oh_audiocaptureinfo) | 音频录制信息。 |
| [OH_AudioEncInfo](_a_v_screen_capture.md#oh_audioencinfo) | 音频编码信息。 |
| [OH_AudioEncInfo](_a_v_screen_capture.md#oh_audioencinfo) | 音频编码信息。<br>**说明:** 预留接口,将在后续版本提供。 |
| [OH_AudioInfo](_a_v_screen_capture.md#oh_audioinfo) | 音频录制参数。 |
| [OH_VideoCaptureInfo](_a_v_screen_capture.md#oh_videocaptureinfo) | 视频采集信息。 |
| [OH_VideoEncInfo](_a_v_screen_capture.md#oh_videoencinfo) | 视频编码参数。 |
| [OH_VideoEncInfo](_a_v_screen_capture.md#oh_videoencinfo) | 视频编码信息。 <br>**说明:** 预留接口,将在后续版本提供。|
| [OH_VideoInfo](_a_v_screen_capture.md#oh_videoinfo) | 视频录制参数。 |
| [OH_RecorderInfo](_a_v_screen_capture.md#oh_recorderinfo) | 录制文件信息。 |
| [OH_AVScreenCaptureConfig](_a_v_screen_capture.md#oh_avscreencaptureconfig) | 屏幕录制配置参数。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册