• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Enums
2<!--Kit: Media Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @wang-haizhou6-->
5<!--Designer: @HmQQQ-->
6<!--Tester: @xchaosioda-->
7<!--Adviser: @zengyawen-->
8
9> **说明:**
10>
11> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
12
13## AVErrorCode<sup>9+</sup>
14
15[媒体错误码](errorcode-media.md)类型枚举
16
17**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
18
19**系统能力:** SystemCapability.Multimedia.Media.Core
20
21| 名称                                  | 值      | 说明                                 |
22| :------------------------------------ | ------- | ------------------------------------ |
23| AVERR_OK                              | 0       | 表示操作成功。                       |
24| AVERR_NO_PERMISSION                   | 201     | 表示无权限执行此操作。               |
25| AVERR_INVALID_PARAMETER               | 401     | 表示传入入参无效。                   |
26| AVERR_UNSUPPORT_CAPABILITY            | 801     | 表示当前版本不支持该API能力。        |
27| AVERR_NO_MEMORY                       | 5400101 | 表示系统内存不足或服务数量达到上限。 |
28| AVERR_OPERATE_NOT_PERMIT              | 5400102 | 表示当前状态不允许或无权执行此操作。 |
29| AVERR_IO                              | 5400103 | 表示数据流异常信息。                 |
30| AVERR_TIMEOUT                         | 5400104 | 表示系统或网络响应超时。             |
31| AVERR_SERVICE_DIED                    | 5400105 | 表示服务进程死亡。                   |
32| AVERR_UNSUPPORT_FORMAT                | 5400106 | 表示不支持当前媒体资源的格式。       |
33| AVERR_AUDIO_INTERRUPTED<sup>11+</sup> | 5400107 | 表示音频焦点被抢占                   |
34| AVERR_SESSION_NOT_EXIST<sup>20+</sup> | 5400109 | 表示传入的会话ID不存在。                   |
35| AVERR_IO_HOST_NOT_FOUND<sup>14+</sup> | 5411001 | 表示解析或链接服务端地址错误。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
36| AVERR_IO_CONNECTION_TIMEOUT<sup>14+</sup> | 5411002 | 表示网络连接超时。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
37| AVERR_IO_NETWORK_ABNORMAL<sup>14+</sup> | 5411003 | 表示网络异常导致的数据或链路异常。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
38| AVERR_IO_NETWORK_UNAVAILABLE<sup>14+</sup> | 5411004 | 表示网络被禁用。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
39| AVERR_IO_NO_PERMISSION<sup>14+</sup> | 5411005 | 表示无访问权限。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
40| AVERR_IO_REQUEST_DENIED<sup>14+</sup> | 5411006 | 表示客户端请求参数错误或超出处理能力。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
41| AVERR_IO_RESOURCE_NOT_FOUND<sup>14+</sup> | 5411007 | 表示无可用网络资源。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
42| AVERR_IO_SSL_CLIENT_CERT_NEEDED<sup>14+</sup> | 5411008 | 表示服务端校验客户端证书失败。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
43| AVERR_IO_SSL_CONNECTION_FAILED<sup>14+</sup> | 5411009 | 表示SSL连接失败。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
44| AVERR_IO_SSL_SERVER_CERT_UNTRUSTED<sup>14+</sup> | 5411010 | 表示客户端校验服务端证书失败。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
45| AVERR_IO_UNSUPPORTED_REQUEST<sup>14+</sup> | 5411011 | 表示网络协议的原因导致请求不受支持。 <br> **原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。        |
46| AVERR_SEEK_CONTINUOUS_UNSUPPORTED<sup>18+</sup> | 5410002 | 表示不支持SEEK_CONTINUOUS模式的seek。 <br> **原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。        |
47| AVERR_SUPER_RESOLUTION_UNSUPPORTED<sup>18+</sup> | 5410003 | 表示不支持超分。 <br> **原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。        |
48| AVERR_SUPER_RESOLUTION_NOT_ENABLED<sup>18+</sup> | 5410004 | 表示未使能超分。 <br> **原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。        |
49| AVERR_PARAMETER_OUT_OF_RANGE<sup>20+</sup> | 5400108 | 表示参数超过取值范围。 <br> **原子化服务API:** 从API version 20开始,该接口支持在原子化服务中使用。        |
50
51## MediaType<sup>8+</sup>
52
53媒体类型枚举。
54
55**系统能力:** SystemCapability.Multimedia.Media.Core
56
57| 名称           | 值                    | 说明                 |
58| -------------- | --------------------- | ------------------- |
59| MEDIA_TYPE_UNSUPPORTED<sup>20+</sup> | -1                     | 表示未支持的类型。 <br> **原子化服务API:** 从API version 20 开始,该接口支持在原子化服务中使用。
60| MEDIA_TYPE_AUD | 0                     | 表示音频。 <br> **原子化服务API:** 从API version 11 开始,该接口支持在原子化服务中使用。           |
61| MEDIA_TYPE_VID | 1                     | 表示视频。  <br> **原子化服务API:** 从API version 11 开始,该接口支持在原子化服务中使用。          |
62| MEDIA_TYPE_SUBTITLE<sup>12+</sup> | 2    | 表示字幕。 <br> **原子化服务API:** 从API version 12 开始,该接口支持在原子化服务中使用。 |
63| MEDIA_TYPE_ATTACHMENT<sup>20+</sup> | 3    | 表示附件信息(如嵌入的外部文件)。 <br> **原子化服务API:** 从API version 20 开始,该接口支持在原子化服务中使用。 |
64| MEDIA_TYPE_DATA<sup>20+</sup> | 4    | 表示数据。 <br> **原子化服务API:** 从API version 20 开始,该接口支持在原子化服务中使用。 |
65| MEDIA_TYPE_TIMED_METADATA<sup>20+</sup> | 5    | 表示带时间戳的元数据。 <br> **原子化服务API:** 从API version 20 开始,该接口支持在原子化服务中使用。 |
66| MEDIA_TYPE_AUXILIARY<sup>20+</sup> | 6    | 表示辅助(轨道)信息。 <br> **原子化服务API:** 从API version 20 开始,该接口支持在原子化服务中使用。 |
67
68## CodecMimeType<sup>8+</sup>
69
70Codec MIME类型枚举。
71
72**系统能力:** SystemCapability.Multimedia.Media.Core
73
74| 名称         | 值                    | 说明                     |
75| ------------ | --------------------- | ------------------------ |
76| VIDEO_H263   | 'video/h263'          | 表示视频/h263类型。      |
77| VIDEO_AVC    | 'video/avc'           | 表示视频/avc类型。       |
78| VIDEO_MPEG2  | 'video/mpeg2'         | 表示视频/mpeg2类型。     |
79| VIDEO_MPEG4  | 'video/mp4v-es'         | 表示视频/mpeg4类型。     |
80| VIDEO_VP8    | 'video/x-vnd.on2.vp8' | 表示视频/vp8类型。       |
81| VIDEO_HEVC<sup>11+</sup>   | 'video/hevc'          | 表示视频/H265类型。|
82| AUDIO_AAC    | 'audio/mp4a-latm'     | 表示音频/mp4a-latm类型。 <br> **原子化服务API:** 从API version 12 开始,该接口支持在原子化服务中使用。 |
83| AUDIO_VORBIS | 'audio/vorbis'        | 表示音频/vorbis类型。    |
84| AUDIO_FLAC   | 'audio/flac'          | 表示音频/flac类型。      |
85| AUDIO_MP3<sup>12+</sup>   | 'audio/mpeg'          | 表示音频/mpeg类型。      |
86| AUDIO_G711MU<sup>12+</sup>   | 'audio/g711mu'     | 表示音频/G711-mulaw类型。 |
87| AUDIO_AMR_NB<sup>18+</sup>   | 'audio/3gpp'     | 表示音频/amr-nb类型。 |
88| AUDIO_AMR_WB<sup>18+</sup>   | 'audio/amr-wb'     | 表示音频/amr-wb类型。 |
89
90## MediaDescriptionKey<sup>8+</sup>
91
92媒体信息描述枚举。
93
94**系统能力:** SystemCapability.Multimedia.Media.Core
95
96| 名称                     | 值              | 说明                                                         |
97| ------------------------ | --------------- | ------------------------------------------------------------ |
98| MD_KEY_TRACK_INDEX       | 'track_index'   | 表示轨道序号,其对应键值类型为number。 <br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 |
99| MD_KEY_TRACK_TYPE        | 'track_type'    | 表示轨道类型,其对应键值类型为number,参考[MediaType](#mediatype8)。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 |
100| MD_KEY_CODEC_MIME        | 'codec_mime'    | 表示codec_mime类型,其对应键值类型为string。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
101| MD_KEY_DURATION          | 'duration'      | 表示媒体时长,其对应键值类型为number,单位为毫秒(ms)。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
102| MD_KEY_BITRATE           | 'bitrate'       | 表示比特率,其对应键值类型为number,单位为比特率(bps)。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
103| MD_KEY_WIDTH             | 'width'         | 表示视频宽度,其对应键值类型为number,单位为像素(px)。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
104| MD_KEY_HEIGHT            | 'height'        | 表示视频高度,其对应键值类型为number,单位为像素(px)。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
105| MD_KEY_FRAME_RATE        | 'frame_rate'    | 表示视频帧率,其对应键值类型为number,单位为每100秒的帧数。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 |
106| MD_KEY_AUD_CHANNEL_COUNT | 'channel_count' | 表示声道数,其对应键值类型为number。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
107| MD_KEY_AUD_SAMPLE_RATE   | 'sample_rate'   | 表示采样率,其对应键值类型为number,单位为赫兹(Hz)。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
108| MD_KEY_AUD_SAMPLE_DEPTH<sup>12+</sup>  | 'sample_depth'  | 表示位深,其对应键值类型为number,单位为位(bit)。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
109| MD_KEY_LANGUAGE<sup>12+</sup>  | 'language'  | 表示字幕语言,其对应键值类型为string。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
110| MD_KEY_TRACK_NAME<sup>12+</sup>  | 'track_name'  | 表示track名称,其对应键值类型为string。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
111| MD_KEY_HDR_TYPE<sup>12+</sup>  | 'hdr_type'  | 表示视频轨类型,其对应键值类型为string。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
112
113## PlaybackInfoKey<sup>12+</sup>
114
115播放信息描述枚举。
116
117**系统能力:** SystemCapability.Multimedia.Media.Core
118
119| 名称                     | 值              | 说明                                                         |
120| ------------------------ | --------------- | ------------------------------------------------------------ |
121| SERVER_IP_ADDRESS        | 'server_ip_address'    | 表示服务器IP地址,其对应键值类型为string。  |
122| AVG_DOWNLOAD_RATE        | 'average_download_rate'| 表示平均下载速率,其对应键值类型为number,单位为比特率(bps)。 |
123| DOWNLOAD_RATE            | 'download_rate'        | 表示1s的下载速率,其对应键值类型为number,单位为比特率(bps)。|
124| IS_DOWNLOADING           | 'is_downloading'       | 表示下载状态,1表示在下载状态,0表示非下载状态(下载完成),其对应键值类型为number。|
125| BUFFER_DURATION          | 'buffer_duration'      | 表示缓存数据的可播放时长,其对应键值类型为number,单位为秒(s)。|
126
127## BufferingInfoType<sup>8+</sup>
128
129缓存事件类型枚举。
130
131**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
132
133**系统能力:** SystemCapability.Multimedia.Media.Core
134
135| 名称              | 值   | 说明                             |
136| ----------------- | ---- | -------------------------------- |
137| BUFFERING_START   | 1    | 表示开始缓冲。当上报BUFFERING_START时,播放器会暂停播放。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。                   |
138| BUFFERING_END     | 2    | 表示结束缓冲。当上报BUFFERING_END时,播放器会恢复播放。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。                   |
139| BUFFERING_PERCENT | 3    | 表示缓冲百分比。可参考该事件感知缓冲进度。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。                 |
140| CACHED_DURATION   | 4    |  表示已缓冲数据预估可播放时长,单位为毫秒(ms)。缓冲区中的数据变化量大于500ms,上报一次。可参考该事件做进度条。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。  |
141
142## StateChangeReason<sup>9+</sup>
143
144表示播放或录制实例状态机切换原因的枚举,伴随state一起上报。
145
146**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
147
148**系统能力:** SystemCapability.Multimedia.Media.Core
149
150| 名称       | 值   | 说明                                                         |
151| ---------- | ---- | ------------------------------------------------------------ |
152| USER       | 1    | 表示用户行为造成的状态切换,由用户或客户端主动调用接口产生。 |
153| BACKGROUND | 2    | 表示后台系统行为造成的状态切换,比如应用未注册播控中心权限,退到后台时被系统强制暂停或停止。 |
154
155## SeekMode<sup>8+</sup>
156
157视频播放的Seek模式枚举,可通过seek方法作为参数传递下去。
158
159**系统能力:** SystemCapability.Multimedia.Media.Core
160
161| 名称           | 值   | 说明                                                         |
162| -------------- | ---- | ------------------------------------------------------------ |
163| SEEK_NEXT_SYNC | 0    | 表示跳转到指定时间点的下一个关键帧,建议向后快进的时候用这个枚举值。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 |
164| SEEK_PREV_SYNC | 1    | 表示跳转到指定时间点的上一个关键帧,建议向前快进的时候用这个枚举值。<br>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。 |
165| SEEK_CLOSEST<sup>12+</sup> | 2    | 表示跳转到距离指定时间点最近的帧,建议精准跳转进度的时候用这个枚举值。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
166| SEEK_CONTINUOUS<sup>18+</sup> | 3    | 该模式提供了一种画面平滑流畅变化的Seek体验,应用可以结合进度条控件持续调用Seek方法,AVPlayer根据Seek调用持续流畅地更新画面。<br>应用可以调用[isSeekContinuousSupported](arkts-apis-media-AVPlayer.md#isseekcontinuoussupported18)方法根据返回结果感知视频源是否支持该模式Seek。<br>对于不支持该Seek模式的视频源调用该模式Seek时,会上报AVERR_SEEK_CONTINUOUS_UNSUPPORTED错误([媒体错误码](#averrorcode9)),同时画面更新的流畅性会降低。<br>该Seek模式不会触发[seekDone事件](arkts-apis-media-AVPlayer.md#onseekdone9)。<br>当应用需要退出该模式下的Seek时,需要调用`seek(-1, SeekMode.SEEK_CONTINUOUS)`来结束该模式下的Seek。<br>**原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。 |
167
168## SwitchMode<sup>12+</sup>
169
170视频播放的selectTrack模式枚举,可通过selectTrack方法作为参数传递下去,当前仅DASH协议视频轨支持该扩展参数。
171
172**系统能力:** SystemCapability.Multimedia.Media.Core
173
174| 名称           | 值   | 说明                                                         |
175| -------------- | ---- | ------------------------------------------------------------ |
176| SMOOTH | 0    | 表示切换后视频平滑播放,该模式切换存在延迟,不会立即生效。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
177| SEGMENT | 1    | 表示切换后从当前分片开始位置播放,该模式立即切换,会有重复播放。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
178| CLOSEST | 2    | 表示从距离当前播放时间点最近的帧开始播放,该模式立即切换,切换后会卡住3到5s,然后恢复播放。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
179
180## PlaybackSpeed<sup>8+</sup>
181
182视频播放的倍速枚举,可通过setSpeed方法作为参数传递下去。
183
184**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
185
186**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
187
188| 名称                 | 值   | 说明                           |
189| -------------------- | ---- | ------------------------------ |
190| SPEED_FORWARD_0_75_X | 0    | 表示视频播放正常播速的0.75倍。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
191| SPEED_FORWARD_1_00_X | 1    | 表示视频播放正常播速。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。         |
192| SPEED_FORWARD_1_25_X | 2    | 表示视频播放正常播速的1.25倍。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
193| SPEED_FORWARD_1_75_X | 3    | 表示视频播放正常播速的1.75倍。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
194| SPEED_FORWARD_2_00_X | 4    | 表示视频播放正常播速的2.00倍。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
195| SPEED_FORWARD_0_50_X<sup>12+</sup> | 5    | 表示视频播放正常播速的0.50倍。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
196| SPEED_FORWARD_1_50_X<sup>12+</sup> | 6    | 表示视频播放正常播速的1.50倍。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
197| SPEED_FORWARD_3_00_X<sup>13+</sup> | 7    | 表示视频播放正常播速的3.00倍。<br>**原子化服务API:** 从API version 13开始,该接口支持在原子化服务中使用。 |
198| SPEED_FORWARD_0_25_X<sup>12+</sup> | 8    | 表示视频播放正常播速的0.25倍。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
199| SPEED_FORWARD_0_125_X<sup>12+</sup> | 9    | 表示视频播放正常播速的0.125倍。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。 |
200
201## VideoScaleType<sup>9+</sup>
202
203枚举,视频缩放模式。
204
205**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
206
207**系统能力:** SystemCapability.Multimedia.Media.VideoPlayer
208
209| 名称                        | 值   | 说明                                              |
210| ----------------------------| ---- | ------------------------------------------------ |
211| VIDEO_SCALE_TYPE_FIT        | 0    | 默认比例类型,视频拉伸至与窗口等大。                |
212| VIDEO_SCALE_TYPE_FIT_CROP   | 1    | 保持视频宽高比缩放至最短边填满窗口,长边超出窗口部分被裁剪。     |
213| VIDEO_SCALE_TYPE_SCALED_ASPECT<sup>20+</sup> | 2    | 保持视频宽高比缩放至长边填满窗口,短边居中对齐,未填满部分留黑。<br>**原子化服务API:** 从API version 20开始,该接口支持在原子化服务中使用。  |
214
215## AudioSourceType<sup>9+</sup>
216
217表示视频录制中音频源类型的枚举。
218
219**系统能力:** SystemCapability.Multimedia.Media.AVRecorder
220
221| 名称                      | 值   | 说明                   |
222| ------------------------- | ---- | ---------------------- |
223| AUDIO_SOURCE_TYPE_DEFAULT | 0    | 默认的音频输入源类型。 |
224| AUDIO_SOURCE_TYPE_MIC     | 1    | 表示MIC的音频输入源。<br> **原子化服务API:** 从API version 12 开始,该接口支持在原子化服务中使用。 |
225| AUDIO_SOURCE_TYPE_VOICE_RECOGNITION<sup>12+</sup> | 2    | 表示语音识别场景的音频源。 |
226| AUDIO_SOURCE_TYPE_VOICE_COMMUNICATION<sup>12+</sup>     | 7    | 表示语音通话场景的音频源。 |
227| AUDIO_SOURCE_TYPE_VOICE_MESSAGE<sup>12+</sup> | 10    | 表示短语音消息的音频源。 |
228| AUDIO_SOURCE_TYPE_CAMCORDER<sup>12+</sup>     | 13    | 表示相机录像的音频源。 |
229
230## VideoSourceType<sup>9+</sup>
231
232表示视频录制中视频源类型的枚举。
233
234**系统能力:** SystemCapability.Multimedia.Media.AVRecorder
235
236| 名称                          | 值   | 说明                            |
237| ----------------------------- | ---- | ------------------------------- |
238| VIDEO_SOURCE_TYPE_SURFACE_YUV | 0    | 输入surface中携带的是raw data。 |
239| VIDEO_SOURCE_TYPE_SURFACE_ES  | 1    | 输入surface中携带的是ES data。  |
240
241## ContainerFormatType<sup>8+</sup>
242
243表示容器格式类型的枚举,缩写为CFT。
244
245**系统能力:** SystemCapability.Multimedia.Media.Core
246
247| 名称        | 值    | 说明                  |
248| ----------- | ----- | --------------------- |
249| CFT_MPEG_4  | 'mp4' | 视频的容器格式,MP4。 |
250| CFT_MPEG_4A | 'm4a' | 音频的容器格式,M4A。<br> **原子化服务API:** 从API version 12 开始,该接口支持在原子化服务中使用。 |
251| CFT_MP3<sup>12+</sup>  | 'mp3' | 音频的容器格式,MP3。 |
252| CFT_WAV<sup>12+</sup>  | 'wav' | 音频的容器格式,WAV。 |
253| CFT_AMR<sup>18+</sup>  | 'amr' | 音频的容器格式,AMR。 |
254| CFT_AAC<sup>20+</sup>  | 'aac' | 音频的容器格式,AAC。默认为ADTS帧头格式。 |
255
256## FileGenerationMode<sup>12+</sup>
257
258表示创建媒体文件模式的枚举。
259
260**系统能力:** SystemCapability.Multimedia.Media.AVRecorder
261
262| 名称                          | 值   | 说明                            |
263| ----------------------------- | ---- | ------------------------------- |
264| APP_CREATE  | 0    | 由应用自行在沙箱创建媒体文件。 |
265| AUTO_CREATE_CAMERA_SCENE  | 1    | 由系统创建媒体文件,当前仅在相机录制场景下生效,会忽略应用设置的url。 |
266
267## HdrType<sup>12+</sup>
268
269表示视频HDR类型的枚举。
270
271**系统能力:** SystemCapability.Multimedia.Media.Core
272
273| 名称                      | 值   | 说明                   |
274| ------------------------- | ---- | ---------------------- |
275| AV_HDR_TYPE_NONE          | 0    | 表示无HDR类型。 |
276| AV_HDR_TYPE_VIVID         | 1    | 表示为HDR VIVID类型。 |
277
278## AVImageQueryOptions<sup>12+</sup>
279
280需要获取的缩略图时间点与视频帧的对应关系。
281
282在获取视频缩略图时,传入的时间点与实际取得的视频帧所在时间点不一定相等,需要指定传入的时间点与实际取得的视频帧的时间关系。
283
284**系统能力:** SystemCapability.Multimedia.Media.AVImageGenerator
285
286| 名称                     | 值              | 说明                                                         |
287| ------------------------ | --------------- | ------------------------------------------------------------ |
288| AV_IMAGE_QUERY_NEXT_SYNC       | 0   | 表示选取传入时间点或之后的关键帧。                       |
289| AV_IMAGE_QUERY_PREVIOUS_SYNC        | 1    | 表示选取传入时间点或之前的关键帧。 |
290| AV_IMAGE_QUERY_CLOSEST_SYNC        | 2    | 表示选取离传入时间点最近的关键帧。                 |
291| AV_IMAGE_QUERY_CLOSEST             | 3    | 表示选取离传入时间点最近的帧,该帧不一定是关键帧。 |
292
293## LoadingRequestError<sup>18+</sup>
294
295枚举,数据加载过程中状态变化的原因。
296
297**原子化服务API:** 从API version 18开始,该接口支持在原子化服务中使用。
298
299**系统能力:** SystemCapability.Multimedia.Media.Core
300
301| 名称                 | 值   | 说明                           |
302| -------------------- | ---- | ------------------------------ |
303| LOADING_ERROR_SUCCESS | 0    | 由客户端返回,表示已经推送到资源末尾。 |
304| LOADING_ERROR_NOT_READY | 1    | 由客户端返回,表示资源尚未准备好可供访问。|
305| LOADING_ERROR_NO_RESOURCE | 2    | 由客户端返回,表示请求的资源URL不存在。 |
306| LOADING_ERROR_INVAID_HANDLE | 3    | 由客户端返回,表示请求的资源句柄uuid无效。 |
307| LOADING_ERROR_ACCESS_DENIED | 4    | 由客户端返回,表示客户端没有权限请求该资源。 |
308| LOADING_ERROR_ACCESS_TIMEOUT | 5    | 由客户端返回,表示访问资源过程超时。 |
309| LOADING_ERROR_AUTHORIZE_FAILED | 6    | 由客户端返回,表示授权失败。 |
310
311## AVMimeTypes<sup>12+</sup>
312
313媒体MIME类型,通过[setMimeType](arkts-apis-media-MediaSource.md#setmimetype12)设置。
314
315**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
316
317**系统能力:** SystemCapability.Multimedia.Media.Core
318
319| 名称       | 值   | 说明                                                         |
320| ---------- | ---- | ------------------------------------------------------------ |
321| APPLICATION_M3U8       | application/m3u8    | 表示m3u8本地文件。 |
322
323## AVScreenCaptureRecordPreset<sup>12+</sup>
324
325进行屏幕录制时的编码、封装格式参数的枚举。
326
327**系统能力:** SystemCapability.Multimedia.Media.AVScreenCapture
328
329| 名称                              | 值   | 说明                                         |
330| --------------------------------- | ---- | -------------------------------------------- |
331| SCREEN_RECORD_PRESET_H264_AAC_MP4 | 0    | 使用视频H264编码,音频AAC编码,MP4封装格式。 |
332| SCREEN_RECORD_PRESET_H265_AAC_MP4 | 1    | 使用视频H265编码,音频AAC编码,MP4封装格式。 |
333
334## AVScreenCaptureStateCode<sup>12+</sup>
335
336屏幕录制的状态回调。
337
338**系统能力:** SystemCapability.Multimedia.Media.AVScreenCapture
339
340| 名称                                     | 值   | 说明                     |
341| ---------------------------------------- | ---- | ------------------------ |
342| SCREENCAPTURE_STATE_STARTED              | 0    | 录屏已开始。             |
343| SCREENCAPTURE_STATE_CANCELED             | 1    | 录屏被取消。             |
344| SCREENCAPTURE_STATE_STOPPED_BY_USER      | 2    | 录屏被用户手动停止。     |
345| SCREENCAPTURE_STATE_INTERRUPTED_BY_OTHER | 3    | 录屏被其他录屏打断。     |
346| SCREENCAPTURE_STATE_STOPPED_BY_CALL      | 4    | 录屏被来电打断。         |
347| SCREENCAPTURE_STATE_MIC_UNAVAILABLE      | 5    | 录屏无法使用麦克风收音。 |
348| SCREENCAPTURE_STATE_MIC_MUTED_BY_USER    | 6    | 麦克风被用户关闭。       |
349| SCREENCAPTURE_STATE_MIC_UNMUTED_BY_USER  | 7    | 麦克风被用户打开。       |
350| SCREENCAPTURE_STATE_ENTER_PRIVATE_SCENE  | 8    | 录屏进入隐私页面。       |
351| SCREENCAPTURE_STATE_EXIT_PRIVATE_SCENE   | 9    | 录屏退出隐私页面。       |
352| SCREENCAPTURE_STATE_STOPPED_BY_USER_SWITCHES   | 10    | 系统用户切换,录屏中断。       |
353
354## AVScreenCaptureFillMode<sup>18+</sup>
355
356进行屏幕录制时视频填充模式的枚举。
357
358**系统能力:** SystemCapability.Multimedia.Media.AVScreenCapture
359
360| 名称                              | 值   | 说明                                         |
361| --------------------------------- | ---- | -------------------------------------------- |
362| PRESERVE_ASPECT_RATIO | 0    | 保持与原始图像相同的宽高比例,即与物理屏幕宽高比例一致。 |
363| SCALE_TO_FILL | 1    | 进行图像拉伸填充,适配设置的宽度和高度。 |
364
365## AudioEncoder<sup>(deprecated)</sup>
366
367> **说明:**
368> 从API version 6开始支持,从API version 8开始废弃,建议使用[CodecMimeType](#codecmimetype8)替代。
369
370表示音频编码格式的枚举。
371
372**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder
373
374| 名称    | 值   | 说明                                                         |
375| ------- | ---- | ------------------------------------------------------------ |
376| DEFAULT | 0    | 默认编码格式。<br/>仅做接口定义,暂不支持使用。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[CodecMimeType](#codecmimetype8)中的AUDIO_AAC替代。 |
377| AMR_NB  | 1    | AMR-NB(Adaptive Multi Rate-Narrow Band Speech Codec) 编码格式。<br/>仅做接口定义,暂不支持使用。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[CodecMimeType](#codecmimetype8)中的AUDIO_AMR_NB替代。 |
378| AMR_WB  | 2    | AMR-WB(Adaptive Multi Rate-Wide Band Speech Codec) 编码格式。<br/>仅做接口定义,暂不支持使用。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[CodecMimeType](#codecmimetype8)中的AUDIO_AMR_WB替代。 |
379| AAC_LC  | 3    | AAC-LC(Advanced&nbsp;Audio&nbsp;Coding&nbsp;Low&nbsp;Complexity)编码格式。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[CodecMimeType](#codecmimetype8)中的AUDIO_AAC替代。 |
380| HE_AAC  | 4    | HE_AAC(High-Efficiency Advanced&nbsp;Audio&nbsp;Coding)编码格式。<br/>仅做接口定义,暂不支持使用。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[CodecMimeType](#codecmimetype8)中的AUDIO_AAC替代。 |
381
382## AudioOutputFormat<sup>(deprecated)</sup>
383
384> **说明:**
385> 从API version 6开始支持,从API version 8 开始废弃,建议使用[ContainerFormatType](#containerformattype8)替代。
386
387表示音频封装格式的枚举。
388
389**系统能力:** SystemCapability.Multimedia.Media.AudioRecorder
390
391| 名称     | 值   | 说明                                                         |
392| -------- | ---- | ------------------------------------------------------------ |
393| DEFAULT  | 0    | 默认封装格式。<br/>仅做接口定义,暂不支持使用。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议根据具体情况选择[ContainerFormatType](#containerformattype8)中的一项替代。 |
394| MPEG_4   | 2    | 封装为MPEG-4格式。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[ContainerFormatType](#containerformattype8)中的CFT_MPEG_4替代。 |
395| AMR_NB   | 3    | 封装为AMR_NB格式。<br/>仅做接口定义,暂不支持使用。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[ContainerFormatType](#containerformattype8)中的CFT_AMR,编码格式使用[CodecMimeType](#codecmimetype8)中的AUDIO_AMR_NB替代。 |
396| AMR_WB   | 4    | 封装为AMR_WB格式。<br/>仅做接口定义,暂不支持使用。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[ContainerFormatType](#containerformattype8)中的CFT_AMR,编码格式使用[CodecMimeType](#codecmimetype8)中的AUDIO_AMR_WB替代。 |
397| AAC_ADTS | 6    | 封装为ADTS(Audio&nbsp;Data&nbsp;Transport&nbsp;Stream)格式,是AAC音频的传输流格式。<br/>**说明:** 从API version 6开始支持,从API version 8开始废弃,建议使用[ContainerFormatType](#containerformattype8)中的CFT_AAC替代。 |
398
399## MediaErrorCode<sup>(deprecated)</sup>
400
401媒体服务错误类型枚举。
402
403> **说明:**
404> 从API version 8开始支持,从API version 11开始废弃,建议使用[媒体错误码](#averrorcode9)替代。
405
406**系统能力:** SystemCapability.Multimedia.Media.Core
407
408| 名称                       | 值   | 说明                                   |
409| -------------------------- | ---- | -------------------------------------- |
410| MSERR_OK                   | 0    | 表示操作成功。                         |
411| MSERR_NO_MEMORY            | 1    | 表示申请内存失败,系统可能无可用内存。 |
412| MSERR_OPERATION_NOT_PERMIT | 2    | 表示无权限执行此操作。                 |
413| MSERR_INVALID_VAL          | 3    | 表示传入入参无效。                     |
414| MSERR_IO                   | 4    | 表示发生IO错误。                       |
415| MSERR_TIMEOUT              | 5    | 表示操作超时。                         |
416| MSERR_UNKNOWN              | 6    | 表示未知错误。                         |
417| MSERR_SERVICE_DIED         | 7    | 表示服务端失效。                       |
418| MSERR_INVALID_STATE        | 8    | 表示在当前状态下,不允许执行此操作。   |
419| MSERR_UNSUPPORTED          | 9    | 表示在当前版本下,不支持此操作。       |
420