From 0f576494c50c5f8f550d4defd29a38a7cc2f6e33 Mon Sep 17 00:00:00 2001 From: jiaoyanlin3 Date: Wed, 26 Jul 2023 20:00:52 +0800 Subject: [PATCH] Modification of avsession data issues Signed-off-by: jiaoyanlin3 --- .../reference/apis/js-apis-avsession.md | 126 ++++++++++++++---- 1 file changed, 103 insertions(+), 23 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-avsession.md b/zh-cn/application-dev/reference/apis/js-apis-avsession.md index fb5baddd71..8e273456c0 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-avsession.md +++ b/zh-cn/application-dev/reference/apis/js-apis-avsession.md @@ -1258,9 +1258,9 @@ off(type: 'deviceAvailable', callback?: (device: OutputDeviceInfo) => void): voi avSession.off('deviceAvailable'); ``` -### getAVCastController10+ +## avSession.getAVCastController10+ -getAVCastController(callback: AsyncCallback\): void +getAVCastController(sessionId: string, callback: AsyncCallback\): void 设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。 @@ -1270,6 +1270,7 @@ getAVCastController(callback: AsyncCallback\): void | 参数名 | 类型 | 必填 | 说明 | | --------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| sessionId | string | 是 |用于指定要获取的投播控制器的sessionId | | callback | AsyncCallback<[AVCastController](#avcastcontroller10)\> | 是 | 回调函数，返回投播控制器实例。 | **错误码：** @@ -1277,32 +1278,40 @@ getAVCastController(callback: AsyncCallback\): void | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -| 6600102 | The session does not exist. | -| 6600110 | The remote connection is not established. | +| 6600101 | Session service exception | +| 6600102 | session does not exist | **示例：** ```js let aVCastController; -currentAVSession.getAVCastController().then((avcontroller) => { - aVCastController = avcontroller; - console.info(`getAVCastController : SUCCESS : sessionid : ${aVCastController.sessionId}`); -}).catch((err) => { - console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`); +avSession.getAVCastController(sessionId ,function (err, avcontroller) { + if (err) { + console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`); + } else { + aVCastController = avcontroller; + console.info('getAVCastController : SUCCESS '); + } }); ``` -### getAVCastController10+ +## avSession.getAVCastController10+ -getAVCastController(): Promise\; +getAVCastController(sessionId: string): Promise\; -设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。 +设备建立连接后，获取投播控制器。结果通过Promise方式返回。 **系统能力：** SystemCapability.Multimedia.AVSession.AVCast +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------------------------- | ---- | ------------------------------------------------------------ | +| sessionId | string | 是 |用于指定要获取的投播控制器的sessionId | + **返回值：** -| 类型 | 说明 | +| 类型 | 说明 | | --------- | ------------------------------------------------------------ | | Promise<[AVCastController](#avcastcontroller10)\> | Promise对象。返回投播控制器实例。 | @@ -1311,22 +1320,21 @@ getAVCastController(): Promise\; | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | -| 6600102 | The session does not exist. | -| 6600110 | The remote connection is not established. | +| 6600101 | server exception | +| 6600102 | The session does not exist | **示例：** ```js let aVCastController; -currentAVSession.getAVCastController(function (err, avcontroller) { - if (err) { - console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`); - } else { - aVCastController = avcontroller; - console.info(`getAVCastController : SUCCESS : sessionid : ${aVCastController.sessionId}`); - } +avSession.getAVCastController(sessionId).then((avcontroller) => { + aVCastController = avcontroller; + console.info('getAVCastController : SUCCESS'); +}).catch((err) => { + console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`); }); ``` + ## avSession.startCasting10+ startCasting(session: SessionToken, device: OutputDeviceInfo, callback: AsyncCallback\): void @@ -2308,6 +2316,76 @@ currentAVSession.getController(function (err, avcontroller) { }); ``` +### getAVCastController10+ + +getAVCastController(callback: AsyncCallback\): void + +设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。 + +**系统能力：** SystemCapability.Multimedia.AVSession.AVCast + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<[AVCastController](#avcastcontroller10)\> | 是 | 回调函数，返回投播控制器实例。 | + +**错误码：** +以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 6600102 | The session does not exist. | +| 6600110 | The remote connection is not established. | + +**示例：** + +```js +let aVCastController; +currentAVSession.getAVCastController().then((avcontroller) => { + aVCastController = avcontroller; + console.info(`getAVCastController : SUCCESS : sessionid : ${aVCastController.sessionId}`); +}).catch((err) => { + console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`); +}); +``` + +### getAVCastController10+ + +getAVCastController(): Promise\; + +设备建立连接后，获取投播控制器。结果通过callback异步回调方式返回。 + +**系统能力：** SystemCapability.Multimedia.AVSession.AVCast + +**返回值：** + +| 类型 | 说明 | +| --------- | ------------------------------------------------------------ | +| Promise<[AVCastController](#avcastcontroller10)\> | Promise对象。返回投播控制器实例。 | + +**错误码：** +以下错误码的详细介绍请参见[媒体会话管理错误码](../errorcodes/errorcode-avsession.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 6600102 | The session does not exist. | +| 6600110 | The remote connection is not established. | + +**示例：** + +```js +let aVCastController; +currentAVSession.getAVCastController(function (err, avcontroller) { + if (err) { + console.error(`getAVCastController BusinessError: code: ${err.code}, message: ${err.message}`); + } else { + aVCastController = avcontroller; + console.info(`getAVCastController : SUCCESS : sessionid : ${aVCastController.sessionId}`); + } +}); +``` + ### getOutputDevice10+ getOutputDevice(): Promise\ @@ -4678,7 +4756,8 @@ aVCastController.off('error') **系统接口：** 该接口为系统接口。 -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------| ---------------- |-----|-----|------| | sessionId | string | 是 | 否 | 会话ID | | type | [AVSessionType](#avsessiontype10) | 是 | 否 | 会话类型 | | sessionTag | string | 是 | 否 | 会话的自定义名称 | @@ -5847,6 +5926,7 @@ on(type: 'playbackStateChange', filter: Array\ | 'all', c **参数：** | 参数名 | 类型 | 必填 | 说明 | +| --------| -----------|-----|------------| | type | string | 是 | 事件回调类型，支持事件`'playbackStateChange'`：当播放状态变化时，触发该事件。 | | filter | Array\ | 'all' | 是 | 'all' 表示关注播放状态所有字段变化；Array 表示关注Array中的字段变化。 | | callback | (state: [AVPlaybackState](#avplaybackstate10)) => void | 是 | 回调函数，参数state是变化后的播放状态。| -- GitLab