openharmony 鸿蒙 arkts-apis-avsession-i

2026-08-25 浏览 (1)

Interfaces (其他)

说明:

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

AVCastControlCommand10+

投播控制器接受的命令的对象描述。

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

系统能力: SystemCapability.Multimedia.AVSession.AVCast

名称类型只读可选说明
commandAVCastControlCommandType命令。每种命令对应的参数不同,具体的对应关系可查阅AVCastControlCommandType
parametermedia.PlaybackSpeed | number | string | LoopMode命令对应的参数。

CastDisplayInfo12+

扩展屏投播显示设备相关属性。

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

系统能力: SystemCapability.Multimedia.AVSession.ExtendedDisplayCast

名称类型只读可选说明
idnumber投播显示设备的ID,该参数应为整数。
namestring投播显示设备的名称。
stateCastDisplayState投播显示设备状态。
widthnumber投播显示设备的屏幕宽度,单位为px,该参数应为整数。
heightnumber投播显示设备的屏幕高度,单位为px,该参数应为整数。

AVMetadata10+

媒体元数据的相关属性。

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

名称类型只读可选说明
assetIdstring媒体ID。媒体信息的唯一标识,由应用自定义。
- 该属性发生变化则其他元数据属性都将被刷新。
- 若该属性维持不变,且不设置相应的媒体元数据信息,那么将不会更新对应的媒体元数据信息。
- 当该属性设为空值时,调用setAVMetadata方法将失败,返回错误码6600101。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
titlestring标题。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
artiststring艺术家。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
authorstring专辑作者。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
avQueueName12+string歌单(歌曲列表)名称。
avQueueId11+string歌单(歌曲列表)唯一标识Id。
avQueueImage11+image.PixelMap | string歌单(歌曲列表)封面图。
图片的像素数据或者图片路径地址(本地路径或网络路径)。应用通过setAVMetadata设置图片数据。
- 设置的数据类型为PixelMap时,通过getAVMetadata获取的将为PixelMap。
- 设置为url图片路径,获取的为url图片路径。
albumstring专辑名称。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
writerstring词作者。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
composerstring作曲者。
durationnumber媒体时长,单位毫秒(ms)。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
mediaImageimage.PixelMap | string图片的像素数据或者图片路径地址(本地路径或网络路径)。应用通过setAVMetadata设置图片数据。
- 设置的数据类型为PixelMap时,通过getAVMetadata获取的将为PixelMap。
- 设置为url图片路径,获取的为url图片路径。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
bundleIcon18+image.PixelMap应用图标图片的像素数据。只读类型,不从应用侧设置。
publishDateDate发行日期。
subtitlestring子标题。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
descriptionstring媒体描述。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
lyricstring媒体歌词内容。应用需将歌词内容拼接为一个字符串传入。
字符串长度需小于40960字节。
说明: 系统支持简单版的LRC格式(Simple LRC format)的歌词文本内容。当传入的歌词内容不规范(例如:出现重复的时间戳等),将导致解析失败,并在系统中显示异常。
singleLyricText17+string单条媒体歌词内容。应用需将歌词内容拼接为一个字符串传入(不包含时间戳)。
字符串长度小于40960字节。
原子化服务API: 从API version 17开始,该接口支持在原子化服务中使用。
previousAssetIdstring上一首媒体ID。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
nextAssetIdstring下一首媒体ID。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
filter11+number当前session支持的协议,默认为TYPE_CAST_PLUS_STREAM。具体取值参考ProtocolType
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
drmSchemes12+Array<string>当前session支持的DRM方案,取值为DRM方案uuid。
skipIntervals11+SkipIntervals快进快退支持的时间间隔。默认为SECONDS_15,即15秒。
displayTags11+number媒体资源的金标类型,取值参考DisplayTag
rewindSkipIntervalsSkipIntervals快退支持的时间间隔。默认为SECONDS_15,即15秒。
系统会使用此值作为快退操作的时间间隔,而非skipIntervals的值。
若未设置此参数,快退操作的时间间隔仍会沿用skipIntervals的值。
模型约束: 此接口仅可在Stage模型下使用。
起始版本:26.0.0
fastForwardSkipIntervalsSkipIntervals快进支持的时间间隔。默认为SECONDS_15,即15秒。
系统会使用此值作为快进操作的时间间隔,而非skipIntervals的值。
若未设置此参数,快进操作的时间间隔仍会沿用skipIntervals的值。
模型约束: 此接口仅可在Stage模型下使用。
起始版本:26.0.0

AVMediaDescription10+

播放列表媒体元数据的相关属性。

名称类型只读可选说明
assetIdstring播放列表媒体ID。媒体信息的唯一标识,由应用自定义。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
titlestring播放列表媒体标题。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
subtitlestring播放列表媒体子标题。
在使用了cast+协议的音频投播场景下,不支持使用该属性。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
descriptionstring播放列表媒体描述的文本。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
mediaImageimage.PixelMap |string设置播放列表媒体图片像素数据。
在使用了cast+协议的音视频投播场景下,该字段用于给对端设备设置媒体专辑封面。
当入参为string类型时:
- 只支持使用网络URI设置封面,不支持本地URI。
- 其作用与albumCoverUri属性功能相同,且优先级高于albumCoverUri。
从API version 23开始,支持入参为image.PixelMap类型给对端设备设置媒体信息。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
extras{[key: string]: Object;}播放列表媒体额外字段。
从API版本26.0.0开始,DLNA投播场景下支持将ExtraKey中的键值对传递对端设备,键值对的值需传入符合XML格式的字符串。
- 非DLNA投播场景不生效。
- 非字符串类型不生效。
- 非XML格式会触发on('castControlIoError')回调并返回错误码6612000。错误码的详细介绍请参见媒体会话管理错误码
- 通过extras字段,在ExtraKey中各键传入的字符串总长度需小于40960字节。
系统能力: SystemCapability.Multimedia.AVSession.Core
mediaUristring播放列表媒体URI。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
mediaTypestring播放列表媒体类型。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
mediaSizenumber播放列表媒体的大小。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
albumTitlestring播放列表媒体专辑标题。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
albumCoverUristring播放列表媒体专辑封面URI。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
lyricContentstring播放列表媒体歌词内容。
字符串长度需小于40960字节。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
lyricUristring播放列表媒体歌词URI。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
artiststring播放列表媒体专辑作者。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
fdSrcmedia.AVFileDescriptor播放列表媒体本地文件的句柄。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
dataSrc12+media.AVDataSrcDescriptor播放列表数据源描述。
系统能力: SystemCapability.Multimedia.AVSession.Core
pcmSrc20+boolean播放列表是否使用PCM数据源。true表示使用PCM数据源,false表示不使用PCM数据源。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。
drmScheme12+string播放列表媒体支持的DRM方案,由uuid表示。
系统能力: SystemCapability.Multimedia.AVSession.Core
durationnumber播放列表媒体播放时长。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
startPositionnumber播放列表媒体起始播放位置。音视频投播场景中,在投播资源时,此字段应置空或赋值为0。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
creditsPositionnumber播放列表媒体的片尾播放位置。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
appNamestring播放列表提供的应用的名字。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
displayTags11+number媒体资源的金标类型,取值参考DisplayTag
在使用了cast+协议的音频投播场景下,不支持使用该属性。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
launchClientData20+string投播过程中应用程序向接收方发送的自定义数据。
系统能力: SystemCapability.Multimedia.AVSession.AVCast
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

AVQueueItem10+

播放列表中单项的相关属性。

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

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

名称类型只读可选说明
itemIdnumber播放列表中单项的ID。
descriptionAVMediaDescription播放列表中单项的媒体元数据。

AVPlaybackState10+

媒体播放状态的相关属性。

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

名称类型只读可选说明
statePlaybackState播放状态。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
speednumber播放倍速。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
positionPlaybackPosition播放位置。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
bufferedTimenumber缓冲时间。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
loopModeLoopMode循环模式。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
isFavoriteboolean表示是否收藏。true表示收藏,false表示不收藏。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
activeItemIdnumber正在播放的媒体Id。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
volumenumber正在播放的媒体音量。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
maxVolume11+number最大音量。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
muted11+boolean当前是否是静音状态。true表示是,false表示不是。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
duration11+number当前媒体资源的时长。
videoWidth11+number媒体资源的视频宽度,单位为像素(px)。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
videoHeight11+number媒体资源的视频高度,单位为像素(px)。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
extras{[key: string]: Object;}自定义媒体数据。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

PlaybackPosition10+

媒体播放位置的相关属性。

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

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

名称类型只读可选说明
elapsedTimenumber已用时间,单位毫秒(ms)。
updateTimenumber更新时间,单位毫秒(ms)。

CallMetadata11+

通话会话元数据相关属性。

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

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

名称类型只读可选说明
namestring来电人姓名(别名)。
phoneNumberstring来电电话号码。
avatarimage.PixelMap来电人头像。

AVCallState11+

通话状态相关属性。

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

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

名称类型只读可选说明
stateCallState当前通话状态。
mutedboolean表示通话mic是否静音。 true表示是静音,false表示不是静音。

DeviceInfo10+

播放设备的相关信息。

名称类型只读可选说明
castCategoryAVCastCategory投播的类别。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
deviceIdstring播放设备的ID。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
deviceNamestring播放设备的名称。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
deviceTypeDeviceType播放设备的类型。
系统能力: SystemCapability.Multimedia.AVSession.Core
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
supportedProtocols11+number播放设备支持的协议。
默认为TYPE_LOCAL,具体取值来自ProtocolType,可以是protocolType中的某个协议或者多个协议的组合。
设备仅支持一种协议,返回对应枚举值;设备支持多种协议,返回对应枚举值之和。
系统能力: SystemCapability.Multimedia.AVSession.AVCast
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
supportedDrmCapabilities12+Array<string>播放设备支持的DRM能力。
系统能力: SystemCapability.Multimedia.AVSession.AVCast
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
manufacturer13+string播放设备生产厂家。
系统能力: SystemCapability.Multimedia.AVSession.AVCast
原子化服务API: 从API version 13开始,该接口支持在原子化服务中使用。
modelName13+string播放设备型号名称。
系统能力: SystemCapability.Multimedia.AVSession.AVCast
原子化服务API: 从API version 13开始,该接口支持在原子化服务中使用。
audioCapabilities20+AudioCapabilities播放设备支持的音频能力。
系统能力: SystemCapability.Multimedia.AVSession.AVCast
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。
supportedPullClients20+Array<number>支持拉端客户端的ID集合(只有支持4K投播的设备会返回此字段)。
系统能力: SystemCapability.Multimedia.AVSession.AVCast
原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

OutputDeviceInfo10+

播放设备的相关信息。

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

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

名称类型只读可选说明
devicesArray<DeviceInfo>播放设备的集合。

AVControlCommand10+

会话接受的命令的对象描述。

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

名称类型只读可选说明
commandAVControlCommandType命令(不同命令对应不同参数)。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
parameterLoopMode |string | number命令对应的参数。
原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。
commandInfo22+CommandInfo命令信息。

AVCastPickerOptions14+

拉起的投播组件包含的配置属性。

系统能力: SystemCapability.Multimedia.AVSession.AVCast

名称类型只读可选说明
sessionTypeAVSessionType会话类型,默认值为audio。
当前仅支持的会话类型有audio和video。如果传入voice_call或video_call,将默认按照传入audio处理。
原子化服务API: 从API version 14开始,该接口支持在原子化服务中使用。
pickerStyle22+AVCastPickerStyle设置组件样式。
menuPosition22+MenuPosition当pickerStyle设置为STYLE_MENU时,可以设置弹出菜单的位置。

AudioCapabilities20+

表示投播设备支持的音频能力。

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

系统能力: SystemCapability.Multimedia.AVSession.AVCast

名称类型只读可选说明
streamInfosArray<audio.AudioStreamInfo>音频能力参数的列表。

CommandInfo22+

定义要发送到会话的命令信息。

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

名称类型只读可选说明
callerBundleNamestring调用方应用包名。
callerModuleNamestring调用方应用模块名。
callerDeviceIdstring调用方设备ID。
callerTypeCallerType调用方来源。

MenuPosition 22+

定义可弹出菜单的组件的位置。

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

系统能力: SystemCapability.Multimedia.AVSession.AVCast

名称类型只读可选说明
xnumber组件在X轴上的位置坐标。单位为vp。
ynumber组件在y轴上的位置坐标。单位为vp。
widthnumber组件宽度。单位为vp。
heightnumber组件高度。单位为vp。

AVSessionDescriptor 23+

会话的相关描述信息。

系统能力: SystemCapability.Multimedia.AVSession.Manager

名称类型只读可选说明
sessionIdstring会话ID。
typeAVSessionType会话类型。
sessionTagstring会话的自定义名称。
elementNameElementName会话所属应用的信息(包含bundleName、abilityName等)。
isActiveboolean会话是否被激活。
true:已被激活。
false:没有被激活。
isTopSessionboolean会话是否为最新的会话。
true:是最新的会话。
false:不是最新的会话。

DesktopLyricState23+

桌面歌词状态。

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

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

名称类型只读可选说明
isLockedboolean桌面歌词位置是否锁定。true表示已锁定,false表示未锁定。若已锁定,桌面显示歌词后,固定当前位置,不可被拖拽。

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 arkts-apis-avsession

openharmony 鸿蒙 arkts-apis-avsession-e

openharmony 鸿蒙 capi-native-avsession-h

openharmony 鸿蒙 errorcode-avsession

openharmony 鸿蒙 js-apis-inner-application-MediaControlExtensionContext-sys

openharmony 鸿蒙 arkts-apis-avMusicTemplate-AVMusicTemplateController

openharmony 鸿蒙 capi-native-avsession-base-h

openharmony 鸿蒙 arkts-apis-avMusicTemplate-t

openharmony 鸿蒙 arkts-apis-avMusicTemplate-i

openharmony 鸿蒙 capi-native-avcastcontroller-h

  • 所属分类: 后端技术
  • 本文标签: 鸿蒙 软件
  • 版权声明: 本文链接 https://seaxiang.com/blog/a5CBM2xv