文档中心





互动直播 (Legacy)

Console 官网社区技术支持





Electron SDK API Reference

概览 AgoraRtcEngine AgoraRtcEngine.on AgoraRtcChannel AgoraRtcChannel.on 警告码错误码

since

v3.0.0

AgoraRtcChannel 类

Hierarchy

EventEmitter
- AgoraRtcChannel

Index

Constructors

constructor

Properties

rtcChannel

Methods

Constructors

constructor

new AgoraRtcChannel(rtcChannel: NodeRtcChannel): AgoraRtcChannel

Parameters
- rtcChannel: NodeRtcChannel
Returns AgoraRtcChannel

Properties

rtcChannel

rtcChannel: NodeRtcChannel

Methods

addPublishStreamUrl

addPublishStreamUrl(url: string, transcodingEnabled: boolean): number

增加旁路推流地址。

调用该方法后，SDK 会在本地触发 streamPublished 回调，报告增加旁路推流地址的状态。
note
- 该方法仅适用于直播场景下的主播，请在加入频道后调用该方法。
- 确保已开通旁路推流的功能，详见《旁路推流》的 “前提条件”。
- 该方法每次只能增加一路旁路推流地址。若需推送多路流，则需多次调用该方法。
Parameters
- url: string
  
  旁路推流地址，格式为 RTMP。该字符长度不能超过 1024 字节，且不支持中文等特殊字符。
- transcodingEnabled: boolean
  设置是否转码：
  - true: 转码。转码是指在旁路推流时对音视频流进行转码处理后，再推送到其他 RTMP 服务器。多适用于频道内有多个主播，需要进行混流、合图的场景。如果设为 true，需先调用 setLiveTranscoding 方法。
  - false: 不转码。
Returns number
- 0：方法调用成功
- < 0：方法调用失败
  - ERR_INVALID_ARGUMENT (2): RTMP 流地址为空或者字符长度为 0。
  - ERR_NOT_INITIALIZED (7): 使用该功能之前没有初始化 AgoraRtcChannel。

adjustUserPlaybackSignalVolume

adjustUserPlaybackSignalVolume(uid: number, volume: number): number

since

v3.0.0

调节本地播放的指定远端用户音量。

你可以在通话中调用该方法调节指定远端用户在本地播放的音量。如需调节多个用户在本地播放的音量，则需多次调用该方法。

note
- 请在加入频道后，调用该方法。
- 该方法调节的是本地播放的指定远端用户混音后的音量。
Parameters
- uid: number
  
  远端用户 ID。
- volume: number
  播放音量，取值范围为 [0,100]:
  - 0: 静音
  - 100: 原始音量
Returns number
- 0：方法调用成功
- < 0：方法调用失败

channelId

channelId(): string

获取当前频道的频道名。

Returns string
- 方法调用成功，返回 AgoraRtcChannel
- 方法调用失败，返回空字符串

createDataStream

createDataStream(reliable: boolean, ordered: boolean): number

创建数据流。
deprecated

该方法自 v3.3.1 起废弃，请改用 createDataStreamWithConfig

该方法用于创建数据流。AgoraRtcChannel 生命周期内，每个用户最多只能创建 5 个数据流。

note
- 频道内数据通道最多允许数据延迟 5 秒，若超过 5 秒接收方尚未收到数据流，则数据通道会向 App 报错。
- 请将 reliable 和 ordered 同时设置为 true 或 false，暂不支持交叉设置。
Parameters
- reliable: boolean
  - true：接收方 5 秒内会收到发送方所发送的数据，否则会收到 streamMessageError 回调并获得相应报错信息
  - false：接收方不保证收到，就算数据丢失也不会报错
- ordered: boolean
  - true：接收方 5 秒内会按照发送方发送的顺序收到数据包
  - false：接收方不保证按照发送方发送的顺序收到数据包
Returns number
- 创建数据流成功则返回数据流 ID
- < 0：创建数据流失败。如果返回的错误码是负数，对应错误代码和警告代码里的正整数

createDataStreamWithConfig

createDataStreamWithConfig(config: DataStreamConfig): number

创建数据流。

since

v3.3.1

该方法用于创建数据流。每个用户在每个频道内最多只能创建 5 个数据流。

相比 createDataStream，本方法不支持数据可靠，接收方会丢弃超出发送时间 5 秒后的数据包。

Parameters
- config: DataStreamConfig
  
  数据流设置
Returns number
- 返回数据流 ID，创建数据流成功。
- < 0: 创建数据流失败。

enableEncryption

enableEncryption(enabled: boolean, config: EncryptionConfig): number

开启或关闭内置加密。

since

v3.2.0

在安全要求较高的场景下，Agora 建议你在加入频道前，调用 enableEncryption 方法开启内置加密。

同一频道内所有用户必须使用相同的加密模式和密钥。用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。

note

如果开启了内置加密，则不能使用旁路推流功能。

Parameters
- enabled: boolean
  是否开启内置加密：
  - true: 开启
  - false: 关闭
- config: EncryptionConfig
  
  配置内置加密模式和密钥。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败
  - -2: 调用了无效的参数。需重新指定参数。
  - -4: 设置的加密模式不正确或加载外部加密库失败。需检查枚举值是否正确或重新加载外部加密库。
  - -7: SDK 尚未初始化。需在调用 API 之前已创建 AgoraRtcEngine 对象并完成初始化。

getCallId

getCallId(): string

获取通话 ID。

客户端在每次 joinChannel 后会生成一个对应的 CallId，标识该客户端的此次通话。有些方法如 rate, complain 需要在通话结束后调用，向 SDK 提交反馈，这些方法必须指定 CallId 参数。使用这些反馈方法，需要在通话过程中调用 getCallId 方法获取 CallId，在通话结束后在反馈方法中作为参数传入。

Returns string

通话 ID

getConnectionState

getConnectionState(): CONNECTION_STATE_TYPE

获取当前网络连接状态。

Returns CONNECTION_STATE_TYPE

connect 网络连接状态

initEventHandler

initEventHandler(): void

Returns void

joinChannel

joinChannel(token: string, info: string, uid: number, options: ChannelMediaOptions): number

加入频道并设置是否自动订阅音频或视频流。

该方法让用户加入通话频道，在同一个频道内的用户可以互相通话，多个用户加入同一个频道，可以群聊。使用不同 App ID 的 App 是不能互通的。如果已在通话中，用户必须调用 leaveChannel 退出当前通话，才能进入下一个频道。

成功调用该方法加入频道后，本地会触发 joinChannelSuccess 回调；通信场景下的用户和直播场景下的主播加入频道后，远端会触发 userJoined 回调。

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

note

请确保用于生成 Token 的 App ID 和调用 initialize 时传入的 App ID 一致。

Parameters
- token: string
  
  在服务端生成的用于鉴权的 Token。详见从服务端生成 Token。
- info: string
  
  (非必选项) 预留参数。
- uid: number
  
  (非必选项) 用户 ID，32位无符号整数。建议设置范围：1到 2³²-1，并保证唯一性。如果不指定（即设为0），SDK 会自动分配一个，并在 joinChannelSuccess 回调方法中返回，App 层必须记住该返回值并维护，SDK 不对该返回值进行维护。请注意：频道内每个用户的 UID 必须是唯一的。如果想要从不同的设备同时接入同一个频道，请确保每个设备上使用的 UID 是不同的。
- options: ChannelMediaOptions
  
  频道媒体设置选项。
Returns number
- 0(ERR_OK): 方法调用成功。
- < 0: 方法调用失败。
  - -2: 参数无效。
  - -3: SDK 初始化失败，请尝试重新初始化 SDK。
  - -5: 调用被拒绝。可能有如下两个原因：
    - 已经创建了一个同名的 AgoraRtcChannel 频道。
    - 已经通过 IChannel 加入了一个频道，并在该 AgoraRtcChannel 频道中发布了音视频流。由于通过 AgoraRtcEngine 加入频道会默认发布音视频流，而 SDK 不支持同时在两个频道发布音视频流，因此会报错。
  - -7: SDK 尚未初始化，就调用该方法。请确认在调用 API 之前已创建 AgoraRtcRtcEngine 对象并完成初始化。

joinChannelWithUserAccount

joinChannelWithUserAccount(token: string, userAccount: string, options: ChannelMediaOptions): number

使用 User Account 加入频道。

该方法允许本地用户使用 User Account 加入频道。成功加入频道后，会触发以下回调：
- 本地：localUserRegistered 和 joinChannelSuccess 回调
- 远端：通信场景下的用户和直播场景下的主播加入频道后，远端会依次触发 userJoined 和 userInfoUpdated 回调
用户成功加入频道后，默认订阅频道内所有其他用户的音频流和视频流，因此产生用量并影响计费。如果想取消订阅，可以通过调用相应的 mute 方法实现。

note

为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 RTC Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。
Parameters
- token: string
  
  在服务端生成的用于鉴权的 Token。详见从服务端生成 Token。
- userAccount: string
  用户 User Account。该参数为必需，最大不超过 255 字节，不可为 null。请确保注册的 User Account 的唯一性。以下为支持的字符集范围（共 89 个字符）：
  - 26 个小写英文字母 a-z
  - 26 个大写英文字母 A-Z
  - 10 个数字 0-9
  - 空格
  - "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
- options: ChannelMediaOptions
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败
  - -2
  - -3
  - -5
  - -7

leaveChannel

leaveChannel(): number

离开频道。

离开频道，即机挂断或退出通话。

该方法会把回话相关的所有资源都释放掉。该方法是异步操作，调用返回时并没有真正退出频道。真正退出频道后，本地会触发 leaveChannel 回调；通信场景下的用户和直播场景下的主播离开频道后，远端会触发 removeStream 回调。
note
- 若想开始下一次通话，必须先调用该方法结束本次通话。
- 不管当前是否在通话中，都可以调用该方法，没有副作用。
- 如果你调用该方法后立即调用 release 方法，SDK 将无法触发 leaveChannel 回调。
Returns number
- 0：方法调用成功
- < 0：方法调用失败

muteAllRemoteAudioStreams

muteAllRemoteAudioStreams(mute: boolean): number

取消或恢复订阅所有远端用户的音频流。

自 v3.3.1 起，成功调用该方法后，本地用户会取消或恢复订阅所有远端用户的音频流，包括在调用该方法后加入频道的用户的音频流。
note
- 该方法需要在加入频道后调用。
- 该方法的推荐设置详见《设置订阅状态》。
Parameters
- mute: boolean
  是否取消订阅所有远端用户的音频流。
  - true: 取消订阅。
  - false:（默认）订阅。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败

muteAllRemoteVideoStreams

muteAllRemoteVideoStreams(mute: boolean): number

取消或恢复订阅所有远端用户的视频流。

自 v3.3.1 起，成功调用该方法后，本地用户会取消或恢复订阅所有远端用户的视频流，包括在调用该方法后加入频道的用户的视频流。
note
- 该方法需要在加入频道后调用。
- 该方法的推荐设置详见《设置订阅状态》。
Parameters
- mute: boolean
  是否取消订阅所有远端用户的视频流。
  - true: 取消订阅。
  - false:（默认）订阅。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败

muteLocalAudioStream

muteLocalAudioStream(mute: boolean): number

取消或恢复发布本地音频流。
since

v3.4.5

该方法仅设置用户在 IChannel 频道中的音频发布状态。

成功调用该方法后，远端会触发 remoteAudioStateChanged 回调。

同一时间，本地的音视频流只能发布到一个频道。如果你创建了多个频道，请确保你只在一个频道中调用 AgoraRtcChannel.muteLocalAudioStream(false)，否则方法会调用失败并返回 -5 (ERR_REFUSED)。

note
- 该方法不会改变音频采集设备的使用状态。
- 该方法的调用是否生效受 joinChannel 和 setClientRole 方法的影响，详见《设置发布状态》。
Parameters
- mute: boolean
  是否取消发布本地音频流。
  - true: 取消发布。
  - false: 发布。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败
  - -5 (ERR_REFUSED): 调用被拒绝。

muteLocalVideoStream

muteLocalVideoStream(mute: boolean): number

取消或恢复发布本地视频流。
since

v3.4.5

该方法仅设置用户在 IChannel 频道中的视频发布状态。

成功调用该方法后，远端会触发 remoteVideoStateChanged 回调。

同一时间，本地的音视频流只能发布到一个频道。如果你创建了多个频道，请确保你只在一个频道中调用 AgoraRtcChannel.muteLocalVideoStream(false)，否则方法会调用失败并返回 -5 (ERR_REFUSED)。

note
- 该方法不会改变视频采集设备的使用状态。
- 该方法的调用是否生效受 joinChannel 和 setClientRole 方法的影响，详见《设置发布状态》。
Parameters
- mute: boolean
  是否取消发布本地视频流。
  - true: 取消发布。
  - false: 发布。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败
  - -5 (ERR_REFUSED): 调用被拒绝。

muteRemoteAudioStream

muteRemoteAudioStream(uid: number, mute: boolean): number

取消或恢复订阅指定远端用户的音频流。
note
- 该方法需要在加入频道后调用。
- 该方法的推荐设置详见《设置订阅状态》。
Parameters
- uid: number
- mute: boolean
  是否取消订阅指定远端用户的音频流。
  - true: 取消订阅。
  - false:（默认）订阅。
Returns number

muteRemoteVideoStream

muteRemoteVideoStream(uid: number, mute: boolean): number

取消或恢复订阅指定远端用户的视频流。
note
- 该方法需要在加入频道后调用。
- 该方法的推荐设置详见《设置订阅状态》。
Parameters
- uid: number
- mute: boolean
  是否取消订阅指定远端用户的视频流。
  - true: 取消订阅。
  - false:（默认）订阅。
Returns number

off

off(event: string | symbol, listener: function): this

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this
on(evt: "joinChannelSuccess", cb: function): this
on(evt: "channelWarning", cb: function): this
on(evt: "channelError", cb: function): this
on(evt: "rejoinChannelSuccess", cb: function): this
on(evt: "leaveChannel", cb: function): this
on(evt: "clientRoleChanged", cb: function): this
on(evt: "userJoined", cb: function): this
on(evt: "userOffline", cb: function): this
on(evt: "connectionLost", cb: function): this
on(evt: "requestToken", cb: function): this
on(evt: "tokenPrivilegeWillExpire", cb: function): this
on(evt: "rtcStats", cb: function): this
on(evt: "networkQuality", cb: function): this
on(evt: "remoteVideoStats", cb: function): this
on(evt: "remoteAudioStats", cb: function): this
on(evt: "remoteAudioStateChanged", cb: function): this
on(evt: "activeSpeaker", cb: function): this
on(evt: "firstRemoteAudioDecoded", cb: function): this
on(evt: "videoSizeChanged", cb: function): this
on(evt: "remoteVideoStateChanged", cb: function): this
on(evt: "streamMessage", cb: function): this
on(evt: "snapshotTaken", cb: function): this
on(evt: "audioDeviceTestVolumeIndication", cb: function): this
on(evt: "streamMessageError", cb: function): this
on(evt: "channelMediaRelayState", cb: function): this
on(evt: "channelMediaRelayEvent", cb: function): this
on(evt: "firstRemoteAudioFrame", cb: function): this
on(evt: string, listener: Function): this
on(evt: "rtmpStreamingStateChanged", cb: function): this
on(evt: "transcodingUpdated", cb: function): this
on(evt: "remoteSubscribeFallbackToAudioOnly", cb: function): this
on(evt: "connectionStateChanged", cb: function): this
on(evt: "audioPublishStateChanged", cb: function): this
on(evt: "videoPublishStateChanged", cb: function): this
on(evt: "audioSubscribeStateChanged", cb: function): this
on(evt: "videoSubscribeStateChanged", cb: function): this
on(evt: "firstRemoteVideoFrame", cb: function): this

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
成功加入频道。

Parameters
- evt: "joinChannelSuccess"
- cb: function
  - - (uid: number, elapsed: number): void
    - Parameters
      - uid: number
        
        用户 ID
      - elapsed: number
        
        从调用 joinChannel 开始到发生此事件过去的时间（毫秒)
      Returns void
Returns this
发生警告回调。

Parameters
- evt: "channelWarning"
- cb: function
  - - (warn: number, msg: string): void
    - Parameters
      - warn: number
        
        警告码
      - msg: string
        
        详细的警告信息
      Returns void
Returns this
发生错误回调。

Parameters
- evt: "channelError"
- cb: function
  - - (err: number, msg: string): void
    - Parameters
      - err: number
        
        错误码
      - msg: string
        
        详细的错误信息
      Returns void
Returns this
重新加入频道回调。

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

Parameters
- evt: "rejoinChannelSuccess"
- cb: function
  - - (uid: number, elapsed: number): void
    - Parameters
      - uid: number
        
        用户 ID
      - elapsed: number
        
        从调用 joinChannel 开始到发生此事件过去的时间（毫秒)
      Returns void
Returns this
用户离开频道。

调用 leaveChannel 离开频道后，SDK 触发该回调。

Parameters
- evt: "leaveChannel"
- cb: function
  - - (stats: RtcStats): void
    - Parameters
      - stats: RtcStats
      Returns void
Returns this
用户角色已切换回调。

回调由本地用户在加入频道后调用 setClientRole 改变用户角色触发的。

Parameters
- evt: "clientRoleChanged"
- cb: function
  - - (oldRole: CLIENT_ROLE_TYPE, newRole: CLIENT_ROLE_TYPE): void
    - Parameters
      - oldRole: CLIENT_ROLE_TYPE
        
        切换前的角色
      - newRole: CLIENT_ROLE_TYPE
        
        切换后的角色
      Returns void
Returns this
远端用户（通信场景）/主播（直播场景）加入当前频道回调。
- 通信场景下，该回调提示有远端用户加入了频道，并返回新加入用户的 ID；如果加入之前，已经有其他用户在频道中了，新加入的用户也会收到这些已有用户加入频道的回调。
- 直播场景下，该回调提示有主播加入了频道，并返回该主播的 ID。如果在加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入频道的回调。声网建议连麦主播不超过 17 人。
该回调在如下情况下会被触发：
- 远端用户/主播调用 joinChannel 方法加入频道
- 远端用户加入频道后调用 setClientRole 将用户角色改变为主播
- 远端用户/主播网络中断后重新加入频道
note
直播场景下
- 主播间能相互收到新主播加入频道的回调，并能获得该主播的 uid
- 观众也能收到新主播加入频道的回调，并能获得该主播的 uid
- 当 Web 端加入直播频道时，只要 Web 端有推流，SDK 会默认该 Web 端为主播，并触发该回调。
Parameters
- evt: "userJoined"
- cb: function
  - - (uid: number, elapsed: number): void
    - Parameters
      - uid: number
        
        新加入频道的远端用户/主播 ID
      - elapsed: number
        
        从本地调用 joinChannel 到发生此事件过去的时间（毫秒)
      Returns void
Returns this
远端用户离开当前频道回调。

用户离开频道有两个原因：
- 正常离开的时候，远端用户/主播会发送类似“再见”的消息。接收此消息后，判断用户离开频道。
- 超时掉线的依据是，在一定时间内（约 20 秒），用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。声网建议使用信令系统来做可靠的掉线检测。
Parameters
- evt: "userOffline"
- cb: function
  - - (uid: number, reason: number): void
    - Parameters
      - uid: number
        
        离线用户或主播的用户 ID。
      - reason: number
        
        离线原因
        
        0：用户主动离开。
        
        1：因过长时间收不到对方数据包，超时掉线。注意：由于 SDK 使用的是不可靠通道，也有可能对方主动离开本方没收到对方离开消息而误判为超时掉线。
        
        2：用户身份从主播切换为观众。
      Returns void
Returns this
网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。

note

SDK 在调用 joinChannel 后，无论是否加入成功，只要 10 秒和服务器无法连接就会触发该回调。如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，SDK 会停止尝试重连。

Parameters
- evt: "connectionLost"
- cb: function
  - - (): void
    - Returns void
Returns this
Token 已过期回调。

调用 joinChannel 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中 SDK 可能由于网络原因和服务器失去连接，重连时可能需要新的 Token。

该回调通知 App 需要生成新的 Token，并需调用 joinChannel 为 SDK 指定新的 Token。

Parameters
- evt: "requestToken"
- cb: function
  - - (): void
    - Returns void
Returns this
Token 服务即将过期回调。

在调用 joinChannel 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中如果 Token 即将失效，SDK 会提前 30 秒触发该回调，提醒 App 更新 Token。当收到该回调时，用户需要重新在服务端生成新的 Token，然后调用 renewToken 将新生成的 Token 传给 SDK。

Parameters
- evt: "tokenPrivilegeWillExpire"
- cb: function
  - - (token: string): void
    - Parameters
      - token: string
        
        即将服务失效的 Token
      Returns void
Returns this
通话相关统计信息。

Parameters
- evt: "rtcStats"
- cb: function
  - - (stats: RtcStats): void
    - Parameters
      - stats: RtcStats
        
        通话信息详情
      Returns void
Returns this
通话中每个用户的网络上下行 last mile 质量报告回调。

该回调描述每个用户在通话中的 last mile 网络状态，其中 last mile 是指设备到声网边缘服务器的网络状态。

该回调每 2 秒触发一次。如果远端有多个用户，该回调每 2 秒会被触发多次。

Parameters
- evt: "networkQuality"
- cb: function
  - - (uid: number, txquality: AgoraNetworkQuality, rxquality: AgoraNetworkQuality): void
    - Parameters
      - uid: number
        
        用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。当 uid 为 0 时，返回的是本地用户的网络质量
      - txquality: AgoraNetworkQuality
        
        该用户的上行网络质量，基于上行发送码率、上行丢包率、平均往返时延和网络抖动计算。
      - rxquality: AgoraNetworkQuality
        
        该用户的下行网络质量，基于下行网络的丢包率、平均往返延时和网络抖动计算。
      Returns void
Returns this
通话中远端视频流的统计信息回调。

Parameters
- evt: "remoteVideoStats"
- cb: function
  - - (stats: RemoteVideoStats): void
    - Parameters
      - stats: RemoteVideoStats
        
        远端视频流统计信息
      Returns void
Returns this
通话中远端音频流的统计信息回调。

Parameters
- evt: "remoteAudioStats"
- cb: function
  - - (stats: RemoteAudioStats): void
    - Parameters
      - stats: RemoteAudioStats
        
        远端音频流统计信息
      Returns void
Returns this
远端音频流状态发生改变回调。

远端用户/主播音频状态发生改变时，SDK 会触发该回调向本地用户报告当前的远端音频流状态。

Parameters
- evt: "remoteAudioStateChanged"
- cb: function
  - - (uid: number, state: RemoteAudioState, reason: RemoteAudioStateReason, elapsed: number): void
    - Parameters
      - uid: number
        
        发生音频状态改变的远端用户 ID。
      - state: RemoteAudioState
        
        远端音频流状态码
      - reason: RemoteAudioStateReason
        
        远端音频流状态改变的原因码
      - elapsed: number
        
        从本地用户调用 joinChannel 方法到发生本事件经历的时间，单位为 ms。
      Returns void
Returns this
检测到活跃用户回调。

如果用户开启了 enableAudioVolumeIndication 功能，则当音量检测模块监测到频道内有新的活跃用户说话时，会通过本回调返回该用户的 uid。

Parameters
- evt: "activeSpeaker"
- cb: function
  - - (uid: number): void
    - Parameters
      - uid: number
        
        当前时间段内声音最大的用户的 uid
      Returns void
Returns this
deprecated
该回调已废弃，请改用 remoteAudioStateChanged。

已解码远端音频首帧的回调

SDK 完成远端音频首帧解码，并发送给音频模块用以播放时，会触发此回调。有两种情况：
- 远端用户首次上线后发送音频
- 远端用户音频离线再上线发送音频。音频离线指本地在 15 秒内没有收到音频包，可能有如下原因：
  
  远端用户离开频道
  
  远端用户掉线
  
  远端用户停止发送音频流（通过调用 muteLocalAudioStream 方法）
  
  远端用户关闭音频（通过调用 disableAudio 方法）
Parameters
- evt: "firstRemoteAudioDecoded"
- cb: function
  - - (uid: number, elapsed: number): void
    - Parameters
      - uid: number
        
        用户 ID，指定是哪个用户的音频流
      - elapsed: number
        
        从本地用户调用 joinChannel 方法加入频道直至该回调触发的延迟，单位为毫秒
      Returns void
Returns this
本地或远端视频大小和旋转信息发生改变回调。

Parameters
- evt: "videoSizeChanged"
- cb: function
  - - (uid: number, width: number, height: number, rotation: number): void
    - Parameters
      - uid: number
        
        图像尺寸和旋转信息发生变化的用户的用户 ID（本地用户的 uid 为 0）
      - width: number
        
        视频流的宽度（px）
      - height: number
        
        视频流的高度（px）
      - rotation: number
        
        旋转信息 [0, 360]
      Returns void
Returns this
远端用户视频流状态发生改变回调。

Parameters
- evt: "remoteVideoStateChanged"
- cb: function
  - - (uid: number, state: RemoteVideoState, reason: RemoteVideoStateReason, elapsed: number): void
    - Parameters
      - uid: number
        
        发生视频流状态改变的远端用户的用户 ID。
      - state: RemoteVideoState
        
        远端视频流状态
      - reason: RemoteVideoStateReason
        
        远端视频流状态改变的具体原因
      - elapsed: number
        
        从本地用户调用 joinChannel 方法到发生本事件经历的时间，单位为 ms。
      Returns void
Returns this
接收到对方数据流消息的回调。

该回调表示本地用户收到了远端用户调用 sendStreamMessage 方法发送的流消息。

Parameters
- evt: "streamMessage"
- cb: function
  - - (uid: number, streamId: number, data: string): void
    - Parameters
      - uid: number
        
        用户 ID
      - streamId: number
        
        数据流 ID
      - data: string
      Returns void
Returns this
视频截图结果回调。

since

v3.6.1.4

成功调用 takeSnapshot 后，SDK 触发该回调报告截图是否成功和获取截图的详情。

Parameters
- evt: "snapshotTaken"
- cb: function
  - - (channel: string, uid: number, filePath: number, width: number, height: number, errCode: number): void
    - Parameters
      - channel: string
      - uid: number
      - filePath: number
      - width: number
      - height: number
      - errCode: number
      Returns void
Returns this
音频设备测试回调。

since

v3.7.0

成功调用 startAudioDeviceLoopbackTest 方法开启音频设备测试后， SDK 会按设置的时间间隔触发 audioDeviceTestVolumeIndication 回调，报告被测试音频设备的音量信息。

Parameters
- evt: "audioDeviceTestVolumeIndication"
- cb: function
  - - (volumeType: AudioDeviceTestVolumeType, volume: number): void
    - Parameters
      - volumeType: AudioDeviceTestVolumeType
        
        音量类型。详见 AudioDeviceTestVolumeType。
      - volume: number
        
        音量大小，范围为 [0,255]。
      Returns void
Returns this
接收对方数据流小时发生错误回调。

该回调表示本地用户未收到远端用户调用 sendStreamMessage 方法发送的流消息。

Parameters
- evt: "streamMessageError"
- cb: function
  - - (uid: number, streamId: number, code: number, missed: number, cached: number): void
    - Parameters
      - uid: number
        
        用户 ID
      - streamId: number
        
        数据流 ID
      - code: number
      - missed: number
        
        丢失的消息数量
      - cached: number
        
        数据流中断后，后面缓存的消息数量
      Returns void
Returns this
跨频道媒体流转发状态发生改变回调。

当跨频道媒体流转发状态发生改变时，SDK 会触发该回调，并报告当前的转发状态以及相关的错误信息。

Parameters
- evt: "channelMediaRelayState"
- cb: function
  - - (state: ChannelMediaRelayState, code: ChannelMediaRelayError): void
    - Parameters
      - state: ChannelMediaRelayState
        
        跨频道媒体流转发状态码
      - code: ChannelMediaRelayError
        
        跨频道媒体流转发出错的错误码
      Returns void
Returns this
跨频道媒体流转发事件回调。

该回调报告跨频道媒体流转发过程中发生的事件。

Parameters
- evt: "channelMediaRelayEvent"
- cb: function
  - - (event: ChannelMediaRelayEvent): void
    - Parameters
      - event: ChannelMediaRelayEvent
        
        跨频道媒体流转发事件码
      Returns void
Returns this
deprecated

该回调已废弃，请改用 remoteAudioStateChanged。

已接收远端音频首帧回调。

Parameters
- evt: "firstRemoteAudioFrame"
- cb: function
  - - (uid: number, elapsed: number): void
    - Parameters
      - uid: number
        
        发送音频帧的远端用户的 ID
      - elapsed: number
        
        从调用 joinChannel 方法直至该回调被触发的延迟（毫秒）
      Returns void
Returns this
Parameters
- evt: string
- listener: Function
Returns this
旁路推流状态发生改变回调。

该回调返回本地用户调用 addPublishStreamUrl 或 removePublishStreamUrl 方法的结果。

旁路推流状态发生改变时，SDK 会触发该回调，并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态；推流出错时，你可以通过返回的错误码了解出错的原因，方便排查问题。

Parameters
- evt: "rtmpStreamingStateChanged"
- cb: function
  - - (url: string, state: number, code: number): void
    - Parameters
      - url: string
        
        推流状态发生改变的 URL 地址
      - state: number
        
        推流状态：
        
        0: 推流未开始或已结束。成功调用 removePublishStreamUrl 后会返回该状态。
        
        1: 正在连接声网推流服务器和 RTMP 服务器。调用 addPublishStreamUrl 后会返回该状态。
        
        2: 推流正在进行。成功推流后，会返回该状态。
        
        3: 正在恢复推流。当 CDN 出现异常，或推流短暂中断时，SDK 会自动尝试恢复推流，并返回该状态。
        
        如成功恢复推流，则进入状态 2。
        
        如服务器出错或 60 秒内未成功恢复，则进入状态 4。如果觉得 60 秒太长，也可以主动调用 addPublishStreamUrl，再调用 removePublishStreamUrl 尝试重连。
        
        4: 推流失败。失败后，你可以通过返回的错误码排查错误原因，也可以再次调用 addPublishStreamUrl 重新尝试推流。
        
        5: SDK 正在与声网推流服务器和 CDN 服务器断开连接。当你调用 remove 或 stop 方法正常结束推流时，SDK 会依次报告推流状态为 DISCONNECTING、IDLE。
      - code: number
        
        推流错误码：
        
        0: 推流成功。
        
        1: 参数无效。请检查输入参数是否正确。
        
        2: 推流已加密，不能推流。
        
        3: 推流超时未成功。可调用 addPublishStreamUrl 重新推流。
        
        4: 推流服务器出现错误。请调用 addPublishStreamUrl 重新推流。
        
        5: RTMP 服务器出现错误。
        
        6: 推流请求过于频繁。
        
        7: 单个主播的推流地址数目达到上线 10。请删掉一些不用的推流地址再增加推流地址。
        
        8: 主播操作不属于自己的流。例如更新其他主播的流参数、停止其他主播的流。请检查 App 逻辑。
        
        9: 服务器未找到这个流。
        
        10: 推流地址格式有错误。请检查推流地址格式是否正确。
        
        11: 用户角色不是主播，该用户无法使用推流功能。请检查你的应用代码逻辑。
        
        13: 非转码推流情况下，调用了 updateRtmpTranscoding 或 setLiveTranscoding 方法更新转码属性。请检查你的应用代码逻辑。
        
        14: 主播的网络出错。
        
        15: 你的 App ID 没有使用声网推流服务的权限。请参考前提条件开启推流服务。
      Returns void
Returns this
旁路推流设置被更新回调。该回调用于通知主播 CDN 转码已成功更新。

setLiveTranscoding 方法中的转码合图参数（LiveTranscoding）更新时，transcodingUpdated 回调会被触发并向主播报告更新信息。

note

首次调用 setLiveTranscoding 方法设置转码合图参数（LiveTranscoding）时，不会触发此回调。

Parameters
- evt: "transcodingUpdated"
- cb: function
  - - (): void
    - Returns void
Returns this
远端订阅流已回退为音频流回调。

如果你调用了设置远端订阅流回退选项 setRemoteSubscribeFallbackOption 并将 option 设置为 2 时，当下行网络环境不理想、仅接收远端音频流时，或当下行网络改善、恢复订阅音视频流时，会触发该回调。

远端订阅流因弱网环境不能同时满足音视频而回退为小流时，你可以使用 remoteVideoStats 回调来监控远端视频大小流的切换。

Parameters
- evt: "remoteSubscribeFallbackToAudioOnly"
- cb: function
  - - (uid: number, isFallbackOrRecover: boolean): void
    - Parameters
      - uid: number
        
        远端用户的 ID
      - isFallbackOrRecover: boolean
        
        远端订阅流已回退或恢复：
        
        true：由于网络环境不理想，远端订阅流已回退为音频流
        
        false：由于网络环境改善，订阅的音频流已恢复为音视频流
      Returns void
Returns this
网络连接状态已改变回调。

该回调在网络连接状态发生改变的时候触发，并告知用户当前的网络连接状态，和引起网络状态改变的原因。

Parameters
- evt: "connectionStateChanged"
- cb: function
  - - (state: CONNECTION_STATE_TYPE, reason: CONNECTION_CHANGED_REASON_TYPE): void
    - Parameters
      - state: CONNECTION_STATE_TYPE
        
        当前的网络连接状态
      - reason: CONNECTION_CHANGED_REASON_TYPE
        
        引起当前网络连接状态发生改变的原因
      Returns void
Returns this
音频发布状态改变回调。

since

v3.2.0

Parameters
- evt: "audioPublishStateChanged"
- cb: function
  - - (oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: number): void
    - Parameters
      - oldState: STREAM_PUBLISH_STATE
        
        之前的发布状态。
      - newState: STREAM_PUBLISH_STATE
        
        当前的发布状态。
      - elapseSinceLastState: number
        
        两次状态变化时间间隔（毫秒）。
      Returns void
Returns this
视频发布状态改变回调。

since

v3.2.0

Parameters
- evt: "videoPublishStateChanged"
- cb: function
  - - (oldState: STREAM_PUBLISH_STATE, newState: STREAM_PUBLISH_STATE, elapseSinceLastState: number): void
    - Parameters
      - oldState: STREAM_PUBLISH_STATE
        
        之前的发布状态。
      - newState: STREAM_PUBLISH_STATE
        
        当前的发布状态。
      - elapseSinceLastState: number
        
        两次状态变化时间间隔（毫秒）。
      Returns void
Returns this
音频订阅状态发生改变回调。

since

v3.2.0

Parameters
- evt: "audioSubscribeStateChanged"
- cb: function
  - - (uid: number, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: number): void
    - Parameters
      - uid: number
        
        远端用户的 ID。
      - oldState: STREAM_SUBSCRIBE_STATE
        
        之前的订阅状态。
      - newState: STREAM_SUBSCRIBE_STATE
        
        当前的订阅状态。
      - elapseSinceLastState: number
        
        两次状态变化时间间隔（毫秒）。
      Returns void
Returns this
视频订阅状态发生改变回调。

since

v3.2.0

Parameters
- evt: "videoSubscribeStateChanged"
- cb: function
  - - (uid: number, oldState: STREAM_SUBSCRIBE_STATE, newState: STREAM_SUBSCRIBE_STATE, elapseSinceLastState: number): void
    - Parameters
      - uid: number
        
        远端用户的 ID。
      - oldState: STREAM_SUBSCRIBE_STATE
        
        之前的订阅状态。
      - newState: STREAM_SUBSCRIBE_STATE
        
        当前的订阅状态。
      - elapseSinceLastState: number
        
        两次状态变化时间间隔（毫秒）。
      Returns void
Returns this
已显示首帧远端视频回调。

第一帧远端视频显示在视图上时，触发此调用。 App 可在此调用中获知出图时间（elapsed）。

Parameters
- evt: "firstRemoteVideoFrame"
- cb: function
  - - (uid: number, width: number, height: number, elapsed: number): void
    - Parameters
      - uid: number
        
        用户 ID，指定是哪个用户的视频流。
      - width: number
        
        视频流宽（px）。
      - height: number
        
        视频流高（px）。
      - elapsed: number
        
        从本地调用 joinChannel 到发生此事件过去的时间（毫秒)。
      Returns void
Returns this

publish

publish(): number

将本地音视频流发布到本频道。
deprecated
该方法自 v3.4.5 起废弃，请改用 muteLocalAudioStream(false) 或 muteLocalVideoStream(false)。

该方法的调用需满足以下要求，否则 SDK 会返回错误码 ERR_REFUSED (5):
- 该方法仅支持将音视频流发布到当前 AgoraRtcChannel 类所对应的频道。
- 直播场景下，该方法仅适用于角色为主播的用户。你可以调用该 AgoraRtcChannel 类下的 setClientRole 设置用户角色。
- SDK 只支持用户同一时间在一个频道发布一路音视频流。详情请参考高阶指南多频道管理。
Returns number
- 0：方法调用成功
- < 0：方法调用失败
  - ERR_REFUSED (5): 调用被拒绝

registerMediaMetadataObserver

registerMediaMetadataObserver(): number

注册媒体附属信息观测器。

Returns number
- 0: 方法调用成功
- < 0: 方法调用失败

release

release(): number

释放 AgoraRtcChannel 所有资源。

调用该方法后，用户将无法再使用 AgoraRtcChannel 中的所有方法和回调。

Returns number
- 0：方法调用成功
- < 0：方法调用失败

removePublishStreamUrl

removePublishStreamUrl(url: string): number

删除旁路推流地址。

调用该方法后，SDK 会在本地触发 streamUnpublished 回调，报告删除旁路推流地址的状态。
note
- 该方法只适用于直播场景下的用户。
- 该方法每次只能删除一路旁路推流地址。若需删除多路流，则需多次调用该方法。
- 推流地址不支持中文等特殊字符。
Parameters
- url: string
  
  待删除的推流地址，格式为 RTMP。该字符长度不能超过 1024 字节。
Returns number
- 0：方法调用成功
- < 0：方法调用失败

renewToken

renewToken(newtoken: string): number

更新 Token。

如果启用了 Token 机制，过一段时间后使用的 Token 会失效。当报告错误码 109或 tokenPrivilegeWillExpire 回调时，你应重新获取 Token，然后调用该 API 更新 Token，否则 SDK 无法和服务器建立连接。

Parameters
- newtoken: string
  
  新的 Token
Returns number
- 0：方法调用成功
- < 0：方法调用失败

sendMetadata

sendMetadata(metadata: Metadata): number

发送媒体附属信息。

调用 registerMediaMetadataObserver 后，你可以调用本方法来发送媒体附属信息。

如果发送成功，发送方会收到 sendMetadataSuccess 回调，接收方会收到 receiveMetadata 回调。

Parameters
- metadata: Metadata
  
  媒体附属信息。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败

sendStreamMessage

sendStreamMessage(streamId: number, msg: string): number

发送数据流。

该方法发送数据流消息到频道内所有用户。

SDK 对该方法的实现进行了如下限制：频道内每秒最多能发送 30 个包，且每个包最大为 1 KB。每个客户端每秒最多能发送 6 KB 数据。频道内每人最多能同时有 5 个数据通道。

成功调用该方法后，远端会触发 streamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 streamMessageError 回调。
note
- 该方法仅适用于通信场景以及直播场景下的主播用户，如果直播场景下的观众调用此方法可能会造成观众变主播。
- 请确保在调用该方法前，已调用 createDataStream 创建了数据通道。
Parameters
- streamId: number
  
  数据流 ID，createDataStream 的返回值
- msg: string
  
  待发送的数据
Returns number
- 0：方法调用成功
- < 0：方法调用失败

sendStreamMessageWithArrayBuffer

sendStreamMessageWithArrayBuffer(streamId: number, buffer: UInt8ArrayBuffer): number

Parameters
- streamId: number
- buffer: UInt8ArrayBuffer
Returns number

setClientRole

setClientRole(role: CLIENT_ROLE_TYPE): number

设置直播场景下的用户角色。

加入频道前，用户需要通过本方法设置观众或主播模式。

加入频道后，用户可以通过本方法切换用户模式。直播场景下，如果你在加入频道后调用该方法切换用户角色，调用成功后，本地会触发 clientRoleChanged 事件；远端会触发 userJoined 事件。

Parameters
- role: CLIENT_ROLE_TYPE
  用户角色：
  - 1：主播
  - 2：（默认）观众
Returns number
- 0：方法调用成功
- < 0：方法调用失败

setClientRoleWithOptions

setClientRoleWithOptions(role: CLIENT_ROLE_TYPE, options: ClientRoleOptions): number

设置直播场景下的用户角色和观众端延时级别。
since
v3.2.0

在加入频道前和加入频道后均可调用该方法设置用户角色。

如果你在加入频道后调用该方法成功切换用户角色，SDK 会触发以下回调：
- 本地触发 clientRoleChanged 回调。
- 远端触发 userJoined 或 userOffline 回调。
note
- 该方法仅在频道场景为直播时生效。
- 该方法与 setClientRole 的区别在于，该方法还支持设置用户级别。
  
  用户角色确定用户在 SDK 层的权限，包含是否可以发送流、是否可以接收流、是否可以旁路推流等。
  
  用户级别需要与角色结合使用，确定用户在其权限范围内，可以操作和享受到的服务级别。例如对于观众，选择接收低延时还是超低延时的视频流。不同的级别会影响计费。
Parameters
- role: CLIENT_ROLE_TYPE
  
  直播场景中的用户角色。
- options: ClientRoleOptions
  
  用户具体设置，包含用户级别。
Returns number
- 0：方法调用成功
- < 0：方法调用失败

setDefaultMuteAllRemoteAudioStreams

setDefaultMuteAllRemoteAudioStreams(mute: boolean): number

默认取消或恢复订阅远端用户的音频流。
deprecated

该方法自 v3.3.1 起废弃。

该方法需要在加入频道后调用。调用成功后，本地用户取消或恢复订阅调用时刻之后加入频道的远端用户。

note
取消订阅音频流后，如果需要恢复订阅频道内的远端，可以进行如下操作：
- 如果需要恢复订阅单个用户的音频流，调用 muteRemoteAudioStream(false)，并指定你想要订阅的远端用户 ID。
- 如果想恢复订阅多个用户的音频流，则需要多次调用 muteRemoteAudioStream(false)。
Parameters
- mute: boolean
  是否默认取消订阅远端用户的音频流：
  - true: 默认取消订阅。
  - false:（默认）默认订阅。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败

setDefaultMuteAllRemoteVideoStreams

setDefaultMuteAllRemoteVideoStreams(mute: boolean): number

默认取消或恢复订阅远端用户的视频流。
deprecated

该方法自 v3.3.1 起废弃。

该方法需要在加入频道后调用。调用成功后，本地用户取消或恢复订阅调用时刻之后加入频道的远端用户。

note
取消订阅视频流后，如果需要恢复订阅频道内的远端，可以进行如下操作：
- 如果需要恢复订阅单个用户的视频流，调用 muteRemoteVideoStream(false)，并指定你想要订阅的远端用户 ID。
- 如果想恢复订阅多个用户的视频流，则需要多次调用 muteRemoteVideoStream(false)。
Parameters
- mute: boolean
  是否默认取消订阅远端用户的视频流：
  - true: 默认取消订阅。
  - false:（默认）默认订阅。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败

setEncryptionMode

setEncryptionMode(mode: string): number

设置内置的加密方案。

deprecated

该方法自 v3.2.0 废弃，请改用 enableEncryption。 RTC Native SDK 支持内置加密功能，默认使用 AES-128-XTS 加密方式。如需使用其他加密方式，可以调用该 API 设置。

同一频道内的所有用户必须设置相同的加密方式和密码才能进行通话。关于这几种加密方式的区别，请参考 AES 加密算法的相关资料。

note

调用本方法前，请先调用 setEncryptionSecret 方法启用内置加密功能。

Parameters
- mode: string
  加密方式。目前支持以下几种：
  - "aes-128-xts"：128 位 AES 加密，XTS 模式
  - "aes-128-ecb"：128 位 AES 加密，ECB 模式
  - "aes-256-xts"：256 位 AES 加密，XTS 模式
  - ""：设置为空字符串时，默认使用加密方式 aes-128-xts
Returns number
- 0：方法调用成功
- < 0：方法调用失败

setEncryptionSecret

setEncryptionSecret(secret: string): number

deprecated

该方法自 v3.2.0 起废弃。请改用 enableEncryption 方法。

启用内置加密，并设置数据加密密码。

如需启用加密，请在 joinChannel 前调用该方法，并设置加密的密码。同一频道内的所有用户应设置相同的密码。当用户离开频道时，该频道的密码会自动清除。如果未指定密码或将密码设置为空，则无法激活加密功能。

note

为保证最佳传输效果，请确保加密后的数据大小不超过原始数据大小 + 16 字节。16 字节是 AES 通用加密模式下最大填充块大小。

Parameters
- secret: string
  
  加密密码
Returns number
- 0：方法调用成功
- < 0：方法调用失败

setLiveTranscoding

setLiveTranscoding(transcoding: TranscodingConfig): number

设置直播转码。

调用该方法更新 transcoding 参数时，SDK 会触发 transcodingUpdated 回调。
note
- 该方法只适用于直播场景下的主播。
- 请确保已开通 CDN 旁路推流的功能，详见《旁路推流》文档的 “前提条件”。
- 首次调用 setLiveTranscoding 方法设置 transcoding 时，不会触发该回调。
Parameters
- transcoding: TranscodingConfig
  
  旁路推流转码合图相关设置
Returns number
- 0：方法调用成功
- < 0：方法调用失败

setMaxMetadataSize

setMaxMetadataSize(size: number): number

设置媒体附属信息的最大大小。

调用 registerMediaMetadataObserver 后，你可以调用本方法来设置媒体附属信息的最大大小。

Parameters
- size: number
  
  媒体附属信息的最大大小。
Returns number
- 0: 方法调用成功
- < 0: 方法调用失败

setRemoteDefaultVideoStreamType

setRemoteDefaultVideoStreamType(streamType: StreamType): number

设置默认订阅的视频流类型。

在网络条件受限的情况下，如果发送端没有调用 enableDualStreamMode(false) 关闭双流模式，接收端可以选择接收大流还是小流。其中，大流可以接为高分辨率高码率的视频流，小流则是低分辨率低码率的视频流。

正常情况下，用户接收大流。如需默认接收小流，可以调用本方法进行切换。SDK 会根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。

视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。

Parameters
- streamType: StreamType
  设置视频流的类型：
  - 0：视频大流，即高分辨、高码率的视频流
  - 1：视频小流，即低分辨、低码率的视频流
Returns number
- 0：方法调用成功
- < 0：方法调用失败

setRemoteUserPriority

setRemoteUserPriority(uid: number, priority: Priority): number

Parameters
- uid: number
- priority: Priority
Returns number

setRemoteVideoStreamType

setRemoteVideoStreamType(uid: number, streamType: StreamType): number

设置订阅的视频流类型。

在网络条件受限的情况下，如果发送端没有调用 enableDualStreamMode(false) 关闭双流模式，接收端可以选择接收大流还是小流。其中，大流可以接为高分辨率高码率的视频流，小流则是低分辨率低码率的视频流。

正常情况下，用户默认接收大流。如需接收小流，可以调用本方法进行切换。SDK 会根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。

视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。

调用本方法的执行结果将在 apiCallExecuted 中返回。

Parameters
- uid: number
  
  用户 ID
- streamType: StreamType
  
  视频流类型
Returns number
- 0：方法调用成功
- < 0：方法调用失败

setRemoteVoicePosition

setRemoteVoicePosition(uid: number, pan: number, gain: number): number

设置远端用户声音的空间位置和音量，方便本地用户听声辨位。

用户通过调用该接口，设置远端用户声音出现的位置，左右声道的声音差异会让用户产生声音的方位感，从而判断出远端用户的实时位置。在多人在线游戏场景，如吃鸡游戏中，该方法能有效增加游戏角色的方位感，模拟真实场景。
note
- 使用该方法需要在加入频道前调用 enableSoundPositionIndication 开启远端用户的语音立体声
- 为获得最佳听觉体验，我们建议用户佩戴耳机
Parameters
- uid: number
  
  远端用户的 ID
- pan: number
  设置远端用户声音出现的位置，取值范围为 [-1.0, 1.0]：
  - 0.0：（默认）声音出现在正前方
  - -1.0：声音出现在左边
  - 1.0：声音出现在右边
- gain: number
  
  设置远端用户声音的音量，取值范围为 [0.0, 100.0]，默认值为 100.0，表示该用户的原始音量。取值越小，则音量越低
Returns number
- 0：方法调用成功
- -1：方法调用失败

startChannelMediaRelay

startChannelMediaRelay(config: ChannelMediaRelayConfiguration): number

开始跨频道媒体流转发。

该方法可用于实现跨频道连麦等场景。

成功调用该方法后，SDK 会触发 channelMediaRelayState 和 channelMediaRelayEvent 回调，并在回调中报告当前的跨频道媒体流转发状态和事件。
- 如果 channelMediaRelayState 回调报告 ChannelMediaRelayState 中的状态码 1 和 ChannelMediaRelayError 中错误码为 0，且 channelMediaRelayEvent 回调报告 ChannelMediaRelayEvent 中的事件码 4，则表示 SDK 开始在源频道和目标频道之间转发媒体流。
- 如果 channelMediaRelayState 回调报告 ChannelMediaRelayState 中的状态码 3，则表示跨频道媒体流转发出现异常。
note
- 该功能需要联系 sales@agora.io 开通。
- 请在成功加入频道后调用该方法。
- 该方法仅对直播场景下的主播有效。
- 该功能不支持使用 String 型 uid。
- 成功调用该方法后，若你想再次调用该方法，必须先调用 stopChannelMediaRelay 方法退出当前的转发状态。
Parameters
- config: ChannelMediaRelayConfiguration
  
  跨频道媒体流转发参数配置
Returns number
- 0：方法调用成功
- < 0：方法调用失败

stopChannelMediaRelay

stopChannelMediaRelay(): number

停止跨频道媒体流转发。

一旦停止，主播会退出所有目标频道。

成功调用该方法后，SDK 会触发 channelMediaRelayState 回调。如果报告 ChannelMediaRelayState 中的状态码 0 和 ChannelMediaRelayError 中的错误码 0，则表示已停止转发媒体流。

note

如果该方法调用不成功，SDK 会触发 channelMediaRelayState 回调，并报告 ChannelMediaRelayError 中的错误码 2 或 8。你可以调用 leaveChannel 方法离开频道，跨频道媒体流转发会自动停止。

Returns number
- 0：方法调用成功
- < 0：方法调用失败

unRegisterMediaMetadataObserver

unRegisterMediaMetadataObserver(): number

取消注册媒体附属信息观测器。

Returns number
- 0: 方法调用成功
- < 0: 方法调用失败

unpublish

unpublish(): number

停止将本地音视频流发布到本频道。

deprecated

该方法自 v3.4.5 起废弃，请改用 muteLocalAudioStream(true) 或 muteLocalVideoStream(true)。

请确保你想要 unpublish 音视频流的频道 channel，与当前正在 publish 音视频流的频道 channel 一致，否则 SDK 会返回 ERR_REFUSED (5)。

Returns number
- 0：方法调用成功
- < 0：方法调用失败
  - ERR_REFUSED (5): 调用被拒绝

updateChannelMediaRelay

updateChannelMediaRelay(config: ChannelMediaRelayConfiguration): number

更新媒体流转发的频道。

成功开始跨频道转发媒体流后，如果你希望将流转发到多个目标频道，或退出当前的转发频道，可以调用该方法。

成功调用该方法后，SDK 会触发 channelMediaRelayState 回调，向你报告 ChannelMediaRelayEvent 中的事件码 7。

note

请在 startChannelMediaRelay 方法后调用该方法，更新媒体流转发的频道。

Parameters
- config: ChannelMediaRelayConfiguration
  
  跨频道媒体流转发参数配置
Returns number
- 0：方法调用成功
- < 0：方法调用失败

Electron SDK API Reference

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rtcChannel: NodeRtcChannel

Returns AgoraRtcChannel

Properties

rtcChannel

Methods

addPublishStreamUrl

Parameters

url: string

transcodingEnabled: boolean

Returns number

adjustUserPlaybackSignalVolume

Parameters

uid: number

volume: number

Returns number

channelId

Returns string

createDataStream

Parameters

reliable: boolean

ordered: boolean

Returns number

createDataStreamWithConfig

Parameters

config: DataStreamConfig

Returns number

enableEncryption

Parameters

enabled: boolean

config: EncryptionConfig

Returns number

getCallId

Returns string

getConnectionState

Returns CONNECTION_STATE_TYPE

initEventHandler

Returns void

joinChannel

Parameters

token: string

info: string

uid: number

options: ChannelMediaOptions

Returns number

joinChannelWithUserAccount

Parameters

token: string

userAccount: string

options: ChannelMediaOptions

Returns number

leaveChannel

Returns number

muteAllRemoteAudioStreams

Parameters

mute: boolean

Returns number

muteAllRemoteVideoStreams

Parameters

mute: boolean

Returns number

muteLocalAudioStream

Parameters

mute: boolean

Returns number

muteLocalVideoStream

Parameters

mute: boolean

Returns number

muteRemoteAudioStream

Parameters

uid: number