Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“a213f441819a82b60ee2a375b891768e0c1607c1”上不存在“git@gitcode.net:Crayonxin2000/Paddle.git”
未验证 提交 d1624204 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!21106 Avsession示例代码和一致性问题清理 

Merge pull request !21106 from jiao_yanlin_001/master
上级 b24c2f1c 0b38bccc
隐藏空白更改
内联 并排
Showing with 544 addition and 68 deletion
zh-cn/application-dev/reference/apis/js-apis-avsession.md
浏览文件 @ d1624204
......@@ -41,6 +41,7 @@ createAVSession(context: Context, tag: string, type: AVSessionType): Promise\<AV
| Promise<[AVSession](#avsession10)\> | Promise对象。回调返回会话实例对象，可用于获取会话ID，以及设置元数据、播放状态，发送按键事件等操作。|
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -82,6 +83,7 @@ createAVSession(context: Context, tag: string, type: AVSessionType, callback: As
| callback | AsyncCallback<[AVSession](#avsession10)\> | 是 | 回调函数。回调返回会话实例对象，可用于获取会话ID，以及设置元数据、播放状态，发送按键事件等操作。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -166,6 +168,7 @@ getAllSessionDescriptors(callback: AsyncCallback\<Array\<Readonly\<AVSessionDesc
| callback | AsyncCallback<Array<Readonly<[AVSessionDescriptor](#avsessiondescriptor)\>\>\> | 是 | 回调函数。返回所有会话描述的只读对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -214,6 +217,7 @@ getHistoricalSessionDescriptors(maxSize?: number): Promise\<Array\<Readonly\<AVS
| Promise\<Array\<Readonly\<[AVSessionDescriptor](#avsessiondescriptor)\>\>\> | Promise对象。返回所有会话描述的只读对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -257,6 +261,7 @@ getHistoricalSessionDescriptors(maxSize: number, callback: AsyncCallback\<Array\
| callback | AsyncCallback<Array<Readonly<[AVSessionDescriptor](#avsessiondescriptor)\>\>\> | 是 | 回调函数。返回所有会话描述的只读对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -307,6 +312,7 @@ createController(sessionId: string): Promise\<AVSessionController>
| Promise<[AVSessionController](#avsessioncontroller10)\> | Promise对象。返回会话控制器实例，可查看会话ID，<br>并完成对会话发送命令及事件，获取元数据、播放状态信息等操作。|
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -427,7 +433,7 @@ castAudio(session: SessionToken | 'all', audioDevices: Array<audio.AudioDeviceDe
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600104 | The remote session connection failed. |
| 6600104 | The remote session connection failed. |
**示例：**
......@@ -480,7 +486,7 @@ castAudio(session: SessionToken | 'all', audioDevices: Array<audio.AudioDeviceDe
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600104 | The remote session connection failed. |
| 6600104 | The remote session connection failed. |
**示例：**
......@@ -506,11 +512,11 @@ avSession.castAudio('all', audioDevices, function (err) {
});
```
## avSession.on('sessionCreate' | 'sessionDestroy' | 'topSessionChange')
## avSession.on('sessionCreate')
on(type: 'sessionCreate' | 'sessionDestroy' | 'topSessionChange', callback: (session: AVSessionDescriptor) => void): void
on(type: 'sessionCreate', callback: (session: AVSessionDescriptor) => void): void
会话的创建、销毁以及最新会话变更的监听事件。
会话的创建监听事件。
**需要权限：** ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
......@@ -520,13 +526,13 @@ on(type: 'sessionCreate' | 'sessionDestroy' | 'topSessionChange', callback: (ses
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件包括：<br/>- `'sessionCreate'`：会话创建事件，检测到会话创建时触发。<br/>- `'sessionDestroy'`：会话销毁事件，检测到会话销毁时触发。 <br/>- `'topSessionChange'`：最新会话的变化事件，检测到最新的会话改变时触发。|
| callback | (session: [AVSessionDescriptor](#avsessiondescriptor)) => void | 是 | 回调函数。参数为会话相关描述。 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件是'sessionCreate'`：会话创建事件，检测到会话创建时触发。|
| callback | (session: [AVSessionDescriptor](#avsessiondescriptor)) => void | 是 | 回调函数。参数为会话相关描述。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
......@@ -541,12 +547,73 @@ avSession.on('sessionCreate', (descriptor) => {
console.info(`on sessionCreate : sessionTag : ${descriptor.sessionTag}`);
});
```
## avSession.on('sessionDestroy')
on(type: 'sessionDestroy', callback: (session: AVSessionDescriptor) => void): void
会话的销毁监听事件。
**需要权限：** ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
**系统能力：** SystemCapability.Multimedia.AVSession.Manager
**系统接口：** 该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------| ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件包括是`'sessionDestroy'`：会话销毁事件，检测到会话销毁时触发。|
| callback | (session: [AVSessionDescriptor](#avsessiondescriptor)) => void | 是 | 回调函数。参数为会话相关描述。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
**示例：**
```js
avSession.on('sessionDestroy', (descriptor) => {
console.info(`on sessionDestroy : isActive : ${descriptor.isActive}`);
console.info(`on sessionDestroy : type : ${descriptor.type}`);
console.info(`on sessionDestroy : sessionTag : ${descriptor.sessionTag}`);
});
```
## avSession.on('topSessionChange')
on(type: 'topSessionChange', callback: (session: AVSessionDescriptor) => void): void
最新会话变更的监听事件。
**需要权限：** ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
**系统能力：** SystemCapability.Multimedia.AVSession.Manager
**系统接口：** 该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------| ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件包括是 `'topSessionChange'`：最新会话的变化事件，检测到最新的会话改变时触发。|
| callback | (session: [AVSessionDescriptor](#avsessiondescriptor)) => void | 是 | 回调函数。参数为会话相关描述。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
**示例：**
```js
avSession.on('topSessionChange', (descriptor) => {
console.info(`on topSessionChange : isActive : ${descriptor.isActive}`);
console.info(`on topSessionChange : type : ${descriptor.type}`);
......@@ -554,11 +621,11 @@ avSession.on('topSessionChange', (descriptor) => {
});
```
## avSession.off('sessionCreate' | 'sessionDestroy' | 'topSessionChange')
## avSession.off('sessionCreate')
off(type: 'sessionCreate' | 'sessionDestroy' | 'topSessionChange', callback?: (session: AVSessionDescriptor) => void): void
off(type: 'sessionCreate', callback?: (session: AVSessionDescriptor) => void): void
取消会话相关事件监听，取消后，不再进行相关事件的监听。
取消会话创建事件监听，取消后，不再进行该事件的监听。
**需要权限：** ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
......@@ -568,13 +635,13 @@ off(type: 'sessionCreate' | 'sessionDestroy' | 'topSessionChange', callback?: (s
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件为：<br/>- `'sessionCreate'`：会话创建事件，检测到会话创建时触发。<br/>- `'sessionDestroy'`：会话销毁事件，检测到会话销毁时触发。 <br/>- `'topSessionChange'`：最新会话的变化事件，检测到最新的会话改变时触发。|
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------| ---- | ----------|
| type | string | 是 | 事件回调类型，支持的事件为：`'sessionCreate'`。|
| callback | (session: [AVSessionDescriptor](#avsessiondescriptor)) => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为会话相关描述，为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
......@@ -584,7 +651,69 @@ off(type: 'sessionCreate' | 'sessionDestroy' | 'topSessionChange', callback?: (s
```js
avSession.off('sessionCreate');
```
## avSession.off('sessionDestroy')
off(type: 'sessionDestroy', callback?: (session: AVSessionDescriptor) => void): void
取消会话销毁事件监听，取消后，不再进行该事件的监听。
**需要权限：** ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
**系统能力：** SystemCapability.Multimedia.AVSession.Manager
**系统接口：** 该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -----------| ---- | -------------------------|
| type | string | 是 | 事件回调类型，支持的事件为`'sessionDestroy'`。|
| callback | (session: [AVSessionDescriptor](#avsessiondescriptor)) => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为会话相关描述，为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。|
**错误码：**
以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
**示例：**
```js
avSession.off('sessionDestroy');
```
## avSession.off('topSessionChange')
off(type: 'topSessionChange', callback?: (session: AVSessionDescriptor) => void): void
取消最新会话变更事件监听，取消后，不再进行该事件的监听。
**需要权限：** ohos.permission.MANAGE_MEDIA_RESOURCES，仅系统应用可用。
**系统能力：** SystemCapability.Multimedia.AVSession.Manager
**系统接口：** 该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -----------------| ---- | ---------------------------- |
| type | string | 是 | 事件回调类型，支持的事件为`'topSessionChange'`。|
| callback | (session: [AVSessionDescriptor](#avsessiondescriptor)) => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为会话相关描述，为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.multimedia.avsession(多媒体会话)错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
**示例：**
```js
avSession.off('topSessionChange');
```
......@@ -1087,8 +1216,6 @@ startCasting(session: SessionToken, device: OutputDeviceInfo, callback: AsyncCal
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | No Permission: 无权限执行此操作 |
| 401 | Invalid Parameter: 入参错误，表示调用无效。 |
| 6600101 | Session service exception. |
| 6600108 | Device connecting failed. |
......@@ -1142,8 +1269,6 @@ startCasting(session: SessionToken, device: OutputDeviceInfo): Promise\<void>
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 201 | No Permission: 无权限执行此操作 |
| 401 | Invalid Parameter: 入参错误，表示调用无效。 |
| 6600101 | Session service exception. |
| 6600108 | Device connecting failed. |
......@@ -1556,7 +1681,7 @@ setAVQueueItems(items: Array\<AVQueueItem>): Promise\<void>
import image from '@ohos.multimedia.image';
import resourceManager from '@ohos.resourceManager';
let value : Uint8Array = await resourceManager.getRawFile('IMAGE_URI');
let value : Uint8Array = await resourceManager.getRawFileContent('IMAGE_URI');
let imageSource : imageImageSource = image.createImageSource(value.buffer);
let imagePixel : image.PixelMap = await imageSource.createPixelMap({desiredSize:{width: 150, height: 150}});
let queueItemDescription_1 = {
......@@ -1622,7 +1747,7 @@ setAVQueueItems(items: Array\<AVQueueItem>, callback: AsyncCallback\<void>): voi
import image from '@ohos.multimedia.image';
import resourceManager from '@ohos.resourceManager';
let value : Uint8Array = await resourceManager.getRawFile('IMAGE_URI');
let value : Uint8Array = await resourceManager.getRawFileContent('IMAGE_URI');
let imageSource : imageImageSource = image.createImageSource(value.buffer);
let imagePixel : image.PixelMap = await imageSource.createPixelMap({desiredSize:{width: 150, height: 150}});
let queueItemDescription_1 = {
......@@ -2260,6 +2385,7 @@ getOutputDevice(): Promise\<OutputDeviceInfo>
| Promise<[OutputDeviceInfo](#outputdeviceinfo10)> | Promise对象。返回播放设备信息。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -2292,6 +2418,7 @@ getOutputDevice(callback: AsyncCallback\<OutputDeviceInfo>): void
| callback | AsyncCallback<[OutputDeviceInfo](#outputdeviceinfo10)\> | 是 | 回调函数，返回播放设备信息。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -2511,9 +2638,9 @@ session.destroy(function (err) {
});
```
### on('play'|'pause'|'stop'|'playNext'|'playPrevious'|'fastForward'|'rewind')<sup>10+</sup>
### on('play')<sup>10+</sup>
on(type: 'play'|'pause'|'stop'|'playNext'|'playPrevious'|'fastForward'|'rewind', callback: () => void): void
on(type: 'play', callback: () => void): void
设置播放命令监听事件。
......@@ -2523,7 +2650,7 @@ on(type: 'play'|'pause'|'stop'|'playNext'|'playPrevious'|'fastForward'|'rewind',
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件包括：`'play'`，`'pause'`，`'stop'`，` 'playNext'`，` 'playPrevious'`， `'fastForward'`，` 'rewind'`。<br/>当对应的播放命令被发送到会话时，触发该事件回调。 |
| type | string | 是 | 事件回调类型，支持的事件为`'play'`当播放命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
**错误码：**
......@@ -2540,21 +2667,189 @@ on(type: 'play'|'pause'|'stop'|'playNext'|'playPrevious'|'fastForward'|'rewind',
session.on('play', () => {
console.info(`on play entry`);
});
```
### on('pause')<sup>10+</sup>
on(type: 'pause', callback: () => void): void
设置暂停命令监听事件。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件为`'pause'`，当暂停命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.on('pause', () => {
console.info(`on pause entry`);
});
```
### on('stop')<sup>10+</sup>
on(type:'stop', callback: () => void): void
设置停止命令监听事件。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件是`'stop'`，当停止命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.on('stop', () => {
console.info(`on stop entry`);
});
```
### on('playNext')<sup>10+</sup>
on(type:'playNext', callback: () => void): void
设置播放下一首命令监听事件。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件是` 'playNext'`，当播放下一首命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.on('playNext', () => {
console.info(`on playNext entry`);
});
```
### on('playPrevious')<sup>10+</sup>
on(type:'playPrevious', callback: () => void): void
设置播放上一首命令监听事件。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件是` 'playPrevious'`当播放上一首命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.on('playPrevious', () => {
console.info(`on playPrevious entry`);
});
```
### on('fastForward')<sup>10+</sup>
on(type: 'fastForward', callback: () => void): void
设置快进命令监听事件。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件是 `'fastForward'`，当快进命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.on('fastForward', () => {
console.info(`on fastForward entry`);
});
```
### on('rewind')<sup>10+</sup>
on(type:'rewind', callback: () => void): void
设置快退命令监听事件。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 事件回调类型，支持的事件是` 'rewind'`，当快退命令被发送到会话时，触发该事件回调。 |
| callback | callback: () => void | 是 | 回调函数。当监听事件注册成功，err为undefined，否则为错误对象。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.on('rewind', () => {
console.info(`on rewind entry`);
});
......@@ -2808,11 +3103,11 @@ session.on('commonCommand', (commonCommand, args) => {
});
```
### off('play'|'pause'|'stop'|'playNext'|'playPrevious'|'fastForward'|'rewind')<sup>10+</sup>
### off('play')<sup>10+</sup>
off(type: 'play' | 'pause' | 'stop' | 'playNext' | 'playPrevious' | 'fastForward' | 'rewind', callback?: () => void): void
off(type: 'play', callback?: () => void): void
取消会话相关事件监听，关闭后，不再进行相关事件回调。
取消会话播放事件监听，关闭后，不再进行该事件回调。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
......@@ -2820,7 +3115,7 @@ off(type: 'play' | 'pause' | 'stop' | 'playNext' | 'playPrevious' | 'fastForward
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- |
| type | string | 是 | 关闭对应的监听事件，支持的事件包括：`'play'`，` 'pause'`，`'stop'`， `'playNext'`，` 'playPrevious'`， ` 'fastForward'`，` 'rewind'`。 |
| type | string | 是 | 关闭对应的监听事件，支持的事件是`'play'`|
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
......@@ -2835,11 +3130,179 @@ off(type: 'play' | 'pause' | 'stop' | 'playNext' | 'playPrevious' | 'fastForward
```js
session.off('play');
```
### off('pause')<sup>10+</sup>
off(type: 'pause', callback?: () => void): void
取消会话暂停事件监听，关闭后，不再进行该事件回调。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- |
| type | string | 是 | 关闭对应的监听事件，支持的事件是` 'pause'`。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.off('pause');
```
### off('stop')<sup>10+</sup>
off(type: 'stop', callback?: () => void): void
取消会话停止事件监听，关闭后，不再进行该事件回调。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- |
| type | string | 是 | 关闭对应的监听事件，支持的事件是`'stop'`。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.off('stop');
```
### off('playNext')<sup>10+</sup>
off(type: 'playNext', callback?: () => void): void
取消会话播放下一首事件监听，关闭后，不再进行该事件回调。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- |
| type | string | 是 | 关闭对应的监听事件，支持的事件是 `'playNext'`。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.off('playNext');
```
### off('playPrevious')<sup>10+</sup>
off(type: 'playPrevious', callback?: () => void): void
取消会话播放上一首事件监听，关闭后，不再进行该事件回调。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- |
| type | string | 是 | 关闭对应的监听事件，支持的事件是` 'playPrevious'`。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.off('playPrevious');
```
### off('fastForward')<sup>10+</sup>
off(type: 'fastForward', callback?: () => void): void
取消会话快进事件监听，关闭后，不再进行该事件回调。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- |
| type | string | 是 | 关闭对应的监听事件，支持的事件是` 'fastForward'`。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.off('fastForward');
```
### off('rewind')<sup>10+</sup>
off(type: 'rewind', callback?: () => void): void
取消会话快退事件监听，关闭后，不再进行该事件回调。
**系统能力：** SystemCapability.Multimedia.AVSession.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------- |
| type | string | 是 | 关闭对应的监听事件，支持的事件是` 'rewind'`。 |
| callback | callback: () => void | 否 | 回调函数。当监听事件取消成功，err为undefined，否则返回错误对象。<br>该参数为可选参数，若不填写该参数，则认为取消所有相关会话的事件监听。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
**示例：**
```js
session.off('rewind');
```
......@@ -3391,12 +3854,13 @@ getOutputDevice(): Promise\<OutputDeviceInfo>
| Promise<[OutputDeviceInfo](#outputdeviceinfo10)\> | Promise对象，返回播放设备信息。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
| 600101 | Session service exception. |
| 600103 | The session controller does not exist. |
**示例：**
```js
......@@ -3426,8 +3890,8 @@ getOutputDevice(callback: AsyncCallback\<OutputDeviceInfo>): void
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
| 600101 | Session service exception. |
| 600103 | The session controller does not exist. |
**示例：**
......@@ -3544,11 +4008,11 @@ sendAVKeyEvent(event: KeyEvent): Promise\<void>
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
| 6600105 | Invalid session command. |
| 6600106 | The session is not activated. |
| 600101 | Session service exception. |
| 600102 | The session does not exist. |
| 600103 | The session controller does not exist. |
| 600105 | Invalid session command. |
| 600106 | The session is not activated. |
**返回值：**
......@@ -3589,11 +4053,11 @@ sendAVKeyEvent(event: KeyEvent, callback: AsyncCallback\<void>): void
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 6600101 | Session service exception. |
| 6600102 | The session does not exist. |
| 6600103 | The session controller does not exist. |
| 6600105 | Invalid session command. |
| 6600106 | The session is not activated. |
| 600101 | Session service exception. |
| 600102 | The session does not exist. |
| 600103 | The session controller does not exist. |
| 600105 | Invalid session command. |
| 600106 | The session is not activated. |
**示例：**
......@@ -4206,6 +4670,7 @@ on(type: 'sessionEvent', callback: (sessionEvent: string, args: {[key:string]: O
| callback | (sessionEvent: string, args: {[key:string]: object}) => void | 是 | 回调函数，sessionEvent为变化的会话事件名，args为事件的参数。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。
| 错误码ID | 错误信息 |
......@@ -4305,7 +4770,6 @@ on(type: 'extrasChange', callback: (extras: {[key:string]: Object}) => void): vo
| -------- | ------------------------------ |
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
| 401 | Parameter check failed |
**示例：**
......@@ -4607,7 +5071,6 @@ off(type: 'extrasChange', callback?: (extras: {[key:string]: Object}) => void):
| -------- | ---------------- |
| 6600101 | Session service exception. |
| 6600103 | The session controller does not exist. |
| 401 | Parameter check failed |
**示例：**
......@@ -5191,18 +5654,18 @@ on(type: 'error', callback: ErrorCallback): void
| type | string | 是 | 错误事件回调类型，支持的事件：'error'，用户操作和系统都会触发此事件。 |
| callback | function | 是 | 错误事件回调方法：远端播放过程中发生的错误，会提供错误码ID和错误信息。 |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-media.md)。
| 错误码ID | 错误信息 | 说明 |
| -------- | --------------------- | ------------------------------------------------------------ |
| 201 | No Permission: | 无权限执行此操作 |
| 401 | Invalid Parameter: | 入参错误，表示调用无效。 |
| 5400101 | No Memory: | 播放内存不足 |
| 5400102 | Operate Not Permit: | 当前状态机不支持此操作，表示调用无效。 |
| 5400103 | IO Error: | 播放中发现码流异常|
| 5400104 | Network Timeout: | 网络原因超时响应 |
| 5400105 | Service Died: | 播放进程死亡 |
| 5400106 | Unsupport Format: | 不支持的文件格式 |
| 错误码ID | 错误信息 |
| -------- | --------------------- |
| 5400101 | No memory. |
| 5400102 | Operation not allowed. |
| 5400103 | I/O error. |
| 5400104 | Time out. |
| 5400105 | Service died. |
| 5400106 | Unsupport format. |
**示例：**
......@@ -5227,6 +5690,19 @@ off(type: 'error'): void
| ------ | ------ | ---- | ----------------------------------------- |
| type | string | 是 | 错误事件回调类型，取消注册的事件：'error' |
**错误码：**
以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-media.md)。
| 错误码ID | 错误信息 |
| -------- | --------------------- |
| 5400101 | No memory. |
| 5400102 | Operation not allowed. |
| 5400103 | I/O error. |
| 5400104 | Time out. |
| 5400105 | Service died. |
| 5400106 | Unsupport format. |
**示例：**
```js
......@@ -5890,8 +6366,8 @@ getCurrentItem(): Promise\<AVQueueItem>
| 名称 | 值 | 说明 |
| --------------------------- | ---- | ----------- |
| STATE_CONNECTING | 0 | 设备连接中 |
| STATE_CONNECTED | 6 | 设备连接成功 |
| STATE_DISCONNECTED | 5 | 设备断开连接 |
| STATE_CONNECTED | 1 | 设备连接成功 |
| STATE_DISCONNECTED | 6 | 设备断开连接 |
## ProtocolType<sup>10+</sup>
......@@ -5984,16 +6460,16 @@ getCurrentItem(): Promise\<AVQueueItem>
**系统能力：** SystemCapability.Multimedia.AVSession.Core
| 名称 | 值 | 说明 |
| ------------------------------ | ------- | ------------------------------- |
| ERR_CODE_SERVICE_EXCEPTION | 6600101 | Session service exception. |
| ERR_CODE_SESSION_NOT_EXIST | 6600102 | The session does not exist. |
| ERR_CODE_CONTROLLER_NOT_EXIST | 6600103 | The session controller does not exist. |
| ERR_CODE_REMOTE_CONNECTION_ERR | 6600104 | The remote session connection failed. |
| ERR_CODE_COMMAND_INVALID | 6600105 | Invalid session command. |
| ERR_CODE_SESSION_INACTIVE | 6600106 | The session is not activated. |
| ERR_CODE_MESSAGE_OVERLOAD | 6600107 | Too many commands or events. |
| 名称 | 值 | 说明 |
| -------------------------------------- | ------- | ------------------------------- |
| ERR_CODE_SERVICE_EXCEPTION | 6600101 | Session service exception. |
| ERR_CODE_SESSION_NOT_EXIST | 6600102 | The session does not exist. |
| ERR_CODE_CONTROLLER_NOT_EXIST | 6600103 | The session controller does not exist. |
| ERR_CODE_REMOTE_CONNECTION_ERR | 6600104 | The remote session connection failed. |
| ERR_CODE_COMMAND_INVALID | 6600105 | Invalid session command. |
| ERR_CODE_SESSION_INACTIVE | 6600106 | The session is not activated. |
| ERR_CODE_MESSAGE_OVERLOAD | 6600107 | Too many commands or events. |
| ERR_CODE_DEVICE_CONNECTION_FAILED | 6600108 | Device connecting failed. |
| ERR_CODE_REMOTE_CONNECTION_NOT_EXIST | 6600109 | The remote connection is not established. |
| ERR_CODE_REMOTE_CONNECTION_NOT_EXIST | 6600109 | The remote connection is not established. |
<!--no_check-->
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或