diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel.dita index a5aa364c0fd..417472b06e7 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannel.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannel.dita @@ -43,14 +43,16 @@ required int uid});

-
- 详情 -

-

-

-

-
+
+

加入频道后，默认情况下用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过相应的 mute 方法实现。

+
+
+
+
+
+ +
参数 diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita index c3fbf0fbaf6..70b4bbc8973 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita @@ -46,29 +46,42 @@ required ChannelMediaOptions options});

-
- 详情 -

该方法让用户加入通话频道，在同一个频道内的用户可以互相通话，多个用户加入同一个频道，可以群聊。 使用不同 App ID 的 App 不能互通。

-

成功调用该方法加入频道后会触发以下回调： -

-

在网络状况不理想的情况下，客户端可能会与声网服务器失去连接；SDK 会自动尝试重连，重连成功后，本地会触发 回调。

-

相比 ，该方法增加了 options 参数，用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

- -
    -
  • 该方法允许用户一次加入仅一个频道。
    • -
  • 请务必确保用于生成 Token 的 App ID 和 方法初始化引擎时用的是同一个 App ID，否则使用 Token 加入频道失败。
    • -
  • 如果你的项目仅开启调试模式（即选择 APP ID 为鉴权机制），成功加入频道 24 小时后会自动退出该频道。
    • -
-
+
+

相比 ，该方法增加了 options 参数，用于设置媒体选项，如是否在频道内发布音视频流等。用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

+

该方法可以在加入频道时设置媒体选项，如是否在频道内发布音视频流等。用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

+
+
+ 调用时机 +

该方法需要在 之后再调用。

+
+
+ 调用限制 +
    +
  • 该方法仅支持用户一次加入一个频道。
    • +
  • 使用不同 App ID 的 App 不能互通。
    • +
  • 加入频道前，请确保用于生成 Token 的 App ID 和调用 方法初始化引擎时使用的是同一个 App ID，否则使用 Token 加入频道会失败。
    • +
+
+ +
参数 token 在服务端生成的用于鉴权的动态密钥。详见。 - 如果你需要同时加入多个频道或在频道间频繁切换，声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token，详见 。 + +
    +
  • （推荐）如果你的项目开启了安全模式，即选择 APP ID + Token 为鉴权机制，则该参数为必填。
    • +
  • 如果你的项目仅开启调试模式，即选择 APP ID 为鉴权机制，则无需填入 Token 即可加入频道。成功加入频道 24 小时后会自动退出该频道。
    • +
  • 如果你需要同时加入多个频道或在频道间频繁切换，声网推荐你使用通配 Token 以避免每加入一个新的频道都需向服务端申请一个新的 Token，详见 。
 channelId @@ -113,7 +126,7 @@
  • -2：传入的参数无效。例如，使用了不合法的 Token，uid 参数未设置为整型，或 成员值不合法。你需要填入有效的参数，重新加入频道。
  • -3： 对象初始化失败。你需要重新初始化 对象。
  • -7： 对象尚未初始化。你需要在调用该方法前成功初始化 对象。
    • -
  • -8： 对象内部状态错误。可能的原因是：调用 开始通话回路测试后，未调用 停止测试就调用该方法加入频道。你需要在该方法前调用 。
    • +
  • -8： 对象内部状态错误。可能的原因是：调用 开始通话回路测试后，未调用 停止测试就调用该方法加入频道。你需要在该方法前调用 。
  • -17：加入频道被拒绝。可能的原因是用户已经在频道中。建议通过 回调判断用户是否在频道中。除收到 (1) 状态外，不要再次调用该方法加入频道。
  • -102：频道名无效。你需要在 channelId 中填入有效的频道名，重新加入频道。
  • -121：用户 ID 无效。你需要在 uid 中填入有效的用户 ID，重新加入频道。
    • diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita index 3af62ddfc81..0c4ba956f69 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount.dita @@ -43,17 +43,17 @@ ChannelMediaOptions? options});

    -
    - 详情 -

    该方法允许本地用户使用 User Account 和 Token 加入频道。成功加入频道后，会触发以下回调： -

      -
    • 本地：、 和 回调。
      • -
    • 通信场景下的用户和直播场景下的主播加入频道后，远端会依次触发 和 回调。
      • -

    +
    +

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

    -
    • 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。
      • -
    • 如果你的项目仅开启调试模式（即选择 APP ID 为鉴权机制），成功加入频道 24 小时后会自动退出该频道。
    -
    + +
    +
    +
    +
    + +
    参数 @@ -77,18 +77,6 @@
    -
    - <ph keyref="return-section-title"/> -

    方法成功调用时，无返回值；方法调用失败时，会抛出 异常，你需要捕获异常并进行处理。详见了解详情和解决建议。

    -
      -
    • 0: 方法调用成功。
      • -
    • < 0: 方法调用失败。详见了解详情和解决建议。 -
        -
      • -2: 参数无效。
        • -
      • -3: SDK 初始化失败，请尝试重新初始化 SDK。
        • -
      • -5: 调用被拒绝。
        • -
      • -17: 加入频道被拒绝。由于 SDK 仅支持用户同一时间加入一个 频道，当已经加入 频道的用户使用有效的频道名再次调用 类中的加入频道方法时，会返回此错误码。
        • -
      • -
    +
    diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita index a26cad72a6a..c266a54c93d 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccount2.dita @@ -2,7 +2,7 @@ <ph keyref="joinChannelWithUserAccount2" /> - 使用 User Account 和 Token 加入频道，并设置是否自动订阅音频或视频流。 + 使用 User Account 和 Token 加入频道，并设置频道媒体选项。 @@ -47,17 +47,25 @@ required String userAccount, ChannelMediaOptions? options});

    -
    - 详情 -

    该方法允许本地用户使用 User Account 加入频道。成功加入频道后，会触发以下回调： -

      -
    • 本地：、 和 回调。
      • -
    • 远端：通信场景下的用户和直播场景下的主播加入频道后，远端会分别触发 和 回调。
      • -

    -

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

    -

    相比 ，该方法加了 options 参数，用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

    -
    -
    +
    +

    调用该方法前，如果你未调用 注册一个 User Account，调用该方法加入频道时，SDK 会自动为你创建一个 User Account。先调用 方法注册 Account，再调用此方法加入频道，可以缩短进入频道的时间。

    +

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

    +

    相比 ，该方法增加了 options 参数，用于在加入频道时设置媒体选项，如是否在频道内发布音视频流等。默认情况下，用户订阅频道内所有其他用户的音频流和视频流，因此会产生用量并影响计费。如果想取消订阅，可以通过设置 options 参数或相应的 mute 方法实现。

    + 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。 +
    +
    +
    +
    +
    + +
    参数 diff --git a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita index f5c953762c3..bea260ce1c3 100644 --- a/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita +++ b/dita/RTC-NG/API/api_irtcengine_joinchannelwithuseraccountex.dita @@ -2,7 +2,7 @@ <ph keyref="joinChannelWithUserAccountEx" /> - 使用 User Account 加入频道，并设置是否自动订阅音频或视频流。 + 使用 User Account 和 Token 加入频道，并设置频道媒体选项。 @@ -48,20 +48,17 @@ required ChannelMediaOptions options});

    -
    - 详情 -

    -

    该方法允许本地用户使用 User Account 加入频道。成功加入频道后，会触发以下回调： - - -

      -
    • 本地：、 和 回调。
      • -
    • 远端：通信场景下的用户和直播场景下的主播加入频道后，远端会分别触发 和 回调。
      • -

    -

    -

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

    - - 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。
    +
    +

    调用该方法前，如果你未调用 注册一个 User Account，调用该方法加入频道时，SDK 会自动为你创建一个 User Account。先调用 方法注册 Account，再调用此方法加入频道，可以缩短进入频道的时间。

    +

    用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过设置 optionsmediaOptions 参数或调用相应的 mute 方法实现。

    + 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。 +
    +
    +
    +
    +
    +
    参数 @@ -93,12 +90,7 @@
    -
    - <ph keyref="return-section-title"/> -

    方法成功调用时，无返回值；方法调用失败时，会抛出 异常，你需要捕获异常并进行处理。详见了解详情和解决建议。

    -
      -
    • 0: 方法调用成功。
      • -
    • < 0: 方法调用失败。详见了解详情和解决建议。
      • -
    +
    +
    \ No newline at end of file diff --git a/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita index e22190018af..8135990004a 100644 --- a/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita +++ b/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita @@ -2,7 +2,7 @@ <ph keyref="joinChannelEx"/> - 使用连接 ID 加入频道。 + 加入频道。 @@ -43,18 +43,33 @@ required ChannelMediaOptions options});

    -
    - 详情 -

    调用该方法，你可以同时加入多个频道。

    - -
      -
    • 如果你已经在一个频道内，你不能用相同的用户 UID 再次加入该频道。
      • -
    • 如果你想在不同的设备上加入相同的频道，请确保你在不同设备上使用的用户 UID 都不同。
      • -
    • 请确保生成 Token 时传入的 App ID 和创建 实例时传入的 App ID 一致。
      • -
    • 如果你的项目仅开启调试模式（即选择 APP ID 为鉴权机制），成功加入频道 24 小时后会自动退出该频道。
      • -
    • 在多摄像头采集场景下，你需要在调用该方法之后调用 方法设置 sourceType 为 ，以确保第二个摄像头采集正常。
      • -
    -
    +
    +

    调用该方法，你可以同时加入多个频道。如果你想在不同的设备上加入相同的频道，请确保你在不同设备上使用的用户 ID 都不同。

    +
    +
    + 适用场景 +

    该方法适用于多频道场景。

    +
    +
    + 调用时机 +

    该方法需要在 之后调用。

    +

    在多摄像头采集场景下，你需要在调用该方法之后调用 方法设置 sourceType 为 ，以确保第二个摄像头采集正常。

    +
    +
    + 调用限制 +

    如果你已经在一个频道内，你不能用相同的用户 ID 再次加入该频道。

    +

    加入频道前，请确保用于生成 Token 的 App ID 和调用 方法初始化引擎时使用的是同一个 App ID，否则使用 Token 加入频道会失败。

    +
    + +
    参数 diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita index 41816bc87a3..c3c361dbecc 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita @@ -35,7 +35,17 @@

    该回调方法表示该客户端成功加入了指定的频道。

    -
    +
    + 触发时机 +

    当你调用 、、、、 或 方法成功加入频道后，SDK 会触发该回调。

    +

    当你调用 、、 或 方法成功加入频道后，SDK 会触发该回调。

    +

    当你调用 、 或 方法成功加入频道后，SDK 会触发该回调。

    +
    +
    + 使用限制 +

    无。

    +
    +
    <ph keyref="callback-section-title" /> diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita index 6483b61a4d2..bcdcd01f890 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita @@ -30,10 +30,15 @@ onRejoinChannelSuccess;

    -
    +
    + 触发时机

    有时候由于网络原因，客户端可能会和服务器失去连接，SDK 会进行自动重连，自动重连成功后触发此回调方法。

    -
    +
    + 使用限制 +

    无。

    +
    +
    <ph keyref="callback-section-title" /> diff --git a/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita b/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita index bbee847284e..712c4870835 100644 --- a/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita +++ b/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita @@ -30,26 +30,34 @@ onUserJoined;

    -
    +
      -
    • 通信场景下，该回调提示有远端用户加入了频道。如果加入之前，已经有其他用户在频道中了，新加入的用户也会收到这些已有用户加入频道的回调。
      • +
    • 通信场景下，该回调提示有远端用户加入了频道。如果加入之前已经有其他用户在频道中，新加入的用户也会收到这些已有用户加入频道的回调。
    • 直播场景下，该回调提示有主播加入了频道。如果加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入频道的回调。建议连麦主播不超过 17 人。
    + +
    +
    + 触发时机

    该回调在如下情况下会被触发： -

      -
    • 远端用户/主播加入频道。
      • -
    • 远端用户加入频道后将用户角色改变为主播。
      • -
    • 远端用户/主播网络中断后重新加入频道。
      • -

    +
      +
    • 远端用户/主播加入频道。
      • +
    • 远端用户加入频道后将用户角色改变为主播。
      • +
    • 远端用户/主播网络中断后重新加入频道。
      • +

    +
    +
    + 使用限制 +

    无。

    -
    +
    <ph keyref="callback-section-title" /> - + connection Connection 信息。详见 。