AVScreenCapture
概述
调用本模块下的接口，应用可以完成屏幕录制的功能。
开发者可根据实际的开发需求，参考对应的开发指南及样例：
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
汇总
文件
| 名称 | 描述 |
|---|---|
| native_avscreen_capture.h | 声明用于构造屏幕录制对象的API。 |
| native_avscreen_capture_base.h | 声明用于运行屏幕录制通用的结构体、字符常量、枚举。 |
| native_avscreen_capture_errors.h | 声明用于运行屏幕录制过程中接口调用的错误码说明。 |
结构体
| 名称 | 描述 |
|---|---|
| struct OH_AudioCaptureInfo | 音频采样信息。 |
| struct OH_AudioEncInfo | 音频编码信息。 |
| struct OH_AudioInfo | 音频信息。 |
| struct OH_VideoCaptureInfo | 视频录制信息。 |
| struct OH_VideoEncInfo | 视频编码信息。 |
| struct OH_VideoInfo | 视频信息。 |
| struct OH_RecorderInfo | 录制文件信息。 |
| struct OH_AVScreenCaptureConfig | 屏幕录制配置参数。 |
| struct OH_AVScreenCaptureCallback | OH_AVScreenCapture中所有异步回调函数指针的集合。 |
| struct OH_Rect | 定义录屏界面的宽高以及画面信息。 |
| struct OH_AudioBuffer | 定义了音频数据的大小，类型，时间戳等配置信息。 |
类型定义
| 名称 | 描述 |
|---|---|
| typedef struct OH_NativeBuffer OH_NativeBuffer | 提供录屏的视频原始码流类。 |
| typedef struct OH_AVScreenCapture OH_AVScreenCapture | 通过OH_AVScreenCapture可以获取视频与音频的原始码流。 |
| typedef struct OH_AVScreenCapture_ContentFilter OH_AVScreenCapture_ContentFilter | 通过OH_AVScreenCapture_ContentFilter过滤音视频内容。 |
| typedef enum OH_CaptureMode OH_CaptureMode | 枚举，表示屏幕录制的不同模式。 |
| typedef enum OH_AudioCaptureSourceType OH_AudioCaptureSourceType | 枚举，表示屏幕录制时的音频源类型。 |
| typedef enum OH_AudioCodecFormat OH_AudioCodecFormat | 枚举，表示音频编码格式。 |
| typedef enum OH_VideoCodecFormat OH_VideoCodecFormat | 枚举，表示视频编码格式。 |
| typedef enum OH_DataType OH_DataType | 枚举，表示屏幕录制流的数据格式。 |
| typedef enum OH_VideoSourceType OH_VideoSourceType | 枚举，表示视频源格式。当前仅支持RGBA格式。 |
| typedef enum OH_ContainerFormatType OH_ContainerFormatType | 枚举，表示屏幕录制生成的文件类型。 |
| typedef struct OH_AudioCaptureInfo OH_AudioCaptureInfo | 音频采样信息。 |
| typedef struct OH_AudioEncInfo OH_AudioEncInfo | 音频编码信息。 |
| typedef struct OH_AudioInfo OH_AudioInfo | 音频信息。 |
| typedef struct OH_VideoCaptureInfo OH_VideoCaptureInfo | 视频录制信息。 |
| typedef struct OH_VideoEncInfo OH_VideoEncInfo | 视频编码信息。 |
| typedef struct OH_VideoInfo OH_VideoInfo | 视频信息。 |
| typedef struct OH_RecorderInfo OH_RecorderInfo | 录制文件信息。 |
| typedef struct OH_AVScreenCaptureConfig OH_AVScreenCaptureConfig | 屏幕录制配置参数。 |
| typedef void(* OH_AVScreenCaptureOnError) (OH_AVScreenCapture *capture, int32_t errorCode) | 当OH_AVScreenCapture实例操作期间发生错误时，将调用函数指针。 |
| typedef void(* OH_AVScreenCaptureOnAudioBufferAvailable) (OH_AVScreenCapture *capture, bool isReady, OH_AudioCaptureSourceType type) | 当OH_AVScreenCapture操作期间音频缓存区可用时，将调用函数指针。 |
| typedef void(* OH_AVScreenCaptureOnVideoBufferAvailable) (OH_AVScreenCapture *capture, bool isReady) | 当OH_AVScreenCapture操作期间视频缓村区可用时，将调用函数指针。 |
| typedef struct OH_AVScreenCaptureCallback OH_AVScreenCaptureCallback | OH_AVScreenCapture中所有异步回调函数指针的集合。 |
| typedef struct OH_Rect OH_Rect | 定义录屏界面的宽高以及画面信息。 |
| typedef struct OH_AudioBuffer OH_AudioBuffer | 定义了音频数据的大小，类型，时间戳等配置信息。 |
| typedef enum OH_AVScreenCaptureStateCode OH_AVScreenCaptureStateCode | 枚举，表示状态码。 |
| typedef enum OH_AVScreenCaptureBufferType OH_AVScreenCaptureBufferType | 枚举，表示buffer类型。 |
| typedef enum OH_AVScreenCaptureFilterableAudioContent OH_AVScreenCaptureFilterableAudioContent | 枚举，表示可过滤的音频类型。 |
| typedef void(* OH_AVScreenCapture_OnStateChange) (struct OH_AVScreenCapture *capture, OH_AVScreenCaptureStateCode stateCode, void *userData) | 当OH_AVScreenCapture实例操作期间发生状态变更时，将调用函数指针。 |
| typedef void(* OH_AVScreenCapture_OnError) (OH_AVScreenCapture *capture, int32_t errorCode, void *userData) | 当OH_AVScreenCapture实例操作期间发生错误时，将调用函数指针。 |
| typedef void(* OH_AVScreenCapture_OnBufferAvailable) (OH_AVScreenCapture *capture, OH_AVBuffer *buffer, OH_AVScreenCaptureBufferType bufferType, int64_t timestamp, void *userData) | 当OH_AVScreenCapture实例操作期间音频或视频缓存区可用时，将调用该函数指针。 |
| typedef enum OH_AVSCREEN_CAPTURE_ErrCode OH_AVSCREEN_CAPTURE_ErrCode | 屏幕录制过程中产生的不同结果码。 |
| typedef void(* OH_AVScreenCapture_OnDisplaySelected) (OH_AVScreenCapture *capture, uint64_t displayId, void *userData) | 当录屏事件开始时，将调用函数指针。 |
枚举
| 名称 | 描述 |
|---|---|
| OH_CaptureMode { OH_CAPTURE_HOME_SCREEN = 0, OH_CAPTURE_SPECIFIED_SCREEN = 1, OH_CAPTURE_SPECIFIED_WINDOW = 2, OH_CAPTURE_INVAILD = -1 } |
枚举，表示屏幕录制的不同模式。 |
| OH_AudioCaptureSourceType { OH_SOURCE_INVALID = -1, OH_SOURCE_DEFAULT = 0, OH_MIC = 1, OH_ALL_PLAYBACK = 2, OH_APP_PLAYBACK = 3 } |
枚举，表示屏幕录制时的音频源类型。 |
| OH_AudioCodecFormat { OH_AUDIO_DEFAULT = 0, OH_AAC_LC = 3, OH_AUDIO_CODEC_FORMAT_BUTT } |
枚举，表示音频编码格式。 |
| 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 } |
枚举，表示视频编码格式。 |
| OH_DataType { OH_ORIGINAL_STREAM = 0, OH_ENCODED_STREAM = 1, OH_CAPTURE_FILE = 2, OH_INVAILD = -1 } |
枚举，表示屏幕录制流的数据格式。 |
| OH_VideoSourceType { OH_VIDEO_SOURCE_SURFACE_YUV = 0, OH_VIDEO_SOURCE_SURFACE_ES, OH_VIDEO_SOURCE_SURFACE_RGBA, OH_VIDEO_SOURCE_BUTT } |
枚举，表示视频源格式。当前仅支持RGBA格式。 |
| OH_ContainerFormatType { CFT_MPEG_4A = 0, CFT_MPEG_4 = 1 } |
枚举，表示屏幕录制生成的文件类型。 |
| OH_AVScreenCaptureStateCode { OH_SCREEN_CAPTURE_STATE_STARTED = 0, OH_SCREEN_CAPTURE_STATE_CANCELED = 1, OH_SCREEN_CAPTURE_STATE_STOPPED_BY_USER = 2, OH_SCREEN_CAPTURE_STATE_INTERRUPTED_BY_OTHER = 3, OH_SCREEN_CAPTURE_STATE_STOPPED_BY_CALL = 4, OH_SCREEN_CAPTURE_STATE_MIC_UNAVAILABLE = 5, OH_SCREEN_CAPTURE_STATE_MIC_MUTED_BY_USER = 6, OH_SCREEN_CAPTURE_STATE_MIC_UNMUTED_BY_USER = 7, OH_SCREEN_CAPTURE_STATE_ENTER_PRIVATE_SCENE = 8, OH_SCREEN_CAPTURE_STATE_EXIT_PRIVATE_SCENE = 9, OH_SCREEN_CAPTURE_STATE_STOPPED_BY_USER_SWITCHES = 10 } |
枚举，表示状态码。 |
| OH_AVScreenCaptureBufferType { OH_SCREEN_CAPTURE_BUFFERTYPE_VIDEO = 0, OH_SCREEN_CAPTURE_BUFFERTYPE_AUDIO_INNER = 1, OH_SCREEN_CAPTURE_BUFFERTYPE_AUDIO_MIC = 2 } |
枚举，表示buffer类型。 |
| OH_AVScreenCaptureFilterableAudioContent { OH_SCREEN_CAPTURE_NOTIFICATION_AUDIO = 0, OH_SCREEN_CAPTURE_CURRENT_APP_AUDIO = 1 } |
枚举，表示可过滤的音频类型。 |
| OH_AVSCREEN_CAPTURE_ErrCode { AV_SCREEN_CAPTURE_ERR_BASE = 0, AV_SCREEN_CAPTURE_ERR_OK = AV_SCREEN_CAPTURE_ERR_BASE, AV_SCREEN_CAPTURE_ERR_NO_MEMORY = AV_SCREEN_CAPTURE_ERR_BASE + 1, AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT = AV_SCREEN_CAPTURE_ERR_BASE + 2, AV_SCREEN_CAPTURE_ERR_INVALID_VAL = AV_SCREEN_CAPTURE_ERR_BASE + 3, AV_SCREEN_CAPTURE_ERR_IO = AV_SCREEN_CAPTURE_ERR_BASE + 4, AV_SCREEN_CAPTURE_ERR_TIMEOUT = AV_SCREEN_CAPTURE_ERR_BASE + 5, AV_SCREEN_CAPTURE_ERR_UNKNOWN = AV_SCREEN_CAPTURE_ERR_BASE + 6, AV_SCREEN_CAPTURE_ERR_SERVICE_DIED = AV_SCREEN_CAPTURE_ERR_BASE + 7, AV_SCREEN_CAPTURE_ERR_INVALID_STATE = AV_SCREEN_CAPTURE_ERR_BASE + 8, AV_SCREEN_CAPTURE_ERR_UNSUPPORT = AV_SCREEN_CAPTURE_ERR_BASE + 9, AV_SCREEN_CAPTURE_ERR_EXTEND_START = AV_SCREEN_CAPTURE_ERR_BASE + 100 } |
屏幕录制过程中产生的不同结果码。 |
函数
类型定义说明
OH_AudioBuffer
typedef struct OH_AudioBuffer OH_AudioBuffer
描述 定义音频数据的大小、类型和时间戳等配置信息。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AudioCaptureInfo
typedef struct OH_AudioCaptureInfo OH_AudioCaptureInfo
描述 音频采样信息。
当audioSampleRate和audioChannels同时为0时，忽略该类型音频相关参数，不录制该类型音频数据。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AudioCaptureSourceType
typedef enum OH_AudioCaptureSourceType OH_AudioCaptureSourceType
描述 枚举，表示屏幕录制时的音频源类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AudioCodecFormat
typedef enum OH_AudioCodecFormat OH_AudioCodecFormat
描述 枚举，表示音频编码格式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AudioEncInfo
typedef struct OH_AudioEncInfo OH_AudioEncInfo
描述 音频编码信息。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AudioInfo
typedef struct OH_AudioInfo OH_AudioInfo
描述 音频信息。
同时采集音频麦克风和音频内录数据时，两路音频的audioSampleRate和audioChannels采样参数需要相同。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AVSCREEN_CAPTURE_ErrCode
typedef enum OH_AVSCREEN_CAPTURE_ErrCode OH_AVSCREEN_CAPTURE_ErrCode
描述 屏幕录制过程中产生的不同结果码。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AVScreenCapture
typedef struct OH_AVScreenCaptureOH_AVScreenCapture
描述 通过OH_AVScreenCapture可以获取视频与音频的原始码流。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AVScreenCapture_ContentFilter
typedef struct OH_AVScreenCapture_ContentFilterOH_AVScreenCapture_ContentFilter
描述 通过OH_AVScreenCapture_ContentFilter过滤音视频内容。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
OH_AVScreenCapture_OnBufferAvailable
typedef void(* OH_AVScreenCapture_OnBufferAvailable) (OH_AVScreenCapture *capture, OH_AVBuffer *buffer, OH_AVScreenCaptureBufferType bufferType, int64_t timestamp, void *userData)
描述 当OH_AVScreenCapture实例操作期间音频或视频缓存区可用时，将调用该函数指针。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| buffer | 指向OH_AVBuffer缓存区实例的指针，该回调方法执行结束返回后，数据缓存区不再有效。 |
| bufferType | 可用缓冲区的数据类型。 |
| timestamp | 时间戳, 单位纳秒。 |
| userData | 指向应用设置该回调处理方法时提供的自定义数据的指针。 |
OH_AVScreenCapture_OnDisplaySelected
typedef void (*OH_AVScreenCapture_OnDisplaySelected)(OH_AVScreenCapture *capture, uint64_t displayId, void *userData)
描述
当录屏事件开始时，将调用函数指针。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 15
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| displayId | 录屏屏幕的Id。 |
| userData | 指向应用设置该回调处理方法时提供的自定义数据的指针。 |
OH_AVScreenCapture_OnError
typedef void(* OH_AVScreenCapture_OnError) (OH_AVScreenCapture *capture, int32_t errorCode, void *userData)
描述 当OH_AVScreenCapture实例操作期间发生错误时，将调用函数指针。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| errorCode | 指定错误码。 |
| userData | 指向应用设置该回调处理方法时提供的自定义数据的指针。 |
OH_AVScreenCapture_OnStateChange
typedef void(* OH_AVScreenCapture_OnStateChange) (struct OH_AVScreenCapture *capture, OH_AVScreenCaptureStateCode stateCode, void *userData)
描述 当OH_AVScreenCapture实例操作期间发生状态变更时，将调用函数指针。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| stateCode | 指定状态码。 |
| userData | 指向应用设置该回调处理方法时提供的自定义数据的指针。 |
OH_AVScreenCaptureBufferType
typedef enum OH_AVScreenCaptureBufferTypeOH_AVScreenCaptureBufferType
描述 枚举，表示buffer类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
OH_AVScreenCaptureCallback
typedef struct OH_AVScreenCaptureCallback OH_AVScreenCaptureCallback
描述 OH_AVScreenCapture中所有异步回调函数指针的集合。将该结构体的实例注册到OH_AVScreenCapture实例中， 并处理回调上报的信息，以保证OH_AVScreenCapture的正常运行。
从API 12开始，推荐使用接口OH_AVScreenCapture_OnError OH_AVScreenCapture_OnBufferAvailable替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| onError | 监控录屏调用操作错误，请参见OH_AVScreenCaptureOnError。 |
| onAudioBufferAvailable | 监控音频码流是否有数据产生，请参见OH_AVScreenCaptureOnAudioBufferAvailable。 |
| onVideoBufferAvailable | 监控视频码流是否有数据产生，请参见OH_AVScreenCaptureOnVideoBufferAvailable。 |
OH_AVScreenCaptureConfig
typedef struct OH_AVScreenCaptureConfig OH_AVScreenCaptureConfig
描述 录屏配置信息
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_AVScreenCaptureFilterableAudioContent
typedef enum OH_AVScreenCaptureFilterableAudioContent OH_AVScreenCaptureFilterableAudioContent
描述 枚举，表示可过滤的音频类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
OH_AVScreenCaptureOnAudioBufferAvailable
typedef void(* OH_AVScreenCaptureOnAudioBufferAvailable) (OH_AVScreenCapture *capture, bool isReady, OH_AudioCaptureSourceType type)
描述 当OH_AVScreenCapture操作期间音频缓冲区可用时，将调用函数指针。
从API 12开始，推荐使用接口OH_AVScreenCapture_OnBufferAvailable替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| isReady | 音频缓冲区是否可用。 |
| type | 音频源类型。 |
OH_AVScreenCaptureOnError
typedef void(* OH_AVScreenCaptureOnError) (OH_AVScreenCapture *capture, int32_t errorCode)
描述 当OH_AVScreenCapture实例运行出错时，将调用函数指针。
从API 12开始，推荐使用接口OH_AVScreenCapture_OnError替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| errorCode | 指定错误码。 |
OH_AVScreenCaptureOnVideoBufferAvailable
typedef void(* OH_AVScreenCaptureOnVideoBufferAvailable) (OH_AVScreenCapture *capture, bool isReady)
描述 当OH_AVScreenCapture操作期间视频缓冲区可用时，将调用函数指针。
从API 12开始，推荐使用接口OH_AVScreenCapture_OnBufferAvailable替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| isReady | 视频缓冲区是否可用。 |
OH_AVScreenCaptureStateCode
typedef enum OH_AVScreenCaptureStateCode OH_AVScreenCaptureStateCode
描述 枚举，表示状态码。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
OH_CaptureMode
typedef enum OH_CaptureMode OH_CaptureMode
描述 枚举，表示屏幕录制的不同模式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_ContainerFormatType
typedef enum OH_ContainerFormatType OH_ContainerFormatType
描述 枚举，表示屏幕录制生成的文件类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_DataType
typedef enum OH_DataType OH_DataType
描述 枚举，表示屏幕录制流的数据格式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_NativeBuffer
typedef struct OH_NativeBuffer OH_NativeBuffer
描述 提供录屏的视频原始码流类。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_RecorderInfo
typedef struct OH_RecorderInfo OH_RecorderInfo
描述 录制文件信息。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_Rect
typedef struct OH_Rect OH_Rect
描述 定义录屏界面的宽高以及画面信息。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_VideoCaptureInfo
typedef struct OH_VideoCaptureInfo OH_VideoCaptureInfo
描述 视频录制信息。
当videoFrameWidth和videoFrameHeight同时为0时，忽略视频相关参数不录制屏幕数据。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_VideoCodecFormat
typedef enum OH_VideoCodecFormat OH_VideoCodecFormat
描述 枚举，表示视频编码格式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_VideoEncInfo
typedef struct OH_VideoEncInfo OH_VideoEncInfo
描述 视频编码参数。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_VideoInfo
typedef struct OH_VideoInfo OH_VideoInfo
描述 视频信息。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
OH_VideoSourceType
typedef enum OH_VideoSourceType OH_VideoSourceType
描述 枚举，表示视频源格式。当前仅支持RGBA格式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
枚举类型说明
OH_AudioCaptureSourceType
enum OH_AudioCaptureSourceType
描述 枚举，表示屏幕录制时的音频源类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
| 枚举值 | 描述 |
|---|---|
| OH_SOURCE_INVALID | 无效音频源。 |
| OH_SOURCE_DEFAULT | 默认音频源，默认为麦克风。 |
| OH_MIC | 麦克风录制的外部音频流。 |
| OH_ALL_PLAYBACK | 系统播放的所有内部音频流。 |
| OH_APP_PLAYBACK | 指定应用播放的内部音频流。 |
OH_AudioCodecFormat
enum OH_AudioCodecFormat
描述 枚举，表示音频编码格式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
| 枚举值 | 描述 |
|---|---|
| OH_AUDIO_DEFAULT | 默认音频编码，默认为AAC_LC。 |
| OH_AAC_LC | AAC_LC音频编码。 |
| OH_AUDIO_CODEC_FORMAT_BUTT | 无效格式。 |
OH_AVSCREEN_CAPTURE_ErrCode
enum OH_AVSCREEN_CAPTURE_ErrCode
描述
屏幕录制过程中产生的不同结果码。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
| 枚举值 | 描述 |
|---|---|
| AV_SCREEN_CAPTURE_ERR_BASE | 接口调用错误返回的基础值。 |
| AV_SCREEN_CAPTURE_ERR_OK | 操作成功。 |
| AV_SCREEN_CAPTURE_ERR_NO_MEMORY | 内存不足。 |
| AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT | 不允许操作。 |
| AV_SCREEN_CAPTURE_ERR_INVALID_VAL | 无效参数。 |
| AV_SCREEN_CAPTURE_ERR_IO | 输入输出流异常。 |
| AV_SCREEN_CAPTURE_ERR_TIMEOUT | 网络超时。 |
| AV_SCREEN_CAPTURE_ERR_UNKNOWN | 未知错误。 |
| AV_SCREEN_CAPTURE_ERR_SERVICE_DIED | 媒体服务已终止。 |
| AV_SCREEN_CAPTURE_ERR_INVALID_STATE | 当前状态不支持此操作。 |
| AV_SCREEN_CAPTURE_ERR_UNSUPPORT | 不支持的接口。 |
| AV_SCREEN_CAPTURE_ERR_EXTEND_START | 预期之外的错误。 |
OH_AVScreenCaptureBufferType
enum OH_AVScreenCaptureBufferType
描述 枚举，表示buffer类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
| 枚举值 | 描述 |
|---|---|
| OH_SCREEN_CAPTURE_BUFFERTYPE_VIDEO | 视频数据。 |
| OH_SCREEN_CAPTURE_BUFFERTYPE_AUDIO_INNER | 内录音频数据。 |
| OH_SCREEN_CAPTURE_BUFFERTYPE_AUDIO_MIC | 麦克风音频数据。 |
OH_AVScreenCaptureFilterableAudioContent
enum OH_AVScreenCaptureFilterableAudioContent
描述 枚举，表示可过滤的音频类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
| 枚举值 | 描述 |
|---|---|
| OH_SCREEN_CAPTURE_NOTIFICATION_AUDIO | 通知音。 |
| OH_SCREEN_CAPTURE_CURRENT_APP_AUDIO | 应用自身声音。 |
OH_AVScreenCaptureStateCode
enum OH_AVScreenCaptureStateCode
描述 枚举，表示状态码。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
| 枚举值 | 描述 |
|---|---|
| OH_SCREEN_CAPTURE_STATE_STARTED | 已开始录屏。 |
| OH_SCREEN_CAPTURE_STATE_CANCELED | 已取消录屏。 |
| OH_SCREEN_CAPTURE_STATE_STOPPED_BY_USER | 已停止录屏。 |
| OH_SCREEN_CAPTURE_STATE_INTERRUPTED_BY_OTHER | 录屏被其他录屏中断。 |
| OH_SCREEN_CAPTURE_STATE_STOPPED_BY_CALL | 录屏被通话中断。 |
| OH_SCREEN_CAPTURE_STATE_MIC_UNAVAILABLE | 麦克风不可用。 |
| OH_SCREEN_CAPTURE_STATE_MIC_MUTED_BY_USER | 麦克风被静音。 |
| OH_SCREEN_CAPTURE_STATE_MIC_UNMUTED_BY_USER | 麦克风被取消静音。 |
| OH_SCREEN_CAPTURE_STATE_ENTER_PRIVATE_SCENE | 进入隐私弹窗。 |
| OH_SCREEN_CAPTURE_STATE_EXIT_PRIVATE_SCENE | 隐私弹窗退出。 |
| OH_SCREEN_CAPTURE_STATE_STOPPED_BY_USER_SWITCHES | 系统用户切换，录屏中断。 |
OH_CaptureMode
enum OH_CaptureMode
描述 枚举，表示屏幕录制的不同模式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
| 枚举值 | 描述 |
|---|---|
| OH_CAPTURE_HOME_SCREEN | 录制主屏幕。 |
| OH_CAPTURE_SPECIFIED_SCREEN | 录制指定屏幕。 |
| OH_CAPTURE_SPECIFIED_WINDOW | 录制指定窗口。 |
| OH_CAPTURE_INVAILD | 无效模式。 |
OH_ContainerFormatType
enum OH_ContainerFormatType
描述 枚举，表示屏幕录制生成的文件类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
| 枚举值 | 描述 |
|---|---|
| CFT_MPEG_4A | 音频格式 m4a。 |
| CFT_MPEG_4 | 视频格式 mp4。 |
OH_DataType
enum OH_DataType
描述 枚举，表示屏幕录制流的数据格式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
| 枚举值 | 描述 |
|---|---|
| OH_ORIGINAL_STREAM | 原始流格式，如YUV/RGBA/PCM等。 |
| OH_ENCODED_STREAM | 编码格式，如H264/AAC等。 当前版本暂不支持。 |
| OH_CAPTURE_FILE | 保存文件格式，支持mp4。 |
| OH_INVAILD | 无效格式。 |
OH_VideoCodecFormat
enum OH_VideoCodecFormat
描述 枚举，表示视频编码格式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
| 枚举值 | 描述 |
|---|---|
| OH_VIDEO_DEFAULT | 默认视频编码格式为H.264。 |
| OH_H264 | H.264。 |
| OH_H265 | H.265/HEVC。 |
| OH_MPEG4 | MPEG4。 |
| OH_VP8 | VP8。 |
| OH_VP9 | VP9。 |
| OH_VIDEO_CODEC_FORMAT_BUTT | 无效格式。 |
OH_VideoSourceType
enum OH_VideoSourceType
描述 枚举，表示视频源格式。当前仅支持RGBA格式。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
| 枚举值 | 描述 |
|---|---|
| OH_VIDEO_SOURCE_SURFACE_YUV | YUV格式。当前版本暂不支持。 |
| OH_VIDEO_SOURCE_SURFACE_ES | raw格式。当前版本暂不支持。 |
| OH_VIDEO_SOURCE_SURFACE_RGBA | RGBA格式。 |
| OH_VIDEO_SOURCE_BUTT | 无效格式。 |
函数说明
OH_AVScreenCapture_AcquireAudioBuffer()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_AcquireAudioBuffer (struct OH_AVScreenCapture * capture, OH_AudioBuffer ** audiobuffer, OH_AudioCaptureSourceType type )
描述 获取音频buffer，应用在调用时，需要对audiobuffer分配对应结构体大小的内存，否则会影响音频buffer的获取。
从API 12开始，推荐使用接口OH_AVScreenCapture_OnBufferAvailable替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| audiobuffer | 保存音频buffer的结构体，通过该结构体获取到音频buffer以及buffer的时间戳等信息。 |
| type | 音频buffer的类型，区分是麦克风录制的外部流还是系统内部播放音频的内录流，详情请参阅OH_AudioCaptureSourceType。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针或输入参数audiobuffer为空指针。
AV_SCREEN_CAPTURE_ERR_NO_MEMORY：内存不足，audiobuffer分配失败。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置隐私权限启用失败或获取音频buffer失败。
OH_AVScreenCapture_AcquireVideoBuffer()
OH_NativeBuffer* OH_AVScreenCapture_AcquireVideoBuffer (struct OH_AVScreenCapture * capture, int32_t * fence, int64_t * timestamp, struct OH_Rect * region )
描述 获取视频buffer，应用在调用时，通过此接口来获取到视频的buffer以及时间戳等信息。 buffer使用完成后，调用OH_AVScreenCapture_ReleaseVideoBuffer接口进行视频buffer的释放。
从API 12开始，推荐使用接口OH_AVScreenCapture_OnBufferAvailable替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| fence | 用于同步的显示相关参数信息。 |
| timestamp | 视频帧的时间戳。 |
| region | 视频显示相关的坐标信息。 |
返回：
执行成功返回OH_NativeBuffer对象，通过OH_NativeBuffer对象相关接口可以获取到视频buffer和分辨率等信息参数。
OH_AVScreenCapture_ContentFilter_AddAudioContent()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ContentFilter_AddAudioContent (struct OH_AVScreenCapture_ContentFilter * filter, OH_AVScreenCaptureFilterableAudioContent content )
描述 向ContentFilter实例添加可被过滤的声音类型。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| filter | 指向OH_AVScreenCapture_ContentFilter实例的指针。 |
| content | OH_AVScreenCaptureFilterableAudioContent实例。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数filter为空指针或输入参数content无效。
OH_AVScreenCapture_ContentFilter_AddWindowContent()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ContentFilter_AddWindowContent (struct OH_AVScreenCapture_ContentFilter *filter, int32_t *windowIDs, int32_t windowCount)
描述 向ContentFilter实例添加可被过滤的窗口ID列表。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| filter | 指向OH_AVScreenCapture_ContentFilter实例的指针。 |
| windowIDs | 指向窗口ID的指针。 |
| windowCount | 窗口ID列表的长度。 |
返回：
执行成功返回AV_SCREEN_CAPTURE_ERR_OK，否则返回具体错误码，请参阅OH_AVSCREEN_CAPTURE_ErrCode。
OH_AVScreenCapture_Create()
struct OH_AVScreenCapture* OH_AVScreenCapture_Create (void )
描述 实例化对象，创建OH_AVScreenCapture。可以通过调用OH_AVScreenCapture_Release释放实例。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
返回：
返回一个指向OH_AVScreenCapture实例的指针。
OH_AVScreenCapture_CreateContentFilter()
struct OH_AVScreenCapture_ContentFilter* OH_AVScreenCapture_CreateContentFilter (void )
描述 创建ContentFilter。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
返回：
执行成功返回OH_AVScreenCapture_ContentFilter实例，否则返回空指针。
OH_AVScreenCapture_ExcludeContent()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ExcludeContent (struct OH_AVScreenCapture * capture, struct OH_AVScreenCapture_ContentFilter * filter )
描述 设置OH_AVScreenCapture实例的内容过滤器ContentFilter。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| filter | 指向OH_AVScreenCapture_ContentFilter实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针或输入参数filter为空指针。
AV_SCREEN_CAPTURE_ERR_UNSUPPORT：操作不支持，对于流，启动时调用AudioCapturer接口；对于capture文件，启动时调用Recorder接口。
OH_AVScreenCapture_Init()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_Init (struct OH_AVScreenCapture * capture, OH_AVScreenCaptureConfig config )
描述 初始化OH_AVScreenCapture相关参数，包括音频麦克风采样相关参数（可选），音频内录采样相关参数，视频分辨率相关参数。
录屏存文件场景，应用需要保证视频编码参数、视频采样参数、音频编码参数、音频内录采样参数均合法，音频麦克风采样参数合法（可选）。
录屏出码流场景，应用需要保证音频内录采样参数、视频采样参数至少一个合法，音频麦克风采样参数合法（可选）。
由于结构体变量在初始化时不会对成员进行初始化，应用必须根据使用场景正确设置各项参数。建议应用先将 OH_AVScreenCaptureConfig结构体变量的所有内存字节均设置为0，然后再根据录屏场景设置合法参数。
音频采样参数结构体OH_AudioCaptureInfo，若audioSampleRate和audioChannels同时为0， 则录屏实例OH_AVScreenCapture将忽略该类型的音频参数，且不采集该类型的音频数据。
视频采样参数结构体OH_VideoCaptureInfo，若videoFrameWidth和videoFrameHeight同时为0， 则录屏实例OH_AVScreenCapture将忽略对应视频参数，且不采集屏幕数据。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| config | 录屏初始化相关参数。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，初始化配置失败。
OH_AVScreenCapture_Release()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_Release (struct OH_AVScreenCapture * capture)
描述 释放创建的OH_AVScreenCapture实例，对应OH_AVScreenCapture_Create。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，OH_AVScreenCapture实例释放失败。
OH_AVScreenCapture_ReleaseAudioBuffer()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ReleaseAudioBuffer (struct OH_AVScreenCapture * capture, OH_AudioCaptureSourceType type )
描述 根据音频类型释放buffer。当某一帧音频buffer使用完成后，调用此接口进行释放对应的音频buffer。
从API 12开始，推荐使用接口OH_AVScreenCapture_OnBufferAvailable替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| type | 音频buffer的类型，区分麦克风录制的外部流还是系统内部播放音频的内录流。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，不允许用于已设置过DataCallback或释放音频buffer失败。
OH_AVScreenCapture_ReleaseContentFilter()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ReleaseContentFilter (struct OH_AVScreenCapture_ContentFilter * filter)
描述 释放ContentFilter。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| filter | 指向OH_AVScreenCapture_ContentFilter实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数filter为空指针。
OH_AVScreenCapture_ReleaseVideoBuffer()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ReleaseVideoBuffer (struct OH_AVScreenCapture * capture)
描述 根据视频类型释放buffer。当某一帧视频buffer使用完成后，调用此接口进行释放对应的视频buffer。
从API 12开始，推荐使用接口OH_AVScreenCapture_OnBufferAvailable替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，不允许用于已设置过DataCallback或释放视频buffer失败。
OH_AVScreenCapture_SetCallback()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetCallback (struct OH_AVScreenCapture * capture, struct OH_AVScreenCaptureCallback callback )
描述 设置监听接口，通过设置监听，可以监听到调用过程中的错误信息，以及是否有可用的视频buffer和音频buffer。
从API 12开始，推荐使用接口OH_AVScreenCapture_SetErrorCallback OH_AVScreenCapture_SetDataCallback替代。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| callback | OH_AVScreenCaptureCallback的结构体，保存相关回调函数指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针或输入参数callback为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置监听接口失败。
OH_AVScreenCapture_SetCanvasRotation()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetCanvasRotation (struct OH_AVScreenCapture * capture, bool canvasRotation )
描述 设置录屏屏幕数据旋转。
调用该方法可以设置录屏屏幕数据是否旋转，当canvasRotation为true时，打开录屏屏幕数据旋转功能，录制的屏幕数据保持正向。
默认为false。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| canvasRotation | 指示屏幕数据旋转参数。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置录屏屏幕数据旋转失败。
OH_AVScreenCapture_SetDataCallback()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetDataCallback (struct OH_AVScreenCapture * capture, OH_AVScreenCapture_OnBufferAvailable callback, void * userData )
描述 设置数据处理回调方法，在开始录制前调用。
调用该方法设置数据处理回调方法，当OH_AVScreenCapture操作期间有音频或视频数据缓存区可用时，将调用该数据处理回调方法。
应用需要在该数据处理回调方法中根据数据类型完成处理麦克风音频、内录音频、视频数据，当该数据处理回调方法返回后数据缓存区将不再有效。
调用该方法成功后：
- 当OH_AVScreenCapture操作期间有音视频缓存区可用时，将不再调用通过OH_AVScreenCapture_SetCallback设置的数据回调方法OH_AVScreenCaptureOnAudioBufferAvailable和OH_AVScreenCaptureOnVideoBufferAvailable。
- 不允许应用调用如下4个方法OH_AVScreenCapture_AcquireAudioBuffer、OH_AVScreenCapture_ReleaseAudioBuffer、OH_AVScreenCapture_AcquireVideoBuffer和OH_AVScreenCapture_ReleaseVideoBuffer，直接返回失败。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| callback | 指向数据处理回调方法实例的指针OH_AVScreenCapture_OnBufferAvailable。 |
| userData | 指向应用提供的自定义数据的指针，在数据处理回调方法被调用时作为入参回传。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针或输入参数callback为空指针。
AV_SCREEN_CAPTURE_ERR_NO_MEMORY：内存不足，内存分配失败。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置DataCallback失败。
OH_AVScreenCapture_SetDisplayCallback()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetDisplayCallback(struct OH_AVScreenCapture *capture, OH_AVScreenCapture_OnDisplaySelected callback, void *userData)
描述
设置获取录屏屏幕Id的回调。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 15
参数:
| 名称 | 描述 |
|---|---|
| capture | OH_AVScreenCapture实例的指针。 |
| callback | 指向录屏屏幕Id回调方法实例的指针OH_AVScreenCapture_OnDisplaySelected。 |
| userData | 指向应用提供的自定义数据的指针，在状态处理回调方法被调用时作为入参回传。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针或输入参数callback为空指针。
AV_SCREEN_CAPTURE_ERR_NO_MEMORY：内存不足，内存分配失败。
AV_SCREEN_CAPTURE_ERR_INVALID_STATE：当前状态不支持此操作，回调必须在start方法前调用。
OH_AVScreenCapture_SetErrorCallback()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetErrorCallback (struct OH_AVScreenCapture * capture, OH_AVScreenCapture_OnError callback, void * userData )
描述 设置错误处理回调方法，在开始录制前调用。
调用该方法设置错误处理回调方法，当OH_AVScreenCapture实例发生错误时，该错误处理回调方法将会被调用。
调用该设置方法成功后：当OH_AVScreenCapture实例出现错误时，将不再触发通过OH_AVScreenCapture_SetCallback设置的错误处理回调方法OH_AVScreenCaptureOnError。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| callback | 指向错误处理回调方法实例的指针OH_AVScreenCapture_OnError。 |
| userData | 指向应用提供的自定义数据的指针，在错误处理回调方法被调用时作为入参回传。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针或输入参数callback为空指针。
AV_SCREEN_CAPTURE_ERR_NO_MEMORY：内存不足，内存分配失败。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置ErrorCallback失败。
OH_AVScreenCapture_SetMicrophoneEnabled()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetMicrophoneEnabled (struct OH_AVScreenCapture * capture, bool isMicrophone )
描述 设置麦克风开关。当isMicrophone为true时，则打开麦克风，通过调用OH_AVScreenCapture_StartScreenCapture和OH_AVScreenCapture_AcquireAudioBuffer可以正常获取到音频的麦克风原始PCM数据；isMicrophone为false时，获取到的音频数据为无声数据。
默认麦克风开关为开启。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| isMicrophone | 麦克风开关参数。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置麦克风开关失败。
OH_AVScreenCapture_SetStateCallback()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetStateCallback (struct OH_AVScreenCapture * capture, OH_AVScreenCapture_OnStateChange callback, void * userData )
描述 设置状态变更处理回调方法，在开始录制前调用。
调用该方法设置状态变更处理回调方法，当OH_AVScreenCapture实例发生状态变更时，该状态变更处理回调方法将会被调用。
调用该设置方法成功后，在启动录屏时将通过隐私弹窗方式征求用户同意：
-
如果用户同意则开始启动录屏流程，在启动录屏成功后，通过该状态处理回调方法上报OH_SCREEN_CAPTURE_STATE_STARTED状态，告知应用启动录屏成功，并在屏幕显示录屏通知。
如果启动录屏失败，则通过该状态处理回调方法上报失败状态信息（如，若麦克风不可用则上报OH_SCREEN_CAPTURE_STATE_MIC_UNAVAILABLE状态），或通过错误处理回调方法OH_AVScreenCapture_OnError上报错误信息。
-
如果用户拒绝，则终止启动录屏，通过该状态处理回调方法上报OH_SCREEN_CAPTURE_STATE_CANCELED状态，告知应用用户拒绝启动录屏，启动录屏失败。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| callback | 指向状态处理回调方法实例的指针OH_AVScreenCapture_OnStateChange |
| userData | 指向应用提供的自定义数据的指针，在状态处理回调方法被调用时作为入参回传。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针或输入参数callback为空指针。
AV_SCREEN_CAPTURE_ERR_NO_MEMORY：内存不足，内存分配失败。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置StateCallback失败。
OH_AVScreenCapture_StartScreenCapture()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StartScreenCapture (struct OH_AVScreenCapture * capture)
描述 开始录屏，采集原始码流。调用后可以通过回调的监听(OH_AVScreenCapture_OnBufferAvailable)来监听当前是否有码流的产生,通过回调的监听(OH_AVScreenCapture_OnStateChange)来监听启动状态。
通过调用获取音频buffer(OH_AVScreenCapture_AcquireAudioBuffer)和视频buffer(OH_AVScreenCapture_ReleaseVideoBuffer)的接口来获取录屏的原始码流。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置隐私权限启用失败或启动录屏失败。
OH_AVScreenCapture_StartScreenCaptureWithSurface()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StartScreenCaptureWithSurface (struct OH_AVScreenCapture * capture, OHNativeWindow * window )
描述 使用Surface模式录屏。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| window | 指向OHNativeWindow实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针、输入参数window为空指针或window指向的windowSurface为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置隐私权限启用失败或启动ScreenCaptureWithSurface失败。
OH_AVScreenCapture_StartScreenRecording()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StartScreenRecording (struct OH_AVScreenCapture * capture)
描述 启动录屏，调用此接口，可将录屏文件保存。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置隐私权限启用失败或启用屏幕录制失败。
OH_AVScreenCapture_StopScreenCapture()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StopScreenCapture (struct OH_AVScreenCapture * capture)
描述 结束录屏，与OH_AVScreenCapture_StartScreenCapture配合使用。调用后针对调用该接口的应用会停止录屏或屏幕共享，释放麦克风。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，结束录屏失败。
OH_AVScreenCapture_StopScreenRecording()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_StopScreenRecording (struct OH_AVScreenCapture * capture)
描述 停止录屏，与OH_AVScreenCapture_StartScreenRecording配合使用。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 10
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，停止屏幕录制失败。
OH_AVScreenCapture_ResizeCanvas()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ResizeCanvas (struct OH_AVScreenCapture * capture, int32_t width, int32_t height)
描述 调整屏幕的分辨率。
调用该方法可以设置录屏屏幕数据的分辨率，width为屏幕的宽度，height为屏幕的高度。
该接口目前仅支持录屏取码流的场景，不支持录屏存文件的场景。并且调用该接口的调用者以及视频数据的消费者需要确保自身能够支持收到的视频数据分辨率发生变化。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| width | 录屏屏幕的宽度。 |
| height | 录屏屏幕的高度。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作。
OH_AVScreenCapture_ShowCursor()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_ShowCursor(struct OH_AVScreenCapture *capture, bool showCursor)
描述
设置光标显示开关。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 15
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| showCursor | 光标显示参数。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作，设置光标失败。
OH_AVScreenCapture_SkipPrivacyMode()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SkipPrivacyMode (struct OH_AVScreenCapture * capture, int32_t *windowIDs, int32_t windowCount)
描述 录屏时豁免隐私窗口。
调用该方法可以豁免隐私窗口，windowIDs为需要豁免的隐私窗口ID指针，windowCount 为隐私窗口ID列表的长度，目前豁免需要传入所有隐私子窗口和主窗口ID。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 12
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| windowIDs | 向隐私窗口ID的指针。 |
| windowCount | 隐私窗口ID列表的长度。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：不允许操作。
OH_AVScreenCapture_SetMaxVideoFrameRate()
OH_AVSCREEN_CAPTURE_ErrCode OH_AVScreenCapture_SetMaxVideoFrameRate (struct OH_AVScreenCapture * capture, int32_t frameRate)
描述 设置录屏的最大帧率。
该接口应在录屏启动之后被调用。
调用该方法设置录屏时的最大帧率，frameRate参数表示最大帧率。
该接口设置最大帧率时，实际设置的帧率受限设备的能力，由底层的系统能力决定。
调用该接口设置录屏最大帧率时，实际帧率将受限于设备能力。目前接口入参的最大值不设限制，但当前支持的最高帧率为60FPS，当入参设置超过60FPS，将以60FPS处理。不超过上限时，则按照实际入参值处理。
系统能力： SystemCapability.Multimedia.Media.AVScreenCapture
起始版本： 14
参数:
| 名称 | 描述 |
|---|---|
| capture | 指向OH_AVScreenCapture实例的指针。 |
| frameRate | 设置录屏的最大帧率。 |
返回：
函数结果代码OH_AVSCREEN_CAPTURE_ErrCode：
AV_SCREEN_CAPTURE_ERR_OK：执行成功。
AV_SCREEN_CAPTURE_ERR_INVALID_VAL：输入参数capture为空指针，或者输入参数frameRate不支持。
AV_SCREEN_CAPTURE_ERR_OPERATE_NOT_PERMIT：操作受限，建议重试。