提交 14f51e5c 编写于 作者: W wangzx0705

modify the doc format problem

Signed-off-by: Nwangzx0705 <wangzx0705@thundersoft.com>
上级 f84ef370
...@@ -34,7 +34,7 @@ AVScreenCapture模块提供用于屏幕录制的函数。 ...@@ -34,7 +34,7 @@ AVScreenCapture模块提供用于屏幕录制的函数。
| \*[OH_AVScreenCapture_AcquireVideoBuffer](#oh_avscreencapture_acquirevideobuffer) (OH_AVScreenCapture \*capture, int32_t \*fence, int64_t \*timestamp, struct OH_Rect \*region) | 获取视频原始码流接口,通过此接口可以获取视频码流以及每帧视频的信息 | | \*[OH_AVScreenCapture_AcquireVideoBuffer](#oh_avscreencapture_acquirevideobuffer) (OH_AVScreenCapture \*capture, int32_t \*fence, int64_t \*timestamp, struct OH_Rect \*region) | 获取视频原始码流接口,通过此接口可以获取视频码流以及每帧视频的信息 |
| [OH_AVScreenCapture_ReleaseAudioBuffer](#oh_avscreencapture_releaseaudiobuffer) (OH_AVScreenCapture \*capture, OH_AudioCaptureSourceType type) | 释放根据音频类型释放音频buffer,用于用完的音频的buffer的释放 | | [OH_AVScreenCapture_ReleaseAudioBuffer](#oh_avscreencapture_releaseaudiobuffer) (OH_AVScreenCapture \*capture, OH_AudioCaptureSourceType type) | 释放根据音频类型释放音频buffer,用于用完的音频的buffer的释放 |
| [OH_AVScreenCapture_ReleaseVideoBuffer](#oh_avscreencapture_releasevideobuffer) (OH_AVScreenCapture \*capture) | 释放视频的buffer,用于用完的视频的buffer的释放 | | [OH_AVScreenCapture_ReleaseVideoBuffer](#oh_avscreencapture_releasevideobuffer) (OH_AVScreenCapture \*capture) | 释放视频的buffer,用于用完的视频的buffer的释放 |
| [OH_AVScreenCapture_SetCallback](#oh_acscreencapture_setcallback) (OH_AVScreenCapture \*capture, OH_AVScreenCaptureCallback callback) | 设置回调的接口,用于回调相关事件的监听 | | [OH_AVScreenCapture_SetCallback](#oh_avscreencapture_setcallback) (OH_AVScreenCapture \*capture, OH_AVScreenCaptureCallback callback) | 设置回调的接口,用于回调相关事件的监听 |
| [OH_AVScreenCapture_SetMicrophoneEnabled](#oh_avscreencapture_setmicrophoneenabled) (OH_AVScreenCapture \*capture, bool isMicrophone) | 设置麦克风开关,关闭时,将获得无声的音频数据 | | [OH_AVScreenCapture_SetMicrophoneEnabled](#oh_avscreencapture_setmicrophoneenabled) (OH_AVScreenCapture \*capture, bool isMicrophone) | 设置麦克风开关,关闭时,将获得无声的音频数据 |
| [OH_AVScreenCapture_Release](#oh_avscreencapture_release) (OH_AVScreenCapture \*capture) | 用于录屏实例对象的释放 | | [OH_AVScreenCapture_Release](#oh_avscreencapture_release) (OH_AVScreenCapture \*capture) | 用于录屏实例对象的释放 |
...@@ -92,7 +92,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_Init(struct OH_AVScreenCapture *c ...@@ -92,7 +92,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_Init(struct OH_AVScreenCapture *c
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
...@@ -121,18 +121,18 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StartScreenCapture(struct OH_AVSc ...@@ -121,18 +121,18 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StartScreenCapture(struct OH_AVSc
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
10 10
### OH_AVScreenCapture_StopScreenRecording() ### OH_AVScreenCapture_StopScreenCapture()
``` ```
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StopScreenRecording(struct OH_AVScreenCapture *capture); OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StopScreenCapture(struct OH_AVScreenCapture *capture);
``` ```
**描述:** **描述:**
...@@ -149,7 +149,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StopScreenRecording(struct OH_AVS ...@@ -149,7 +149,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StopScreenRecording(struct OH_AVS
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
...@@ -181,7 +181,7 @@ buffer使用完成后,调用OH_AVScreenCapture_ReleaseAudioBuffer接口进行 ...@@ -181,7 +181,7 @@ buffer使用完成后,调用OH_AVScreenCapture_ReleaseAudioBuffer接口进行
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
...@@ -243,7 +243,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ReleaseAudioBuffer(struct OH_AVSc ...@@ -243,7 +243,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ReleaseAudioBuffer(struct OH_AVSc
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
...@@ -271,7 +271,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ReleaseVideoBuffer(struct OH_AVSc ...@@ -271,7 +271,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ReleaseVideoBuffer(struct OH_AVSc
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
...@@ -300,7 +300,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetCallback(struct OH_AVScreenCap ...@@ -300,7 +300,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetCallback(struct OH_AVScreenCap
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
...@@ -329,7 +329,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetMicrophoneEnabled(struct OH_AV ...@@ -329,7 +329,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetMicrophoneEnabled(struct OH_AV
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
...@@ -357,7 +357,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_Release(struct OH_AVScreenCapture ...@@ -357,7 +357,7 @@ OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_Release(struct OH_AVScreenCapture
**返回:** **返回:**
执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](_core.md#native__avscreen_capture_errors_8h.md) 执行成功返回AV_SCREEN_CAPTURE_ERR_OK, 否则返回具体错误码,请参阅[OH_AVSCREEN_CAPTURE_ErrCode](native__avscreen_capture_errors_8h.md#oh_avscreen_capture_errcode)
**起始版本:** **起始版本:**
......
...@@ -24,7 +24,6 @@ AVScreenCaptureBase模块提供运行录屏通用的结构体、字符常量、 ...@@ -24,7 +24,6 @@ AVScreenCaptureBase模块提供运行录屏通用的结构体、字符常量、
| [OH_VideoCaptureInfo](#oh_videocaptureinfo) | 定义屏幕录制中视频录制采集的描述信息。 | | [OH_VideoCaptureInfo](#oh_videocaptureinfo) | 定义屏幕录制中视频录制采集的描述信息。 |
| [OH_VideoEncInfo](#oh_videoencinfo) | 定义屏幕录制中视频的编码数据描述信息。 | | [OH_VideoEncInfo](#oh_videoencinfo) | 定义屏幕录制中视频的编码数据描述信息。 |
| [OH_VideoInfo](#oh_videoinfo) | 定义屏幕录制时视频的描述信息。 | | [OH_VideoInfo](#oh_videoinfo) | 定义屏幕录制时视频的描述信息。 |
| [OH_RecorderInfo](#oh_recorderinfo) | 定义屏幕录制保存音视频文件的参数描述信息。 |
| [OH_AVScreenCaptureConfig](#oh_avscreencaptureconfig) | 定义整体avscreencapture的配置信息。 | | [OH_AVScreenCaptureConfig](#oh_avscreencaptureconfig) | 定义整体avscreencapture的配置信息。 |
| [OH_AVScreenCaptureCallback](_a_v_screen_capture_callback.md) | 定义avscreencapture的回调信息,包含不同的回调函数类型。 | | [OH_AVScreenCaptureCallback](_a_v_screen_capture_callback.md) | 定义avscreencapture的回调信息,包含不同的回调函数类型。 |
| [OH_Rect](#oh_rect) | 定义录屏的宽高以及画面信息。 | | [OH_Rect](#oh_rect) | 定义录屏的宽高以及画面信息。 |
...@@ -56,12 +55,12 @@ AVScreenCaptureBase模块提供运行录屏通用的结构体、字符常量、 ...@@ -56,12 +55,12 @@ AVScreenCaptureBase模块提供运行录屏通用的结构体、字符常量、
| [OH_AudioCaptureInfo::audioSampleRate](#audiosamplerate) | 录屏音频采样率, 支持列表见[OH_AudioCapturer_GetSamplingRate](#_o_h_audio.md#oh_audiocapturer_getsamplingrate)。 | | [OH_AudioCaptureInfo::audioSampleRate](#audiosamplerate) | 录屏音频采样率, 支持列表见[OH_AudioCapturer_GetSamplingRate](#_o_h_audio.md#oh_audiocapturer_getsamplingrate)。 |
| [OH_AudioCaptureInfo::audioChannels](#audiochannels) | 录屏音频声道数。 | | [OH_AudioCaptureInfo::audioChannels](#audiochannels) | 录屏音频声道数。 |
| [OH_AudioCaptureInfo::audioSource](#audiosource) | 录屏音频的source源,如麦克风或者内录。 | | [OH_AudioCaptureInfo::audioSource](#audiosource) | 录屏音频的source源,如麦克风或者内录。 |
| [OH_AudioEncInfo::audioBitrate](#audioBitrate) | 录制音频的比特率,用于编码相关参数的设置。 | | [OH_AudioEncInfo::audioBitrate](#audiobitrate) | 录制音频的比特率,用于编码相关参数的设置。 |
| [OH_AudioEncInfo::audioCodecformat](#audiocodecformat) | 录制音频的编码格式。 | | [OH_AudioEncInfo::audioCodecformat](#audiocodecformat) | 录制音频的编码格式。 |
| [OH_AudioInfo::micCapInfo](#miccapinfo) | 录制的mic的音频参数设置,设置类型为OH_AudioCaptureInfo。 | | [OH_AudioInfo::micCapInfo](#miccapinfo) | 录制的mic的音频参数设置,设置类型为OH_AudioCaptureInfo。 |
| [OH_AudioInfo::innerCapInfo](#innercapinfo) | 录制的内录的音频参数设置,设置类型为OH_AudioCaptureInfo。 | | [OH_AudioInfo::innerCapInfo](#innercapinfo) | 录制的内录的音频参数设置,设置类型为OH_AudioCaptureInfo。 |
| [OH_AudioInfo::audioEncInfo](#audioencinfo) | 录制音频编码的相关参数,设置类型为OH_AudioEncInfo。 | | [OH_AudioInfo::audioEncInfo](#audioencinfo) | 录制音频编码的相关参数,设置类型为OH_AudioEncInfo。 |
| [OH_VideoCaptureInfo::displayId](#displayId) | 录制物理屏id,使用该参数需要在capturemode为CAPTURE_SPECIFIED_SCREEN模式下使用。 | | [OH_VideoCaptureInfo::displayId](#displayid) | 录制物理屏id,使用该参数需要在capturemode为CAPTURE_SPECIFIED_SCREEN模式下使用。 |
| [OH_VideoCaptureInfo::missionIDs](#missionids) | 指定窗口id列表,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。 | | [OH_VideoCaptureInfo::missionIDs](#missionids) | 指定窗口id列表,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。 |
| [OH_VideoCaptureInfo::missionIDsLen](#missionidslen) | 指定窗口的,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。 | | [OH_VideoCaptureInfo::missionIDsLen](#missionidslen) | 指定窗口的,使用该参数需要在capturemode为CAPTURE_SPECIFIED_WINDOW模式下使用。 |
| [OH_VideoCaptureInfo::videoFrameWidth](#videoframewidth) | 采集视频的宽度设置。 | | [OH_VideoCaptureInfo::videoFrameWidth](#videoframewidth) | 采集视频的宽度设置。 |
...@@ -72,14 +71,10 @@ AVScreenCaptureBase模块提供运行录屏通用的结构体、字符常量、 ...@@ -72,14 +71,10 @@ AVScreenCaptureBase模块提供运行录屏通用的结构体、字符常量、
| [OH_VideoEncInfo::videoFrameRate](#videoframerate) | 视频采集帧率。 | | [OH_VideoEncInfo::videoFrameRate](#videoframerate) | 视频采集帧率。 |
| [OH_VideoInfo::videoCapInfo](#videocapinfo) | 视频采集信息的设置,设置类型为OH_VideoCaptureInfo。 | | [OH_VideoInfo::videoCapInfo](#videocapinfo) | 视频采集信息的设置,设置类型为OH_VideoCaptureInfo。 |
| [OH_VideoInfo::videoEncInfo](#videoencinfo) | 视频编码参数的设置,设置类型为OH_VideoEncInfo。 | | [OH_VideoInfo::videoEncInfo](#videoencinfo) | 视频编码参数的设置,设置类型为OH_VideoEncInfo。 |
| [OH_RecorderInfo::\*url](#*\url) | 录屏生成文件路径设置。 |
| [OH_RecorderInfo::urlLen](#urllen) | 录屏生成文件路径字符的长度。 |
| [OH_RecorderInfo::fileFormat](#fileformat) | 录屏生成文件格式设置,如mp4格式。 |
| [OH_AVScreenCaptureConfig::captureMode](#capturemode) | 屏幕录制方式,如全屏录制,指定物理屏录制或者指定窗口录制。 | | [OH_AVScreenCaptureConfig::captureMode](#capturemode) | 屏幕录制方式,如全屏录制,指定物理屏录制或者指定窗口录制。 |
| [OH_AVScreenCaptureConfig::dataType](#datatype) | 屏幕录制的形式,比如录制原始码流,编码后码流还是文件。 | | [OH_AVScreenCaptureConfig::dataType](#datatype) | 屏幕录制的形式,比如录制原始码流,编码后码流还是文件。 |
| [OH_AVScreenCaptureConfig::audioInfo](#audioinfo) | 录制音频相关参数设置,类型为OH_AudioInfo。 | | [OH_AVScreenCaptureConfig::audioInfo](#audioinfo) | 录制音频相关参数设置,类型为OH_AudioInfo。 |
| [OH_AVScreenCaptureConfig::videoInfo](#videoinfo) | 录制视频相关参数设置,类型为OH_VideoInfo。 | | [OH_AVScreenCaptureConfig::videoInfo](#videoinfo) | 录制视频相关参数设置,类型为OH_VideoInfo。 |
| [OH_AVScreenCaptureConfig::recorderInfo](#recorderinfo) | 录屏生成文件相关参数设置,类型为OH_RecorderInfo。 |
| [OH_AVScreenCaptureCallback::onError](_a_v_screen_capture_callback.md#onerror) | 录屏过程中错误事件的监听函数。 | | [OH_AVScreenCaptureCallback::onError](_a_v_screen_capture_callback.md#onerror) | 录屏过程中错误事件的监听函数。 |
| [OH_AVScreenCaptureCallback::onAudioBufferAvailable](_a_v_screen_capture_callback.md#onaudiobufferavailable) | 录屏过程中音频流产生的监听。 | | [OH_AVScreenCaptureCallback::onAudioBufferAvailable](_a_v_screen_capture_callback.md#onaudiobufferavailable) | 录屏过程中音频流产生的监听。 |
| [OH_AVScreenCaptureCallback::onVideoBufferAvailable](_a_v_screen_capture_callback.md#onvideobufferavailable) | 录屏过程中视频流产生的监听。 | | [OH_AVScreenCaptureCallback::onVideoBufferAvailable](_a_v_screen_capture_callback.md#onvideobufferavailable) | 录屏过程中视频流产生的监听。 |
...@@ -87,7 +82,7 @@ AVScreenCaptureBase模块提供运行录屏通用的结构体、字符常量、 ...@@ -87,7 +82,7 @@ AVScreenCaptureBase模块提供运行录屏通用的结构体、字符常量、
| [OH_Rect::y](#y) | 视频数据的y坐标。 | | [OH_Rect::y](#y) | 视频数据的y坐标。 |
| [OH_Rect::width](#width) | 视频宽度。 | | [OH_Rect::width](#width) | 视频宽度。 |
| [OH_Rect::height](#height) | 视频高度。 | | [OH_Rect::height](#height) | 视频高度。 |
| [OH_AudioBuffer::\*buf](#buf) | 存放音频数据。 | | [OH_AudioBuffer::buf](#buf) | 存放音频数据。 |
| [OH_AudioBuffer::size](#size) | 存放音频每一帧数据的长度。 | | [OH_AudioBuffer::size](#size) | 存放音频每一帧数据的长度。 |
| [OH_AudioBuffer::timestamp](#timestamp) | 音频的时间戳。 | | [OH_AudioBuffer::timestamp](#timestamp) | 音频的时间戳。 |
| [OH_AudioBuffer::type](#type) | 音频数据源类型,比如内录源还是mic。 | | [OH_AudioBuffer::type](#type) | 音频数据源类型,比如内录源还是mic。 |
...@@ -114,9 +109,9 @@ typedef struct OH_AudioCaptureInfo OH_AudioCaptureInfo ...@@ -114,9 +109,9 @@ typedef struct OH_AudioCaptureInfo OH_AudioCaptureInfo
### 成员变量 ### 成员变量
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | ----------------------------------- | ----------------------------------- |
| [audioSampleRate](#audiosampleratets) | 录屏音频采样率。 | | [audioSampleRate](#audiosamplerate) | 录屏音频采样率。 |
| [audioSampleRate;](#audichannels) | 录制音频的声道数。 | | [audioChannels](#audiochannels) | 录制音频的声道数。 |
| [audioSource](#audiosource) | 录屏音频的source源,如麦克风或者内录。 | | [audioSource](#audiosource) | 录屏音频的source源,如麦克风或者内录。 |
## 结构体成员变量说明 ## 结构体成员变量说明
...@@ -189,8 +184,8 @@ typedef struct OH_AudioCaptureInfo OH_AudioCaptureInfo ...@@ -189,8 +184,8 @@ typedef struct OH_AudioCaptureInfo OH_AudioCaptureInfo
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [audioBitrate](#audioBitrate) | 录屏音频比特率。 | | [audioBitrate](#audiobitrate) | 录屏音频比特率。 |
| [audioCodecformat](#audioCodecformat) | 录屏音频编码格式。 | | [audioCodecformat](#audiocodecformat) | 录屏音频编码格式。 |
## 结构体成员变量说明 ## 结构体成员变量说明
...@@ -245,9 +240,9 @@ typedef struct OH_AudioInfo ...@@ -245,9 +240,9 @@ typedef struct OH_AudioInfo
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [micCapInfo](#micCapInfo) | 麦克风录制信息。 | | [micCapInfo](#miccapinfo) | 麦克风录制信息。 |
| [innerCapInfo](#innerCapInfo) | 内录录制信息。 | | [innerCapInfo](#innercapinfo) | 内录录制信息。 |
| [audioEncInfo](#audioEncInfo) | 音频编码信息。 | | [audioEncInfo](#audioencinfo) | 音频编码信息。 |
## 结构体成员变量说明 ## 结构体成员变量说明
...@@ -314,12 +309,12 @@ typedef struct OH_VideoCaptureInfo OH_VideoCaptureInfo ...@@ -314,12 +309,12 @@ typedef struct OH_VideoCaptureInfo OH_VideoCaptureInfo
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [displayId](#displayId) | 录屏显示id。 | | [displayId](#displayid) | 录屏显示id。 |
| [\*missionIDs](#\*missionIDs) | 录屏任务id。 | | [missionIDs](#missionids) | 录屏任务id。 |
| [missionIDsLen](#missionIDsLen) | 录屏任务id长度。 | | [missionIDsLen](#missionidslen) | 录屏任务id长度。 |
| [videoFrameWidth](#videoFrameWidth) | 录屏视频帧宽。 | | [videoFrameWidth](#videoframewidth) | 录屏视频帧宽。 |
| [videoFrameHeight](#videoFrameHeight) | 录屏视频帧高。 | | [videoFrameHeight](#videoframeheight) | 录屏视频帧高。 |
| [videoSource](#videoSource) | 录屏视频数据源。 | | [videoSource](#videosource) | 录屏视频数据源。 |
## 结构体成员变量说明 ## 结构体成员变量说明
...@@ -338,7 +333,7 @@ uint64_t displayId ...@@ -338,7 +333,7 @@ uint64_t displayId
10 10
### \*missionIDs ### missionIDs
``` ```
...@@ -428,9 +423,9 @@ typedef struct OH_VideoEncInfo OH_VideoEncInfo ...@@ -428,9 +423,9 @@ typedef struct OH_VideoEncInfo OH_VideoEncInfo
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [videoCodec](#videoCodec) | 视频数据编码信息。 | | [videoCodec](#videocodec) | 视频数据编码信息。 |
| [videoBitrate](#videoBitrate) | 视频数据比特率信息。 | | [videoBitrate](#videobitrate) | 视频数据比特率信息。 |
| [videoFrameRate](#videoFrameRate) | 视频数据帧率参数。 | | [videoFrameRate](#videoframerate) | 视频数据帧率参数。 |
## 结构体成员变量说明 ## 结构体成员变量说明
...@@ -498,8 +493,8 @@ typedef struct OH_VideoInfo OH_VideoInfo ...@@ -498,8 +493,8 @@ typedef struct OH_VideoInfo OH_VideoInfo
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [videoCapInfo](#videoCapInfo) | 视频数据编码信息。 | | [videoCapInfo](#videocapinfo) | 视频数据编码信息。 |
| [videoEncInfo](#videoEncInfo) | 视频数据比特率信息。 | | [videoEncInfo](#videoencinfo) | 视频数据比特率信息。 |
## 结构体成员变量说明 ## 结构体成员变量说明
...@@ -532,60 +527,6 @@ OH_VideoEncInfo videoEncInfo ...@@ -532,60 +527,6 @@ OH_VideoEncInfo videoEncInfo
10 10
# OH_RecorderInfo
```
typedef struct OH_RecorderInfo OH_RecorderInfo
```
## 概述
定义屏幕录制保存音视频文件的参数描述信息。
\@syscap SystemCapability.Multimedia.Media.AVScreenCapture
**起始版本:**
10
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [\*url](#\*url) | 视频数据编码信息。 |
| [urlLen](#urlLen) | 视频数据比特率信息。 |
## 结构体成员变量说明
### \*url
```
char *url
```
**描述:**
录屏生成文件路径设置。
**起始版本:**
10
### urlLen
```
uint32_t urlLen;
```
**描述:**
录屏生成文件路径字符的长度。
**起始版本:**
10
# OH_AVScreenCaptureConfig # OH_AVScreenCaptureConfig
``` ```
...@@ -606,11 +547,10 @@ typedef struct OH_AVScreenCaptureConfig OH_AVScreenCaptureConfig ...@@ -606,11 +547,10 @@ typedef struct OH_AVScreenCaptureConfig OH_AVScreenCaptureConfig
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [captureMode](#captureMode) | 屏幕录制方式,如全屏录制,指定物理屏录制或者指定窗口录制。 | | [captureMode](#capturemode) | 屏幕录制方式,如全屏录制,指定物理屏录制或者指定窗口录制。 |
| [dataType](#dataType) | 屏幕录制的形式,比如录制原始码流,编码后码流还是文件。 | | [dataType](#datatype) | 屏幕录制的形式,比如录制原始码流,编码后码流还是文件。 |
| [audioInfo](#audioInfo) | 录制音频相关参数设置,类型为OH_AudioInfo。 | | [audioInfo](#audioinfo) | 录制音频相关参数设置,类型为OH_AudioInfo。 |
| [videoInfo](#videoInfo) | 录制视频相关参数设置,类型为OH_VideoInfo。 | | [videoInfo](#videoinfo) | 录制视频相关参数设置,类型为OH_VideoInfo。 |
| [recorderInfo](#recorderInfo) | 录屏生成文件相关参数设置,类型为OH_RecorderInfo。 |
## 结构体成员变量说明 ## 结构体成员变量说明
...@@ -672,20 +612,6 @@ OH_VideoInfo videoInfo ...@@ -672,20 +612,6 @@ OH_VideoInfo videoInfo
10 10
### recorderInfo
```
OH_RecorderInfo recorderInfo
```
**描述:**
录屏生成文件相关参数设置,类型为OH_RecorderInfo。
**起始版本:**
10
# OH_AVScreenCaptureCallback # OH_AVScreenCaptureCallback
``` ```
...@@ -706,9 +632,9 @@ typedef struct OH_AVScreenCaptureCallback OH_AVScreenCaptureCallback ...@@ -706,9 +632,9 @@ typedef struct OH_AVScreenCaptureCallback OH_AVScreenCaptureCallback
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [onError](#onError) | 录屏过程中错误事件的监听函数。 | | [onError](#onerror) | 录屏过程中错误事件的监听函数。 |
| [onAudioBufferAvailable](#onAudioBufferAvailable) | 录屏过程中音频流产生的监听。 | | [onAudioBufferAvailable](#onaudiobufferavailable) | 录屏过程中音频流产生的监听。 |
| [onVideoBufferAvailable](#onVideoBufferAvailable) | 录屏过程中视频流产生的监听。 | | [onVideoBufferAvailable](#onvideobufferavailable) | 录屏过程中视频流产生的监听。 |
## 结构体成员变量说明 ## 结构体成员变量说明
...@@ -859,7 +785,7 @@ typedef struct OH_AudioBuffer OH_AudioBuffer ...@@ -859,7 +785,7 @@ typedef struct OH_AudioBuffer OH_AudioBuffer
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| [\*buf](#\*buf) | 存放音频数据。 | | [buf](#buf) | 存放音频数据。 |
| [size](#size) | 存放音频每一帧数据的长度。 | | [size](#size) | 存放音频每一帧数据的长度。 |
| [timestamp](#timestamp) | 音频的时间戳。 | | [timestamp](#timestamp) | 音频的时间戳。 |
| [type](#type) | 音频数据源类型,比如内录源还是mic。 | | [type](#type) | 音频数据源类型,比如内录源还是mic。 |
...@@ -867,7 +793,7 @@ typedef struct OH_AudioBuffer OH_AudioBuffer ...@@ -867,7 +793,7 @@ typedef struct OH_AudioBuffer OH_AudioBuffer
## 结构体成员变量说明 ## 结构体成员变量说明
### \*buf ### buf
``` ```
......
...@@ -26,13 +26,10 @@ ...@@ -26,13 +26,10 @@
| [OH_AVScreenCapture_Init](_a_v_screen_capture.md#oh_avscreencapture_init) (struct OH_AVScreenCapture \*capture, OH_AVScreenCaptureConfig config) | 根据config配置初始化一个capture对象。 | | [OH_AVScreenCapture_Init](_a_v_screen_capture.md#oh_avscreencapture_init) (struct OH_AVScreenCapture \*capture, OH_AVScreenCaptureConfig config) | 根据config配置初始化一个capture对象。 |
| [OH_AVScreenCapture_StartScreenCapture](_a_v_screen_capture.md#oh_avscreencapture_startscreencapture) (struct OH_AVScreenCapture \*capture) | 启动屏幕录制。 | | [OH_AVScreenCapture_StartScreenCapture](_a_v_screen_capture.md#oh_avscreencapture_startscreencapture) (struct OH_AVScreenCapture \*capture) | 启动屏幕录制。 |
| [OH_AVScreenCapture_StopScreenCapture](_a_v_screen_capture.md#oh_avscreencapture_stopscreencapture) (struct OH_AVScreenCapture \*capture) | 停止屏幕录制。 | | [OH_AVScreenCapture_StopScreenCapture](_a_v_screen_capture.md#oh_avscreencapture_stopscreencapture) (struct OH_AVScreenCapture \*capture) | 停止屏幕录制。 |
| [OH_AVScreenCapture_StartScreenRecording](_a_v_screen_capture.md#oh_avscreencapture_startscreenrecording) (struct OH_AVScreenCapture \*capture) | 调用启动屏幕录制之后,调用该接口进行屏幕画面的录制。 |
| [OH_AVScreenCapture_StopScreenRecording](_a_v_screen_capture.md#oh_avscreencapture_stopscreenrecording) (struct OH_AVScreenCapture \*capture) | 调用停止屏幕录制之后,调用该接口停止屏幕画面的录制。 |
| [OH_AVScreenCapture_AcquireAudioBuffer](_a_v_screen_capture.md#oh_avscreencapture_acquireaudiobuffer) (struct OH_AVScreenCapture \*capture, OH_AudioBuffer \*\*audiobuffer, OH_AudioCaptureSourceType type) | 调用开始录制接口后,调用该接口进行音频buffer的申请,获取音频buffer信息。 | | [OH_AVScreenCapture_AcquireAudioBuffer](_a_v_screen_capture.md#oh_avscreencapture_acquireaudiobuffer) (struct OH_AVScreenCapture \*capture, OH_AudioBuffer \*\*audiobuffer, OH_AudioCaptureSourceType type) | 调用开始录制接口后,调用该接口进行音频buffer的申请,获取音频buffer信息。 |
| [OH_AVScreenCapture_AcquireVideoBuffer](_a_v_screen_capture.md#oh_avscreencapture_acquirevideobuffer) (struct OH_AVScreenCapture \*capture, int32_t \*fence, int64_t \*timestamp, OH_Rect \*region) | 调用开始录制接口后,调用该接口进行视频buffer的申请,获取视频buffer信息。 | | [OH_AVScreenCapture_AcquireVideoBuffer](_a_v_screen_capture.md#oh_avscreencapture_acquirevideobuffer) (struct OH_AVScreenCapture \*capture, int32_t \*fence, int64_t \*timestamp, OH_Rect \*region) | 调用开始录制接口后,调用该接口进行视频buffer的申请,获取视频buffer信息。 |
| [OH_AVScreenCapture_ReleaseAudioBuffer](_a_v_screen_capture.md#oh_avscreencapture_releaseaudiobuffer) (struct OH_AVScreenCapture \*capture, | [OH_AVScreenCapture_ReleaseAudioBuffer](_a_v_screen_capture.md#oh_avscreencapture_releaseaudiobuffer) (struct OH_AVScreenCapture \*capture, OH_AudioCaptureSourceType type) | 调用接口释放指定screencapture实例中的音频数据。 |
OH_AudioCaptureSourceType type) | 停止录制后,调用接口释放指定screencapture实例中的音频数据。 | | [OH_AVScreenCapture_ReleaseVideoBuffer](_a_v_screen_capture.md#oh_avscreencapture_releasevideobuffer) (struct OH_AVScreenCapture \*capture) |调用接口释放指定screencapture实例中的视频数据。|
| [OH_AVScreenCapture_ReleaseVideoBuffer](_a_v_screen_capture.md#oh_avscreencapture_releasevideobuffer) (struct OH_AVScreenCapture \*capture) | | [OH_AVScreenCapture_SetCallback](_a_v_screen_capture.md#oh_avscreencapture_setcallback) (struct OH_AVScreenCapture \*capture, struct OH_AVScreenCaptureCallback callback) | 设置回调接口通过设置监听,可以监听到调用过程中的错误信息,以及是否有可用的视频buffer和音频buffer |
| [OH_AVScreenCapture_SetCallback](_a_v_screen_capture.md#oh_avscreencapture_setcallback) (struct OH_AVScreenCapture \*capture, struct OH_AVScreenCaptureCallback callback) | 停止录制后,调用接口释放指定screencapture实例中的视频数据。 |
| [OH_AVScreenCapture_Release](_a_v_screen_capture.md#oh_avscreencapture_release) (struct OH_AVScreenCapture \*capture) | 停止录制流程结束后,调用接口进行指定avscreencapture实例的释放。 | | [OH_AVScreenCapture_Release](_a_v_screen_capture.md#oh_avscreencapture_release) (struct OH_AVScreenCapture \*capture) | 停止录制流程结束后,调用接口进行指定avscreencapture实例的释放。 |
| [OH_AVScreenCapture_SetMicrophoneEnabled](_a_v_screen_capture.md#oh_avscreencapture_setmicrophoneenabled) (struct OH_AVScreenCapture \*capture, bool isMicrophone) | 设置麦克风在屏幕录制期间是否启用。 | | [OH_AVScreenCapture_SetMicrophoneEnabled](_a_v_screen_capture.md#oh_avscreencapture_setmicrophoneenabled) (struct OH_AVScreenCapture \*capture, bool isMicrophone) | 设置麦克风在屏幕录制期间是否启用。 |
\ No newline at end of file
...@@ -27,7 +27,6 @@ ...@@ -27,7 +27,6 @@
| [OH_VideoCaptureInfo](_a_v_screen_capture_base.md#oh_videocaptureinfo) | 定义屏幕录制中视频录制capture的描述信息。 | | [OH_VideoCaptureInfo](_a_v_screen_capture_base.md#oh_videocaptureinfo) | 定义屏幕录制中视频录制capture的描述信息。 |
| [OH_VideoEncInfo](_a_v_screen_capture_base.md#oh_videoencinfo) | 定义屏幕录制中视频的编码数据描述信息。 | | [OH_VideoEncInfo](_a_v_screen_capture_base.md#oh_videoencinfo) | 定义屏幕录制中视频的编码数据描述信息。 |
| [OH_VideoInfo](_a_v_screen_capture_base.md#oh_videoinfo) | 定义屏幕录制时视频的描述信息。 | | [OH_VideoInfo](_a_v_screen_capture_base.md#oh_videoinfo) | 定义屏幕录制时视频的描述信息。 |
| [OH_RecorderInfo](_a_v_screen_capture_base.md#oh_recorderinfo) | 定义屏幕录制保存音视频文件的参数描述信息。 |
| [OH_AVScreenCaptureConfig](_a_v_screen_capture_base.md#oh_avscreencaptureconfig) | 定义整体avscreencapture的配置信息。 | | [OH_AVScreenCaptureConfig](_a_v_screen_capture_base.md#oh_avscreencaptureconfig) | 定义整体avscreencapture的配置信息。 |
| [OH_AVScreenCaptureCallback](_a_v_screen_capture_callback.md) | 定义avscreencapture的回调信息,包含不同的回调函数类型。 | | [OH_AVScreenCaptureCallback](_a_v_screen_capture_callback.md) | 定义avscreencapture的回调信息,包含不同的回调函数类型。 |
| [OH_Rect](_a_v_screen_capture_base.md#oh_rect) | 定义录屏的宽高以及画面信息。 | | [OH_Rect](_a_v_screen_capture_base.md#oh_rect) | 定义录屏的宽高以及画面信息。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册