Enums

说明:

本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

AVErrorCode9+

Media错误码类型枚举。

原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
AVERR_OK 0 表示操作成功。
AVERR_NO_PERMISSION 201 表示无权限执行此操作。
AVERR_INVALID_PARAMETER 401 表示传入参数无效。
AVERR_UNSUPPORT_CAPABILITY 801 表示当前版本不支持该API能力。
AVERR_NO_MEMORY 5400101 表示系统内存不足或服务数量达到上限。
AVERR_OPERATE_NOT_PERMIT 5400102 表示当前状态不允许或无权执行此操作。
AVERR_IO 5400103 表示数据流异常信息。
AVERR_TIMEOUT 5400104 表示系统或网络响应超时。
AVERR_SERVICE_DIED 5400105 表示服务进程死亡。
AVERR_UNSUPPORT_FORMAT 5400106 表示不支持当前媒体资源的格式。
AVERR_AUDIO_INTERRUPTED11+ 5400107 表示音频焦点被抢占。
AVERR_IO_HOST_NOT_FOUND14+ 5411001 表示解析或链接服务端地址错误。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_CONNECTION_TIMEOUT14+ 5411002 表示网络连接超时。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_NETWORK_ABNORMAL14+ 5411003 表示网络异常导致的数据或链路异常。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_NETWORK_UNAVAILABLE14+ 5411004 表示网络被禁用。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_NO_PERMISSION14+ 5411005 表示无访问权限。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_REQUEST_DENIED14+ 5411006 表示客户端请求参数错误或超出处理能力。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_RESOURCE_NOT_FOUND14+ 5411007 表示无可用网络资源。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_SSL_CLIENT_CERT_NEEDED14+ 5411008 表示服务端校验客户端证书失败。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_SSL_CONNECTION_FAILED14+ 5411009 表示SSL连接失败。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_SSL_SERVER_CERT_UNTRUSTED14+ 5411010 表示客户端校验服务端证书失败。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_IO_UNSUPPORTED_REQUEST14+ 5411011 表示网络协议的原因导致请求不受支持。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
AVERR_SEEK_CONTINUOUS_UNSUPPORTED18+ 5410002 表示不支持SEEK_CONTINUOUS模式的seek。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。
AVERR_SUPER_RESOLUTION_UNSUPPORTED18+ 5410003 表示不支持超分。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。
AVERR_SUPER_RESOLUTION_NOT_ENABLED18+ 5410004 表示未使能超分。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。
AVERR_PARAMETER_OUT_OF_RANGE20+ 5400108 表示参数超过取值范围。
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。
AVERR_IO_CLEARTEXT_NOT_PERMITTED23+ 5411012 表示不允许HTTP明文访问。
原子化服务API: 从API version 23开始,该接口支持在原子化服务中使用。

MediaType8+

媒体类型枚举。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
MEDIA_TYPE_UNSUPPORTED20+ -1 表示未支持的类型。
原子化服务API: 从API version 20 开始,该接口支持在原子化服务中使用。
MEDIA_TYPE_AUD 0 表示音频。
原子化服务API: 从API version 11 开始,该接口支持在原子化服务中使用。
MEDIA_TYPE_VID 1 表示视频。
原子化服务API: 从API version 11 开始,该接口支持在原子化服务中使用。
MEDIA_TYPE_SUBTITLE12+ 2 表示字幕。
原子化服务API: 从API version 12 开始,该接口支持在原子化服务中使用。
MEDIA_TYPE_ATTACHMENT20+ 3 表示附件信息(如嵌入的外部文件)。
原子化服务API: 从API version 20 开始,该接口支持在原子化服务中使用。
MEDIA_TYPE_DATA20+ 4 表示数据。
原子化服务API: 从API version 20 开始,该接口支持在原子化服务中使用。
MEDIA_TYPE_TIMED_METADATA20+ 5 表示带时间戳的元数据。
原子化服务API: 从API version 20 开始,该接口支持在原子化服务中使用。
MEDIA_TYPE_AUXILIARY20+ 6 表示辅助(轨道)信息。
原子化服务API: 从API version 20 开始,该接口支持在原子化服务中使用。

CodecMimeType8+

Codec MIME类型枚举。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
VIDEO_H263 'video/h263' 表示视频/h263类型。
VIDEO_AVC 'video/avc' 表示视频/avc类型。
原子化服务API: 从API version 22开始,该接口支持在原子化服务中使用。
VIDEO_MPEG2 'video/mpeg2' 表示视频/mpeg2类型。
VIDEO_MPEG4 'video/mp4v-es' 表示视频/mpeg4类型。
VIDEO_VP8 'video/x-vnd.on2.vp8' 表示视频/vp8类型。
VIDEO_HEVC11+ 'video/hevc' 表示视频/H265类型。
原子化服务API: 从API version 22开始,该接口支持在原子化服务中使用。
AUDIO_AAC 'audio/mp4a-latm' 表示音频/mp4a-latm类型。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
AUDIO_VORBIS 'audio/vorbis' 表示音频/vorbis类型。
AUDIO_FLAC 'audio/flac' 表示音频/flac类型。
AUDIO_MP312+ 'audio/mpeg' 表示音频/mpeg类型。
AUDIO_G711MU12+ 'audio/g711mu' 表示音频/G711-mulaw类型。
AUDIO_AMR_NB18+ 'audio/3gpp' 表示音频/amr-nb类型。
AUDIO_AMR_WB18+ 'audio/amr-wb' 表示音频/amr-wb类型。

AacProfile22+

高级音频编码(AAC)类型枚举。

原子化服务API: 从API version 22开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Media.AVRecorder

名称 说明
AAC_LC 0 表示AAC Low-Complexity类型。
AAC_HE 1 表示AAC High-Efficiency类型。
AAC_HE_V2 2 表示AAC High-Efficiency version 2类型。

MediaDescriptionKey8+

媒体信息描述枚举。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
MD_KEY_TRACK_INDEX 'track_index' 表示轨道序号,其对应键值类型为number。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_TRACK_TYPE 'track_type' 表示轨道类型,其对应键值类型为number,参考MediaType
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_CODEC_MIME 'codec_mime' 表示codec_mime类型,其对应键值类型为string。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_DURATION 'duration' 表示媒体时长,其对应键值类型为number,单位为毫秒(ms)。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_BITRATE 'bitrate' 表示比特率,其对应键值类型为number,单位为比特率(bps),值为undefined或0表示异常。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_WIDTH 'width' 表示视频宽度,其对应键值类型为number,单位为像素(px)。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_HEIGHT 'height' 表示视频高度,其对应键值类型为number,单位为像素(px)。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_FRAME_RATE 'frame_rate' 表示视频帧率,其对应键值类型为number,单位为每100秒的帧数。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_AUD_CHANNEL_COUNT 'channel_count' 表示声道数,其对应键值类型为number。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_AUD_SAMPLE_RATE 'sample_rate' 表示采样率,其对应键值类型为number,单位为赫兹(Hz)。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
MD_KEY_AUD_SAMPLE_DEPTH12+ 'sample_depth' 表示位深,其对应键值类型为number,单位为位(bit)。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
MD_KEY_LANGUAGE12+ 'language' 表示字幕语言,其对应键值类型为string。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
MD_KEY_TRACK_NAME12+ 'track_name' 表示track名称,其对应键值类型为string。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
MD_KEY_HDR_TYPE12+ 'hdr_type' 表示视频轨类型,其对应键值类型为string。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
MD_KEY_ORIGINAL_WIDTH21+ 'original_width' 表示视频原始宽度,其对应键值类型为number,单位为像素(px)。
原子化服务API: 从API version 21开始,该接口支持在原子化服务中使用。
MD_KEY_ORIGINAL_HEIGHT21+ 'original_height' 表示视频原始高度,其对应键值类型为number,单位为像素(px)。
原子化服务API: 从API version 21开始,该接口支持在原子化服务中使用。
MD_KEY_MIME_TYPE23+ 'mime_type' 表示轨道的mime_type类型,其对应键值类型为string。对于音视频轨道,该值与MD_KEY_CODEC_MIME相同。
原子化服务API: 从API version 23开始,该接口支持在原子化服务中使用。
MD_KEY_REFERENCE_TRACK_IDS23+ 'ref_track_ids' 表示此轨道与其他轨道的引用关系,其对应键值类型为string,以逗号分隔。
原子化服务API: 从API version 23开始,该接口支持在原子化服务中使用。
MD_KEY_TRACK_REFERENCE_TYPE23+ 'track_ref_type' 表示此轨道作为辅助轨的辅助类型,其对应键值类型为string。
原子化服务API: 从API version 23开始,该接口支持在原子化服务中使用。

FetchResult23+

表示批量获取缩略图操作结果的枚举。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Multimedia.Media.AVMetadataExtractor

名称 说明
FETCH_FAILED 0 从视频中获取该缩略图失败。
FETCH_SUCCEEDED 1 从视频中获取该缩略图成功。
FETCH_CANCELED 2 从视频中获取该缩略图操作被取消。

PlaybackInfoKey12+

播放信息描述枚举。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
SERVER_IP_ADDRESS 'server_ip_address' 表示服务器IP地址,其对应键值类型为string。
AVG_DOWNLOAD_RATE 'average_download_rate' 表示平均下载速率,其对应键值类型为number,单位为比特率(bps)。
DOWNLOAD_RATE 'download_rate' 表示1s的下载速率,其对应键值类型为number,单位为比特率(bps)。
IS_DOWNLOADING 'is_downloading' 表示下载状态,1表示在下载状态,0表示非下载状态(下载完成),其对应键值类型为number。
BUFFER_DURATION 'buffer_duration' 表示缓存数据的可播放时长,其对应键值类型为number,单位为秒(s)。

PlaybackMetricsKey23+

表示播放器指标信息的枚举。

系统能力: SystemCapability.Multimedia.Media.AVPlayer

名称 说明
PREPARE_DURATION 'prepare_duration' 表示准备时长,单位为毫秒(ms)。
RESOURCE_CONNECTION_DURATION 'resource_connection_duration' 表示资源建链时长,单位为毫秒(ms)。
FIRST_FRAME_DECAPSULATION_DURATION 'first_frame_decapsulation_duration' 表示第一帧的解封装时长,单位为毫秒(ms)。
TOTAL_PLAYING_TIME 'total_playback_time' 表示总的播放时长,单位为毫秒(ms)。
DOWNLOAD_REQUESTS_COUNT 'loading_requests_count' 表示总的请求次数。
模型约束: 此接口仅可在Stage模型下使用。
TOTAL_DOWNLOAD_TIME 'total_loading_time' 表示总的加载时长,单位为毫秒(ms)。
TOTAL_DOWNLOAD_SIZE 'total_loading_bytes' 表示总的加载大小,单位为字节(Byte)。
模型约束: 此接口仅可在Stage模型下使用。
STALLING_COUNT 'stalling_count' 表示总的卡顿次数。
TOTAL_STALLING_TIME 'total_stalling_time' 表示总的卡顿时长,单位为毫秒(ms)。
LIP_ASYNC_COUNT 'lip_async_count' 表示总的音画不同步的次数。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
TOTAL_LIP_ASYNC_TIME 'total_lip_async_time' 表示总的音画不同步时长,单位为毫秒(ms)。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。

BufferingInfoType8+

缓存事件类型枚举。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
BUFFERING_START 1 表示开始缓冲。当上报BUFFERING_START时,播放器会暂停播放。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
BUFFERING_END 2 表示结束缓冲。当上报BUFFERING_END时,播放器会恢复播放。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
BUFFERING_PERCENT 3 表示缓冲百分比。可参考该事件感知缓冲进度。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
CACHED_DURATION 4 表示已缓冲数据预估可播放时长,单位为毫秒(ms)。缓冲区中的数据变化量大于500ms,上报一次。可参考该事件做进度条。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

SoundInterruptMode23+

表示在SoundPool中,同一ID的音频在播放时的打断模式的枚举。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Multimedia.Media.SoundPool

名称 说明
NO_INTERRUPT 0 表示同一ID的音频,如果前者尚未播放完成,后者不会打断前者的播放,二者并行播放。
SAME_SOUND_INTERRUPT 1 表示同一ID的音频,如果前者尚未播放完成,后者在播放前会先打断前者的播放。

StateChangeReason9+

表示播放或录制实例状态机切换原因的枚举,伴随state一起上报。

原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
USER 1 表示用户行为造成的状态切换,由用户或客户端主动调用接口产生。
BACKGROUND 2 表示后台系统行为造成的状态切换,比如应用未注册播控中心权限,退到后台时被系统强制暂停或停止。

SeekMode8+

视频播放的Seek模式枚举,可通过seek方法作为参数传递下去。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
SEEK_NEXT_SYNC 0 表示跳转到指定时间点的下一个关键帧,建议向后快进的时候用这个枚举值。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
SEEK_PREV_SYNC 1 表示跳转到指定时间点的上一个关键帧,建议向前快进的时候用这个枚举值。
原子化服务API: 从API version 11开始,该接口支持在原子化服务中使用。
SEEK_CLOSEST12+ 2 表示跳转到距离指定时间点最近的帧,建议精准跳转进度的时候用这个枚举值。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SEEK_CONTINUOUS18+ 3 该模式提供了一种画面平滑流畅变化的Seek体验,应用可以结合进度条控件持续调用Seek方法,AVPlayer根据Seek调用持续流畅地更新画面。
应用可以调用isSeekContinuousSupported方法根据返回结果感知视频源是否支持该模式Seek。
对于不支持该Seek模式的视频源调用该模式Seek时,会上报AVERR_SEEK_CONTINUOUS_UNSUPPORTED错误(参考AVErrorCode),同时画面更新的流畅性会降低。
该Seek模式不会触发on('seekDone')事件。
当应用需要退出该模式下的Seek时,需要调用seek(-1, SeekMode.SEEK_CONTINUOUS)来结束该模式下的Seek。
原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。

SwitchMode12+

表示视频播放的selectTrack模式枚举。

可通过selectTrack方法作为参数传递下去,当前DASH/HLS协议视频轨均支持该扩展参数(从API版本26.0.0开始HLS协议视频轨支持该扩展参数)。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
SMOOTH 0 表示切换后视频平滑播放,该模式切换存在延迟,不会立即生效。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SEGMENT 1 表示切换后从当前分片开始位置播放,该模式立即切换,会有重复播放。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
CLOSEST 2 表示从距离当前播放时间点最近的帧开始播放,该模式立即切换,切换后会卡住3到5s,然后恢复播放。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

PlaybackSpeed8+

视频播放的倍速枚举,可通过setSpeed方法作为参数传递下去。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Media.VideoPlayer

名称 说明
SPEED_FORWARD_0_75_X 0 表示视频播放正常播速的0.75倍。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_1_00_X 1 表示视频播放正常播速。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_1_25_X 2 表示视频播放正常播速的1.25倍。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_1_75_X 3 表示视频播放正常播速的1.75倍。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_2_00_X 4 表示视频播放正常播速的2.00倍。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_0_50_X12+ 5 表示视频播放正常播速的0.50倍。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_1_50_X12+ 6 表示视频播放正常播速的1.50倍。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_3_00_X13+ 7 表示视频播放正常播速的3.00倍。
原子化服务API: 从API version 13开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_0_25_X12+ 8 表示视频播放正常播速的0.25倍。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
SPEED_FORWARD_0_125_X12+ 9 表示视频播放正常播速的0.125倍。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

VideoScaleType9+

枚举,视频缩放模式。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Media.VideoPlayer

名称 说明
VIDEO_SCALE_TYPE_FIT 0 默认比例类型,视频拉伸至与窗口等大。
VIDEO_SCALE_TYPE_FIT_CROP 1 保持视频宽高比缩放至最短边填满窗口,长边超出窗口部分被裁剪。
VIDEO_SCALE_TYPE_SCALED_ASPECT20+ 2 保持视频宽高比缩放至长边填满窗口,短边居中对齐,未填满部分留黑。
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

AudioSourceType9+

表示视频录制中音频源类型的枚举。

系统能力: SystemCapability.Multimedia.Media.AVRecorder

名称 说明
AUDIO_SOURCE_TYPE_DEFAULT 0 默认的音频输入源类型。
AUDIO_SOURCE_TYPE_MIC 1 表示MIC的音频输入源。
原子化服务API: 从API version 12 开始,该接口支持在原子化服务中使用。
AUDIO_SOURCE_TYPE_VOICE_RECOGNITION12+ 2 表示语音识别场景的音频源。
AUDIO_SOURCE_TYPE_VOICE_COMMUNICATION12+ 7 表示语音通话场景的音频源。
AUDIO_SOURCE_TYPE_VOICE_MESSAGE12+ 10 表示短语音消息的音频源。
AUDIO_SOURCE_TYPE_CAMCORDER12+ 13 表示相机录像的音频源。

VideoSourceType9+

表示视频录制中视频源类型的枚举。

系统能力: SystemCapability.Multimedia.Media.AVRecorder

名称 说明
VIDEO_SOURCE_TYPE_SURFACE_YUV 0 输入surface中携带的是raw data。
VIDEO_SOURCE_TYPE_SURFACE_ES 1 输入surface中携带的是ES data。

ContainerFormatType8+

表示容器格式类型的枚举,缩写为CFT。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
CFT_MPEG_4 'mp4' 视频的容器格式,MP4。
原子化服务API: 从API version 22开始,该接口支持在原子化服务中使用。
CFT_MPEG_4A 'm4a' 音频的容器格式,M4A。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
CFT_MP312+ 'mp3' 音频的容器格式,MP3。
CFT_WAV12+ 'wav' 音频的容器格式,WAV。
CFT_AMR18+ 'amr' 音频的容器格式,AMR。
CFT_AAC20+ 'aac' 音频的容器格式,AAC。默认为ADTS帧头格式。

FileGenerationMode12+

表示创建媒体文件模式的枚举。

系统能力: SystemCapability.Multimedia.Media.AVRecorder

名称 说明
APP_CREATE 0 由应用自行在沙箱创建媒体文件。
AUTO_CREATE_CAMERA_SCENE 1 由系统创建媒体文件,当前仅在相机录制场景下生效,会忽略应用设置的url。

HdrType12+

表示视频HDR类型的枚举。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
AV_HDR_TYPE_NONE 0 表示无HDR类型。
AV_HDR_TYPE_VIVID 1 表示为HDR VIVID类型。

AVImageQueryOptions12+

需要获取的缩略图时间点与视频帧的对应关系。

在获取视频缩略图时,传入的时间点与实际取得的视频帧所在时间点不一定相等,需要指定传入的时间点与实际取得的视频帧的时间关系。

系统能力: SystemCapability.Multimedia.Media.AVImageGenerator

名称 说明
AV_IMAGE_QUERY_NEXT_SYNC 0 表示选取传入时间点或之后的关键帧。
AV_IMAGE_QUERY_PREVIOUS_SYNC 1 表示选取传入时间点或之前的关键帧。
AV_IMAGE_QUERY_CLOSEST_SYNC 2 表示选取离传入时间点最近的关键帧。
AV_IMAGE_QUERY_CLOSEST 3 表示选取离传入时间点最近的帧,该帧不一定是关键帧。

LoadingRequestError18+

枚举,数据加载过程中状态变化的原因。

原子化服务API: 从API version 18开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
LOADING_ERROR_SUCCESS 0 由客户端返回,表示已经推送到资源末尾。
LOADING_ERROR_NOT_READY 1 由客户端返回,表示资源尚未准备好可供访问。
LOADING_ERROR_NO_RESOURCE 2 由客户端返回,表示请求的资源URL不存在。
LOADING_ERROR_INVAID_HANDLE 3 由客户端返回,表示请求的资源句柄uuid无效。
LOADING_ERROR_ACCESS_DENIED 4 由客户端返回,表示客户端没有权限请求该资源。
LOADING_ERROR_ACCESS_TIMEOUT 5 由客户端返回,表示访问资源过程超时。
LOADING_ERROR_AUTHORIZE_FAILED 6 由客户端返回,表示授权失败。

AVMimeTypes12+

媒体MIME类型,通过setMimeType设置。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
APPLICATION_M3U8 application/m3u8 表示m3u8本地文件。

AVScreenCaptureRecordPreset12+

进行屏幕录制时的编码、封装格式参数的枚举。

系统能力: SystemCapability.Multimedia.Media.AVScreenCapture

名称 说明
SCREEN_RECORD_PRESET_H264_AAC_MP4 0 使用视频H264编码,音频AAC编码,MP4封装格式。
SCREEN_RECORD_PRESET_H265_AAC_MP4 1 使用视频H265编码,音频AAC编码,MP4封装格式。

AVScreenCaptureStateCode12+

屏幕录制的状态回调。

系统能力: SystemCapability.Multimedia.Media.AVScreenCapture

名称 说明
SCREENCAPTURE_STATE_STARTED 0 录屏已开始。
SCREENCAPTURE_STATE_CANCELED 1 录屏被取消。
SCREENCAPTURE_STATE_STOPPED_BY_USER 2 录屏被用户手动停止。
SCREENCAPTURE_STATE_INTERRUPTED_BY_OTHER 3 录屏被其他录屏打断。
SCREENCAPTURE_STATE_STOPPED_BY_CALL 4 录屏被来电打断。
SCREENCAPTURE_STATE_MIC_UNAVAILABLE 5 录屏无法使用麦克风收音。
SCREENCAPTURE_STATE_MIC_MUTED_BY_USER 6 麦克风被用户关闭。
SCREENCAPTURE_STATE_MIC_UNMUTED_BY_USER 7 麦克风被用户打开。
SCREENCAPTURE_STATE_ENTER_PRIVATE_SCENE 8 录屏进入隐私页面。
SCREENCAPTURE_STATE_EXIT_PRIVATE_SCENE 9 录屏退出隐私页面。
SCREENCAPTURE_STATE_STOPPED_BY_USER_SWITCHES 10 系统用户切换,录屏中断。
SCREENCAPTURE_STATE_PAUSED_BY_USER 11 录屏已被用户暂停。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
SCREENCAPTURE_STATE_RESUMED_BY_USER 12 录屏已被用户恢复。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
SCREENCAPTURE_STATE_PAUSED_BY_APP 13 录屏已被应用程序暂停。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
SCREENCAPTURE_STATE_RESUMED_BY_APP 14 录屏已被应用程序恢复。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。

AVScreenCaptureFillMode18+

进行屏幕录制时视频填充模式的枚举。

系统能力: SystemCapability.Multimedia.Media.AVScreenCapture

名称 说明
PRESERVE_ASPECT_RATIO 0 保持与原始图像相同的宽高比例,即与物理屏幕宽高比例一致。
SCALE_TO_FILL 1 进行图像拉伸填充,适配设置的宽度和高度。

PickerMode22+

表示屏幕录制Picker模式的枚举。

系统能力: SystemCapability.Multimedia.Media.AVScreenCapture

名称 说明
WINDOW_ONLY 0 仅显示窗口列表。
SCREEN_ONLY 1 仅显示屏幕列表。
SCREEN_AND_WINDOW 2 同时显示屏幕列表和窗口列表。
APP_ONLY 3 仅显示应用模式。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
WINDOW_AND_APP 4 同时显示窗口和应用模式。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
SCREEN_AND_APP 5 同时显示屏幕和应用模式。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。
SCREEN_WINDOW_AND_APP 6 同时显示屏幕、窗口和应用模式。
起始版本: 26.0.0
模型约束: 此接口仅可在Stage模型下使用。

AVMetricsEventType23+

表示媒体服务支持的指标事件的枚举。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
AV_METRICS_EVENT_STALLING 1 表示播放卡顿的指标事件。

PlaylistLoopMode

表示播放列表循环模式的枚举。

起始版本: 26.0.0

原子化服务API: 从API版本26.0.0开始,该接口支持在原子化服务中使用。

模型约束: 此接口仅可在Stage模型下使用。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
PLAYLIST_LOOP_MODE_ALL 1 列表循环模式。
PLAYLIST_LOOP_MODE_ONE 2 单曲循环模式。
PLAYLIST_LOOP_MODE_SHUFFLE 3 随机循环模式。
PLAYLIST_LOOP_MODE_NONE 4 关闭循环模式。

AudioEncoder(deprecated)

说明: 从API version 6开始支持,从API version 8开始废弃,建议使用CodecMimeType替代。

表示音频编码格式的枚举。

系统能力: SystemCapability.Multimedia.Media.AudioRecorder

名称 说明
DEFAULT 0 默认编码格式。
仅做接口定义,暂不支持使用。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用CodecMimeType中的AUDIO_AAC替代。
AMR_NB 1 AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。
仅做接口定义,暂不支持使用。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用CodecMimeType中的AUDIO_AMR_NB替代。
AMR_WB 2 AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。
仅做接口定义,暂不支持使用。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用CodecMimeType中的AUDIO_AMR_WB替代。
AAC_LC 3 AAC-LC(Advanced Audio Coding Low Complexity)编码格式。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用CodecMimeType中的AUDIO_AAC替代。
HE_AAC 4 HE_AAC(High-Efficiency Advanced Audio Coding)编码格式。
仅做接口定义,暂不支持使用。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用CodecMimeType中的AUDIO_AAC替代。

AudioOutputFormat(deprecated)

说明: 从API version 6开始支持,从API version 8 开始废弃,建议使用ContainerFormatType替代。

表示音频封装格式的枚举。

系统能力: SystemCapability.Multimedia.Media.AudioRecorder

名称 说明
DEFAULT 0 默认封装格式。
仅做接口定义,暂不支持使用。
说明: 从API version 6开始支持,从API version 8开始废弃,建议根据具体情况选择ContainerFormatType中的一项替代。
MPEG_4 2 封装为MPEG-4格式。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用ContainerFormatType中的CFT_MPEG_4替代。
AMR_NB 3 封装为AMR_NB格式。
仅做接口定义,暂不支持使用。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用ContainerFormatType中的CFT_AMR,编码格式使用CodecMimeType中的AUDIO_AMR_NB替代。
AMR_WB 4 封装为AMR_WB格式。
仅做接口定义,暂不支持使用。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用ContainerFormatType中的CFT_AMR,编码格式使用CodecMimeType中的AUDIO_AMR_WB替代。
AAC_ADTS 6 封装为ADTS(Audio Data Transport Stream)格式,是AAC音频的传输流格式。
说明: 从API version 6开始支持,从API version 8开始废弃,建议使用ContainerFormatType中的CFT_AAC替代。

MediaErrorCode(deprecated)

媒体服务错误类型枚举。

说明: 从API version 8开始支持,从API version 11开始废弃,建议使用AVErrorCode替代。

系统能力: SystemCapability.Multimedia.Media.Core

名称 说明
MSERR_OK 0 表示操作成功。
MSERR_NO_MEMORY 1 表示申请内存失败,系统可能无可用内存。
MSERR_OPERATION_NOT_PERMIT 2 表示无权限执行此操作。
MSERR_INVALID_VAL 3 表示传入入参无效。
MSERR_IO 4 表示发生IO错误。
MSERR_TIMEOUT 5 表示操作超时。
MSERR_UNKNOWN 6 表示未知错误。
MSERR_SERVICE_DIED 7 表示服务端失效。
MSERR_INVALID_STATE 8 表示在当前状态下,不允许执行此操作。
MSERR_UNSUPPORTED 9 表示在当前版本下,不支持此操作。