1# Interfaces (其他) 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## AVFileDescriptor<sup>9+</sup> 14 15音视频文件资源描述，一种特殊资源的播放方式，使用场景：应用中的音频资源被连续存储在同一个文件中，需要根据偏移量和长度进行播放。 16 17**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 18 19**系统能力：** SystemCapability.Multimedia.Media.Core 20 21| 名称 | 类型 | 必填 | 说明 | 22| ------ | ------ | ---- | ------------------------------------------------------------ | 23| fd | number | 是 | 资源句柄，通过[resourceManager.getRawFd](../apis-localization-kit/js-apis-resource-manager.md#getrawfd9)获取,也可以通过[fs.open](../apis-core-file-kit/js-apis-file-fs.md#fsopen)获取。 | 24| offset | number | 否 | 资源偏移量，默认值为0，需要基于预置资源的信息输入，非法值会造成音视频资源解析错误。 | 25| length | number | 否 | 资源长度，默认值为文件中从偏移量开始的剩余字节，需要基于预置资源的信息输入，非法值会造成音视频资源解析错误。 | 26 27## AVDataSrcDescriptor<sup>10+</sup> 28 29音视频文件资源描述，用于DataSource播放方式，使用场景：应用在未获取完整音视频资源时，允许用户创建播放实例并开始播放，达到提前播放的目的。 30 31**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 32 33**系统能力：** SystemCapability.Multimedia.Media.AVPlayer 34 35| 名称 | 类型 | 必填 | 说明 | 36| ------ | ------ | ---- | ------------------------------------------------------------ | 37| fileSize | number | 是 | 待播放文件大小（字节），-1代表大小未知。如果fileSize设置为-1, 播放模式类似于直播，不能进行seek及setSpeed操作，不能设置loop属性，因此不能重新播放。 | 38| callback | (buffer: ArrayBuffer, length: number, pos?: number) => number | 是 | 用户设置的回调函数，用于填写数据。<br>- 函数列式：callback: (buffer: ArrayBuffer, length: number, pos?:number) => number;<br>- buffer，ArrayBuffer类型，表示被填写的内存，必选。<br>- length，number类型，表示被填写内存的最大长度，必选。<br>- pos，number类型，表示填写的数据在资源文件中的位置，可选，当fileSize设置为-1时，该参数禁止被使用。 <br>- 返回值，number类型，返回填充数据的长度，返回-1表示到达流的末尾，返回-2表示遇到不可恢复的错误。| 39 40## SubtitleInfo<sup>12+</sup> 41 42外挂字幕信息，使用场景：订阅外挂字幕事件，回调返回外挂字幕详细信息。 43 44**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 45 46**系统能力：** SystemCapability.Multimedia.Media.Core 47 48| 名称 | 类型 | 必填 | 说明 | 49| ------ | ------ | ---- | ------------------------------------------------------------ | 50| text | string | 否 | 字幕文本信息。 | 51| startTime | number | 否 | 显示当前字幕文本的开始时间（单位：毫秒）。 | 52| duration | number | 否 | 显示当前字幕文本的持续时间（单位：毫秒）。 | 53 54## SeiMessage<sup>18+</sup> 55 56SEI信息内容，描述SEI信息的负载类型和数据。 57 58**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 59 60**系统能力：** SystemCapability.Multimedia.Media.Core 61 62| 名称 | 类型 | 只读 | 可选 | 说明 | 63| ------ | ------ | ---- | ---- | ------------------------------------------------------------ | 64| payloadType | number | 否 | 否 | SEI信息的负载类型。 | 65| payload | ArrayBuffer | 否 | 否 | SEI信息的负载数据。 | 66 67## MediaDescription<sup>8+</sup> 68 69通过key-value方式获取媒体信息。 70 71**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 72 73**系统能力：** SystemCapability.Multimedia.Media.Core 74 75| 名称 | 类型 | 必填 | 说明 | 76| ------------- | ------ | ---- | ------------------------------------------------------------ | 77| [key: string] | Object | 是 | 该键值对支持的key取值范围，请参考[MediaDescriptionKey](arkts-apis-media-e.md#mediadescriptionkey8)；每个key值的Object类型和范围，请参考[MediaDescriptionKey](arkts-apis-media-e.md#mediadescriptionkey8)对应Key值的说明。 | 78 79**示例：** 80 81```ts 82import { BusinessError } from '@kit.BasicServicesKit'; 83import { media } from '@kit.MediaKit'; 84 85function printfItemDescription(obj: media.MediaDescription, key: string) { 86 let property: Object = obj[key]; 87 console.info('audio key is ' + key); // 通过key值获取对应的value。key值具体可见MediaDescriptionKey。 88 console.info('audio value is ' + property); //对应key值得value。其类型可为任意类型，具体key对应value的类型可参考MediaDescriptionKey。 89} 90 91let avPlayer: media.AVPlayer | undefined = undefined; 92media.createAVPlayer((err: BusinessError, player: media.AVPlayer) => { 93 if(player != null) { 94 avPlayer = player; 95 console.info(`Succeeded in creating AVPlayer`); 96 avPlayer.getTrackDescription((error: BusinessError, arrList: Array<media.MediaDescription>) => { 97 if (arrList != null) { 98 for (let i = 0; i < arrList.length; i++) { 99 printfItemDescription(arrList[i], media.MediaDescriptionKey.MD_KEY_TRACK_TYPE); //打印出每条轨道MD_KEY_TRACK_TYPE的值。 100 } 101 } else { 102 console.error(`Failed to get TrackDescription, error:${error}`); 103 } 104 }); 105 } else { 106 console.error(`Failed to create AVPlayer, error message:${err.message}`); 107 } 108}); 109``` 110 111## PlaybackInfo<sup>12+</sup> 112 113通过key-value方式获取播放信息。 114 115**系统能力：** SystemCapability.Multimedia.Media.Core 116 117| 名称 | 类型 | 必填 | 说明 | 118| ------------- | ------ | ---- | ------------------------------------------------------------ | 119| [key: string]| Object | 是 | 该键值对支持的key取值范围，请参考[PlaybackInfoKey](arkts-apis-media-e.md#playbackinfokey12);每个key值的Object类型和范围，请参考[PlaybackInfoKey](arkts-apis-media-e.md#playbackinfokey12)对应Key值的说明。 | 120 121## AVRecorderConfig<sup>9+</sup> 122 123表示音视频录制的参数设置。 124 125通过audioSourceType和videoSourceType区分纯音频录制、纯视频录制或音视频录制。纯音频录制时，仅需要设置audioSourceType；纯视频录制时，仅需要设置videoSourceType；音视频录制时，audioSourceType和videoSourceType均需要设置。 126 127**系统能力：** SystemCapability.Multimedia.Media.AVRecorder 128 129| 名称 | 类型 | 必填 | 说明 | 130| --------------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | 131| audioSourceType | [AudioSourceType](arkts-apis-media-e.md#audiosourcetype9) | 否 | 选择录制的音频源类型。选择音频录制时必填。<br> **原子化服务API：** 从API version 12 开始，该接口支持在原子化服务中使用。| 132| videoSourceType | [VideoSourceType](arkts-apis-media-e.md#videosourcetype9) | 否 | 选择录制的视频源类型。选择视频录制时必填。 | 133| profile | [AVRecorderProfile](#avrecorderprofile9) | 是 | 录制的profile，必要参数。<br> **原子化服务API：** 从API version 12 开始，该接口支持在原子化服务中使用。| 134| url | string | 是 | 录制输出URL：fd://xx (fd number) ，必要参数。 <br> **原子化服务API：** 从API version 12 开始，该接口支持在原子化服务中使用。 | 135|fileGenerationMode<sup>12+</sup> | [FileGenerationMode](arkts-apis-media-e.md#filegenerationmode12) | 否 | 创建媒体文件的模式，配合[on('photoAssetAvailable')](arkts-apis-media-AVRecorder.md#onphotoassetavailable12)监听使用。| 136| rotation<sup>(deprecated)</sup> | number | 否 | 录制的视频旋转角度，mp4格式支持0，90，180，270，默认值为0。<br>从API version 6开始支持，从API version 12开始废弃。建议使用[AVMetadata](#avmetadata11).videoOrientation替代。如果同时设置两个值，将会采用[AVMetadata](#avmetadata11).videoOrientation。 | 137| location<sup>(deprecated)</sup> | [Location](#location) | 否 | 录制的地理位置，默认不记录地理位置信息。<br>从API version 6开始支持，从API version 12开始废弃。建议使用 [AVMetadata](#avmetadata11).location。如果同时设置两个值，将会采用[AVMetadata](#avmetadata11).location。 | 138| metadata<sup>12+</sup> | [AVMetadata](#avmetadata11) | 否 | 设置元数据信息。详情见 [AVMetadata](#avmetadata11)。 | 139| maxDuration<sup>18+</sup> | number | 否 | 设置录制的最大时长，单位为秒，有效值取值范围[1 , 2^31-1]，无效输入会重置为最大值。录制到达设定时长后，录制会自动停止，并通过stateChange回调录制状态，[AVRecorderState](arkts-apis-media-t.md#avrecorderstate9) = 'stopped'，[StateChangeReason](arkts-apis-media-e.md#statechangereason9) = BACKGROUND。| 140 141## AVRecorderProfile<sup>9+</sup> 142 143音视频录制的配置文件。 144 145**系统能力：** SystemCapability.Multimedia.Media.AVRecorder 146 147| 名称 | 类型 | 必填 | 说明 | 148| ---------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | 149| audioBitrate | number | 否 | 音频编码比特率，选择音频录制时必填。<br>支持范围：<br>- AAC编码格式支持比特率范围[32000 - 500000]。<br>- G711-mulaw编码格式支持比特率范围[64000]。<br>- MP3编码格式支持范围[8000, 16000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000]。<br>当使用MP3编码格式时，采样率和比特率的映射关系： <br>- 采样率使用16K以下时，对应比特率范围为[8000 - 64000]。<br>- 采样率使用16K~32K时对应的比特率范围为[8000 - 160000]。<br>- 采样率使用32K以上时对应的比特率范围为[32000 - 320000]。<br>- AMR_NB编码格式支持比特率范围[4750, 5150, 5900, 6700, 7400, 7950, 10200, 12200]。<br>- AMR_WB编码格式支持比特率范围[6600, 8850, 12650, 14250, 15850, 18250, 19850, 23050, 23850]。<br> **原子化服务API：** 从API version 12 开始，该接口支持在原子化服务中使用。 | 150| audioChannels | number | 否 | 音频采集声道数，选择音频录制时必填。<br>- AAC编码格式支持范围[1 - 8]。<br>- G711-mulaw编码格式支持范围[1]。<br>- MP3编码格式支持范围[1 - 2]。<br>- AMR-NB、AMR-WB编码格式支持范围[1]。<br> **原子化服务API：** 从API version 12 开始，该接口支持在原子化服务中使用。 | 151| audioCodec | [CodecMimeType](arkts-apis-media-e.md#codecmimetype8) | 否 | 音频编码格式，选择音频录制时必填。当前支持AUDIO_AAC，AUDIO_MP3，AUDIO_G711MU, AUDIO_AMR_NB, AUDIO_AMR_WB。<br> **原子化服务API：** 从API version 12 开始，该接口支持在原子化服务中使用。 | 152| audioSampleRate | number | 否 | 音频采样率，选择音频录制时必填。<br>支持范围：<br>- AAC编码支持采样率范围[8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000]。<br>- G711-mulaw编码支持采样率范围[8000]。<br>- MP3编码支持采样率范围[8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000]。<br>- AMR_NB编码支持采样率范围[8000]。<br>- AMR_WB编码支持采样率范围[16000]。<br>可变比特率模式，码率仅作参考。<br> **原子化服务API：** 从API version 12 开始，该接口支持在原子化服务中使用。 | 153| fileFormat | [ContainerFormatType](arkts-apis-media-e.md#containerformattype8) | 是 | 文件的容器格式，必要参数。当前支持MP4、M4A、MP3、WAV、AMR、AAC封装格式，当前AAC音频封装默认为ADTS帧头格式。不支持在MP4封装格式下使用AUDIO_MP3编码格式。<br>**原子化服务API：** 从API version 12 开始，该接口支持在原子化服务中使用。| 154| videoBitrate | number | 否 | 视频编码比特率，选择视频录制时必填，支持范围[10000 - 100000000]。 | 155| videoCodec | [CodecMimeType](arkts-apis-media-e.md#codecmimetype8) | 否 | 视频编码格式，选择视频录制时必填。当前支持VIDEO_AVC和VIDEO_HEVC。| 156| videoFrameWidth | number | 否 | 视频帧的宽，选择视频录制时必填，支持范围[176 - 4096]。 | 157| videoFrameHeight | number | 否 | 视频帧的高，选择视频录制时必填，支持范围[144 - 4096]。 | 158| videoFrameRate | number | 否 | 视频帧率，选择视频录制时必填，推荐范围[1 - 60]。 | 159| isHdr<sup>11+</sup> | boolean | 否 | HDR编码，选择视频录制时选填，isHdr默认为false，对应编码格式没有要求，isHdr为true时，对应的编码格式必须为video/hevc。| 160| enableTemporalScale<sup>12+</sup> | boolean | 否 | 视频录制是否支持时域分层编码功能，选择视频录制时选填，enableTemporalScale默认为false。设置为true时，编码输出的码流中部分帧可以支持跳过不编码。| 161| enableBFrame<sup>20+</sup> | boolean | 否 | 视频录制是否启用B帧编码。true表示启用B帧编码（仅在视频编码格式为H.265且设备硬件支持的情况下生效），false表示不启用B帧编码。<br>该参数为视频录制场景下的可选项，默认值为false。| 162 163### 音频参数配置对照表 164 165此处提供音频参数配置的对照表，每项的具体释义，可查看下述字段解释。 166 167|编码格式|封装格式|采样率|比特率|声道数| 168|----|----|----|----|----| 169|AUDIO_AAC|MP4,M4A|[8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000]|[32000-500000]|[1-8]| 170|AUDIO_MP3|MP3|[8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000]|<br>- 采样率使用16000以下时，对应比特率范围为[8000, 16000, 32000, 40000, 48000, 56000, 64000]。<br>- 采样率使用16000~32000时对应的比特率范围为[8000, 16000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000]。<br>- 采样率使用32000以上时对应的比特率范围为[32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000]。|[1-2]| 171|AUDIO_G711MU|WAV|[8000]|[64000]|[1]| 172|AUDIO_AMR_NB<sup>18+</sup> |AMR|[8000]|[4750, 5150, 5900, 6700, 7400, 7950, 10200, 12200]|[1]| 173|AUDIO_AMR_WB<sup>18+</sup> |AMR|[16000]|[6600, 8850, 12650, 14250, 15850, 18250, 19850, 23050, 23850]|[1]| 174 175 176## Location 177 178视频录制的地理位置。 179 180**系统能力：** SystemCapability.Multimedia.Media.Core 181 182| 名称 | 类型 | 必填 | 说明 | 183| --------- | ------ | ---- | ---------------- | 184| latitude | number | 是 | 地理位置的纬度，取值范围为[-90, 90]。 | 185| longitude | number | 是 | 地理位置的经度，取值范围为[-180, 180]。 | 186 187## EncoderInfo<sup>11+</sup> 188 189编码器和规格参数。 190 191系统能力：SystemCapability.Multimedia.Media.AVRecorder 192 193| 名称 | 类型 | 只读 | 可选 | 说明 | 194| ---------- | -------------------------------- | ---- | ---- | ------------------------------------------------------------ | 195| mimeType | [CodecMimeType](arkts-apis-media-e.md#codecmimetype8) | 否 | 否 | 编码器MIME类型名称。 | 196| type | string | 否 | 否 | 编码器类型，audio表示音频编码器，video表示视频编码器。 | 197| bitRate | [Range](#range11) | 否 | 是 | 比特率，包含该编码器的最大和最小值。 | 198| frameRate | [Range](#range11) | 否 | 是 | 视频帧率，包含帧率的最大和最小值，仅视频编码器拥有。 | 199| width | [Range](#range11) | 否 | 是 | 视频帧的宽度，包含宽度的最大和最小值，仅视频编码器拥有。 | 200| height | [Range](#range11) | 否 | 是 | 视频帧的高度，包含高度的最大和最小值，仅视频编码器拥有。 | 201| channels | [Range](#range11) | 否 | 是 | 音频采集声道数，包含声道数的最大和最小值，仅音频编码器拥有。 | 202| sampleRate | Array\<number> | 否 | 是 | 音频采样率，包含所有可以使用的音频采样率值数组，具体数值依赖编码器类型，仅音频编码器拥有。 | 203 204## Range<sup>11+</sup> 205 206表示一个类型的范围。 207 208系统能力：SystemCapability.Multimedia.Media.AVRecorder 209 210| 名称 | 类型 | 只读 | 可选 | 说明 | 211| ---- | ------ | ---- | ---- | ------------ | 212| min | number | 否 | 否 | 范围的最小值。 | 213| max | number | 否 | 否 | 范围的最大值。 | 214 215## AVTranscoderConfig<sup>12+</sup> 216 217表示视频转码的参数设置。 218 219**系统能力：** SystemCapability.Multimedia.Media.AVTranscoder 220 221| 名称 | 类型 | 只读 | 可选 | 说明 | 222| --------------- | ---------------------------------------- |---- | ---- | ------------------------------------------------------------ | 223| audioBitrate | number | 否 | 是 | 输出音频的码率，单位为比特率（bps），支持范围[1-500000]。默认设置为48Kbps。| 224| audioCodec | [CodecMimeType](arkts-apis-media-e.md#codecmimetype8) | 否 | 是 | 输出音频的编码格式，当前仅支持AAC。默认设置为AAC。 | 225| fileFormat | [ContainerFormatType](arkts-apis-media-e.md#containerformattype8) | 否 | 否 | 输出视频文件的封装格式，当前视频文件仅支持MP4。| 226| videoBitrate | number | 否 | 是 | 输出视频的码率，单位为比特率（bps）。默认码率按输出视频的分辨率设置，[240p，480P]默认码率值为1Mbps，(480P,720P]默认码率值为2Mbps，(720P,1080P]默认码率值为4Mbps，1080P及以上默认值为8Mbps。| 227| videoCodec | [CodecMimeType](arkts-apis-media-e.md#codecmimetype8) | 否 | 是 | 输出视频的编码格式，当前仅支持AVC和HEVC。若源视频编码格式为HEVC，则默认设置为HEVC，否则默认设置为AVC。| 228| videoFrameWidth | number | 否 | 是 | 输出视频帧的宽，单位为像素（px），支持范围[240-3840]。默认设置为源视频帧的宽。| 229| videoFrameHeight | number | 否 | 是 | 输出视频帧的高，单位为像素（px），支持范围[240-2160]。默认设置为源视频帧的高。| 230| enableBFrame<sup>20+</sup> | boolean | 否 | 是 | 转码使能B帧编码。true表示开启B帧编码，默认为不开启B帧编码。<br>B帧视频编码相关的约束和限制可以参考文档[B帧视频编码约束和限制](../../media/avcodec/video-encoding-b-frame.md#约束和限制)。如果当前不符合B帧视频编码的约束和限制，将忽略B帧，按不使能B帧进行编码。| 231 232 233## AVMetadata<sup>11+</sup> 234 235音视频元数据，包含各个元数据字段。在[AVRecorderConfig](#avrecorderconfig9)中使用时未声明为当前版本只读的参数可以作为使用[AVRecorder](arkts-apis-media-AVRecorder.md)录制时的入参。 236 237**系统能力：** SystemCapability.Multimedia.Media.AVMetadataExtractor 238 239| 名称 | 类型 | 必填 | 说明 | 240| ------ | ------ | ---- | ------------------------------------------------------------ | 241| album | string | 否 | 专辑的标题。当前版本为只读参数。 | 242| albumArtist | string | 否 | 专辑的艺术家。当前版本为只读参数。 | 243| artist | string | 否 | 媒体资源的艺术家。当前版本为只读参数。 | 244| author | string | 否 | 媒体资源的作者。当前版本为只读参数。 | 245| dateTime | string | 否 | 媒体资源的创建时间。当前版本为只读参数。 | 246| dateTimeFormat | string | 否 | 媒体资源的创建时间，按YYYY-MM-DD HH:mm:ss格式输出。当前版本为只读参数。 | 247| composer | string | 否 | 媒体资源的作曲家。当前版本为只读参数。 | 248| duration | string | 否 | 媒体资源的时长。当前版本为只读参数。 | 249| genre | string | 否 | 媒体资源的类型或体裁。| 250| hasAudio | string | 否 | 媒体资源是否包含音频。当前版本为只读参数。 | 251| hasVideo | string | 否 | 媒体资源是否包含视频。当前版本为只读参数。 | 252| mimeType | string | 否 | 媒体资源的mime类型。当前版本为只读参数。 | 253| trackCount | string | 否 | 媒体资源的轨道数量。当前版本为只读参数。 | 254| sampleRate | string | 否 | 音频的采样率，单位为赫兹（Hz）。当前版本为只读参数。 | 255| title | string | 否 | 媒体资源的标题。当前版本为只读参数。当前版本为只读参数。 | 256| videoHeight | string | 否 | 视频的高度，单位为像素。当前版本为只读参数。 | 257| videoWidth | string | 否 | 视频的宽度，单位为像素。当前版本为只读参数。 | 258| videoOrientation | string | 否 | 视频的旋转方向，单位为度（°）。| 259| hdrType<sup>12+</sup> | [HdrType](arkts-apis-media-e.md#hdrtype12) | 否 | 媒体资源的HDR类型。当前版本为只读参数。 | 260| location<sup>12+</sup> | [Location](#location) | 否 | 视频的地理位置信息。 | 261| customInfo<sup>12+</sup> | Record<string, string> | 否 | 从moov.meta.list 获取的自定义参数键值映射。| 262| tracks<sup>20+</sup> | Array\<[MediaDescription](#mediadescription8)> | 否 | 媒体资源的轨道信息。当前版本为只读参数。| 263 264### AVMetadata.tracks支持的MediaDescriptionKey说明 265 266AVMetadata.tracks支持的[MediaDescriptionKey](arkts-apis-media-e.md#mediadescriptionkey8)的范围如下： 267 268| 名称 | 值 | 适用的轨道类型 | 269| -------- | --------------------|------------------------ | 270| MD_KEY_TRACK_INDEX | 'track_index' | 全部 | 271| MD_KEY_TRACK_TYPE | 'track_type' | 全部 | 272| MD_KEY_CODEC_MIME | 'codec_mime' | 音频、视频 | 273| MD_KEY_WIDTH | 'width' | 视频 | 274| MD_KEY_HEIGHT | 'height' | 视频 | 275| MD_KEY_FRAME_RATE | 'frame_rate' | 视频 | 276| MD_KEY_AUD_CHANNEL_COUNT | 'channel_count' | 音频 | 277| MD_KEY_AUD_SAMPLE_RATE | 'sample_rate' | 音频 | 278| MD_KEY_HDR_TYPE | 'hdr_type' | 视频 | 279 280## PixelMapParams<sup>12+</sup> 281 282获取视频缩略图时，输出缩略图的格式参数。 283 284**系统能力：** SystemCapability.Multimedia.Media.AVImageGenerator 285 286| 名称 | 类型 | 只读 | 可选 | 说明 | 287|--------|--------|------|------|---------------------------------------------------------------------------------| 288| width | number | 否 | 是 | 输出的缩略图宽度。应保证大于0且不大于原始视频宽度。否则返回的缩略图不会进行缩放。 | 289| height | number | 否 | 是 | 输出的缩略图高度。应保证大于0且不大于原始视频高度。否则返回的缩略图不会进行缩放。 | 290 291## OutputSize<sup>20+</sup> 292 293用于获取视频缩略图时，来定义输出图像大小。 294 295**系统能力：** SystemCapability.Multimedia.Media.AVImageGenerator 296 297| 名称 | 类型 | 只读 | 可选 | 说明 | 298| ------ | ------ | ---- | ---- | ------------------------------------------------------------ | 299| width | number | 否 | 是 | 输出的缩略图宽度。<br/>- 如果该值小于0，宽度是视频的原始宽度。<br/>- 如果值为0或未分配任何值，缩放比例同高度比例。<br/>- 如果宽度和高度均未分配任意值，则输出原始视频帧的宽度和高度。 | 300| height | number | 否 | 是 | 输出的缩略图高度。<br/>- 如果该值小于0，高度是视频的原始高度。<br/>- 如果值为0或未分配任何值，缩放比例同宽度比例。<br/>- 如果宽度和高度均未分配任意值，则输出原始视频帧的宽度和高度。 | 301 302## MediaStream<sup>19+</sup> 303 304媒体流数据信息。 305 306**原子化服务API：** 从API version 19开始，该接口支持在原子化服务中使用。 307 308**系统能力：** SystemCapability.Multimedia.Media.Core 309 310| 名称 | 类型 | 只读 | 可选 | 说明 | 311| ------- | ------ | ---- | ---- | ------------------------------------------------------------ | 312| url | string | 否 | 否 | 媒体资源链接，当前仅支持http或者https。 | 313| width | number | 否 | 否 | 媒体资源视频宽像素值。未知时可以填0，此时将无法通过[PlaybackStrategy](#playbackstrategy12)优选匹配。 | 314| height | number | 否 | 否 | 媒体资源视频高像素值。未知时可以填0，此时将无法通过[PlaybackStrategy](#playbackstrategy12)优选匹配。 | 315| bitrate | number | 否 | 否 | 媒体资源码率值，单位bps。 | 316 317## MediaSourceLoader<sup>18+</sup> 318 319用于定义媒体数据加载器，需要应用程序对其进行实现。 320 321**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 322 323**系统能力：** SystemCapability.Multimedia.Media.Core 324 325| 名称 | 类型 | 必填 | 说明 | 326| -------- | -------- | ---- | -------------------- | 327| open | [SourceOpenCallback](arkts-apis-media-t.md#sourceopencallback18) | 是 | 由应用程序实现的回调函数，用于处理资源打开请求。 | 328| read | [SourceReadCallback](arkts-apis-media-t.md#sourcereadcallback18) | 是 | 由应用程序实现的回调函数，用于处理资源读取请求。 | 329| close | [SourceCloseCallback](arkts-apis-media-t.md#sourceclosecallback18) | 是 | 由应用程序实现的回调函数，用于处理资源关闭请求。 | 330 331**示例：** 332 333```ts 334import HashMap from '@ohos.util.HashMap'; 335 336let headers: Record<string, string> = {"User-Agent" : "User-Agent-Value"}; 337let mediaSource : media.MediaSource = media.createMediaSourceWithUrl("http://xxx", headers); 338let uuid: number = 1; 339let requests: HashMap<number, media.MediaSourceLoadingRequest> = new HashMap(); 340let mediaSourceLoader: media.MediaSourceLoader = { 341 open: (request: media.MediaSourceLoadingRequest) => { 342 console.log(`Opening resource: ${request.url}`); 343 // 成功打开资源，返回唯一的句柄, 保证uuid和request对应。 344 uuid += 1; 345 requests.set(uuid, request); 346 return uuid; 347 }, 348 read: (uuid: number, requestedOffset: number, requestedLength: number) => { 349 console.log(`Reading resource with handle ${uuid}, offset: ${requestedOffset}, length: ${requestedLength}`); 350 // 判断uuid是否合法、存储read请求，不要在read请求阻塞去推送数据和头信息。 351 }, 352 close: (uuid: number) => { 353 console.log(`Closing resource with handle ${uuid}`); 354 // 清除当前uuid相关资源。 355 requests.remove(uuid); 356 } 357}; 358 359mediaSource.setMediaResourceLoaderDelegate(mediaSourceLoader); 360let playStrategy : media.PlaybackStrategy = { 361 preferredBufferDuration: 20, 362}; 363 364async function setupPlayer() { 365 let player = await media.createAVPlayer(); 366 player.setMediaSource(mediaSource, playStrategy); 367} 368``` 369 370## PlaybackStrategy<sup>12+</sup> 371 372播放策略。 373 374**系统能力：** SystemCapability.Multimedia.Media.Core 375 376| 名称 | 类型 | 必填 | 说明 | 377| -------- | -------- | ---- | -------------------- | 378| preferredWidth| number | 否 | 播放策略首选宽度，设置范围为大于0的整数，如1080，单位为像素（px）。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 379| preferredHeight | number | 否 | 播放策略首选高度，设置范围为大于0的整数，如1920，单位为像素（px）。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 380| preferredBufferDuration | number | 否 | 播放策略首选缓冲持续时间，单位s，取值范围1-20。<br>具体使用方式可参考[在线视频播放卡顿优化实践](https://developer.huawei.com/consumer/cn/doc/best-practices/bpta-online-video-playback-lags-practice)。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 381| preferredHdr | boolean | 否 | 播放策略true是hdr，false非hdr，默认非hdr。<br>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 382| enableSuperResolution<sup>18+</sup> | boolean | 否 | 表示是否使能超分功能。true表示使能超分，false表示不使能超分，默认为false。<br>若不使能超分，则后续不能调用超分相关接口。若使能超分，则超分功能默认开启，默认目标分辨率为1920x1080，单位为像素。<br>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 | 383| showFirstFrameOnPrepare<sup>17+</sup> | boolean | 否 | 播放策略true是Prepare之后显示视频起播首帧，false是Prepare之后不显示视频起播首帧，默认不显示。<br>**原子化服务API：** 从API version 17开始，该接口支持在原子化服务中使用。 | 384| mutedMediaType | [MediaType](arkts-apis-media-e.md#mediatype8) | 否 | 关闭输出的媒体类型。<br>API 12-19，仅支持设置MediaType.MEDIA_TYPE_AUD。API 20起，增加支持MediaType.MEDIA_TYPE_VID。 | 385| preferredAudioLanguage<sup>13+</sup> | string | 否 | 播放策略首选音轨语言。dash场景下应用可按需设置。非dash场景暂不支持，建议缺省。<br>**原子化服务API：** 从API version 13开始，该接口支持在原子化服务中使用。 | 386| preferredSubtitleLanguage<sup>13+</sup> | string | 否 | 播放策略首选字幕语言。dash场景下应用可按需设置。非dash场景暂不支持，建议缺省。<br>**原子化服务API：** 从API version 13开始，该接口支持在原子化服务中使用。 | 387| preferredBufferDurationForPlaying<sup>18+</sup> | number | 否 | 播放策略首选起播缓冲水线。当起播缓冲时间超过该值，开始播放。单位s，取值范围0-20。<br>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 | 388| thresholdForAutoQuickPlay<sup>18+</sup> | number | 否 | 智能追帧水线，单位为s，取值应不小于2s，且需大于起播缓冲水线，默认设置为5s。<br>播放策略可以通过设置智能追帧水线来保证直播的实时性。flv直播场景下应用可按需设置，非flv直播场景暂不支持。网络状态的变化可能会导致播放器在某段时间内积压大量数据。播放器会定期检查当前播放时间与缓存中最新的帧时间戳之间的差值，当这个差值过大时，播放器将以1.2倍速开始智能追帧。[speedDone事件](arkts-apis-media-AVPlayer.md#onspeeddone9)会回调特定值100，表示智能追帧开启成功。当差值小于起播缓冲水线时，则停止追帧并恢复到正常播放速度。<br>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 | 389| keepDecodingOnMute<sup>20+</sup> | boolean | 否 | 表示在关闭视频媒体时解码器是否继续运行，用于方便快速打开媒体。目前仅支持视频。默认设置为false，表示当媒体关闭时，相应的解码器将停止运行以减少功耗。<br>**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 390 391## AVScreenCaptureStrategy<sup>20+</sup> 392 393录屏策略。 394 395**系统能力：** SystemCapability.Multimedia.Media.AVScreenCapture 396 397| 名称 | 类型 | 只读 | 可选 | 说明 | 398| --------------------- | ------- | --- | --- | -------------------- | 399| keepCaptureDuringCall | boolean | 否 | 是 | 蜂窝通话时是否保持录屏。 | 400| enableBFrame | boolean | 否 | 是 | 录屏是否使能B帧编码。true表示录屏文件使能B帧编码，false表示录屏文件禁用B帧编码，默认是false。<br>B帧视频编码相关的约束和限制可以参考文档[B帧视频编码约束和限制](../../media/avcodec/video-encoding-b-frame.md#约束和限制)。如果当前不符合B帧视频编码的约束和限制，则正常录制不含B帧的视频，不会返回错误。 | 401 402## AVScreenCaptureRecordConfig<sup>12+</sup> 403 404表示录屏参数配置。 405 406**系统能力：** SystemCapability.Multimedia.Media.AVScreenCapture 407 408| 名称 | 类型 | 必填 | 说明 | 409| ----------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | 410| fd | number | 是 | 录制输出的文件fd。 | 411| frameWidth | number | 否 | 录屏的视频宽度，默认屏幕宽度，根据不同屏幕默认值不同，单位px。 | 412| frameHeight | number | 否 | 录屏的视频高度，默认屏幕高度，根据不同屏幕默认值不同，单位px。 | 413| videoBitrate | number | 否 | 录屏的视频比特率，默认10000000。 | 414| audioSampleRate | number | 否 | 录屏的音频采样率，内录的系统音和外录的麦克风都是用此采样率，默认48000，仅支持设置48000或16000。 | 415| audioChannelCount | number | 否 | 录屏的音频通道数，内录的系统音和外录的麦克风都是用此通道数，默认2声道，仅支持设置1或2声道。 | 416| audioBitrate | number | 否 | 录屏的音频比特率，内录的系统音和外录的麦克风都是用此比特率，默认96000。 | 417| preset | [AVScreenCaptureRecordPreset](arkts-apis-media-e.md#avscreencapturerecordpreset12) | 否 | 录屏使用的编码和封装格式，默认SCREEN_RECORD_PRESET_H264_AAC_MP4格式。 | 418| displayId<sup>15+</sup> | number | 否 | 指定录屏使用的屏幕，默认主屏幕。 | 419| fillMode<sup>18+</sup> | [AVScreenCaptureFillMode](arkts-apis-media-e.md#avscreencapturefillmode18)| 否 | 录屏时视频流的填充模式。 | 420| strategy<sup>20+</sup> | [AVScreenCaptureStrategy](#avscreencapturestrategy20)| 否 | 录屏策略。 | 421 422## AudioRecorderConfig<sup>(deprecated)</sup> 423 424> **说明：** 425> 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorderConfig](#avrecorderconfig9)替代。 426 427表示音频的录音配置。 428 429**系统能力：** SystemCapability.Multimedia.Media.AudioRecorder 430 431| 名称 | 类型 | 必填 | 说明 | 432| ----------------------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | 433| audioEncoder | [AudioEncoder](arkts-apis-media-e.md#audioencoderdeprecated) | 否 | 音频编码格式，默认设置为AAC_LC。<br/>**说明：** 从API version 6开始支持，从API version 8开始废弃，建议使用audioEncoderMime替代。 | 434| audioEncodeBitRate | number | 否 | 音频编码比特率，默认值为48000。<br/>**说明：** 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorderProfile](#avrecorderprofile9)中的audioBitrate替代。 | 435| audioSampleRate | number | 否 | 音频采集采样率，默认值为48000。<br>可变比特率模式，码率仅作参考。<br/>**说明：** 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorderProfile](#avrecorderprofile9)中的audioSampleRate替代。 | 436| numberOfChannels | number | 否 | 音频采集声道数，默认值为2。<br/>**说明：** 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorderProfile](#avrecorderprofile9)中的audioChannels替代。 | 437| format | [AudioOutputFormat](arkts-apis-media-e.md#audiooutputformatdeprecated) | 否 | 音频输出封装格式，默认设置为MPEG_4。<br/>**说明：** 从API version 6开始支持，从API version 8开始废弃，建议使用fileFormat替代。 | 438| location | [Location](#location) | 否 | 音频采集的地理位置。<br/>**说明：** 从API version 6开始支持，从API version 9开始废弃，建议使用[AVMetadata](#avmetadata11)中的location替代。 | 439| uri | string | 是 | 音频输出URI：fd://xx (fd number)<br/> <br/>文件需要由调用者创建，并赋予适当的权限。<br/>**说明：** 从API version 6开始支持，从API version 9开始废弃，建议使用[AVRecorderConfig](#avrecorderconfig9)中的url替代。 | 440| audioEncoderMime<sup>8+</sup> | [CodecMimeType](arkts-apis-media-e.md#codecmimetype8) | 否 | 容器编码格式。<br/>**说明：** 从API version 8开始支持，从API version 9开始废弃，建议使用[AVRecorderProfile](#avrecorderprofile9)中的audioCodec替代。 | 441| fileFormat<sup>8+</sup> | [ContainerFormatType](arkts-apis-media-e.md#containerformattype8) | 否 | 音频编码格式。<br/>**说明：** 从API version 8开始支持，从API version 9开始废弃，建议使用[AVRecorderProfile](#avrecorderprofile9)中的fileFormat替代。 |
