Interface IAgoraRTCClient

你可以通过 createClient 创建一个 AgoraRTCClient 对象。一个 AgoraRTCClient 对象代表一个本地客户端。

EventsCopy Anchor Link

channel-media-relay-eventCopy Anchor Link

channel-media-relay-event(event: ChannelMediaRelayEvent): void

跨频道媒体流转发事件回调。

channel-media-relay-stateCopy Anchor Link

channel-media-relay-state(state: ChannelMediaRelayState, code: ChannelMediaRelayError): void

跨频道媒体流转发状态回调。

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

回调会携带当前跨频道媒体流转发服务的状态 ChannelMediaRelayState，如果状态异常，相应的错误码可以通过 ChannelMediaRelayError 获取（比如 token 过期，重连失败等）。

connection-state-changeCopy Anchor Link

connection-state-change(curState: ConnectionState, revState: ConnectionState, reason?: ConnectionDisconnectedReason): void

SDK 与服务器的连接状态发生改变回调。

content-inspect-connection-state-changeCopy Anchor Link

content-inspect-connection-state-change(preState: InspectState, newState: InspectState): void

视频截图上传服务的连接状态发生改变回调。

client.on("content-inspect-connection-state-change", (preState, state) => {
  console.error(`Content Inspect Connection State Change: ${preState} -> ${state}` )
})

content-inspect-errorCopy Anchor Link

content-inspect-error(error?: AgoraRTCError): void

开启视频截图上传服务出错回调。

client.on("content-inspect-error", error => {
   console.error("Content Inspect Error:", error)
   error.code === "OPERATION_ABORTED" && client.disableContentInspect()
})

crypt-errorCopy Anchor Link

crypt-error(): void

解密失败回调。

该回调表示用户在订阅过程中出现了解密失败，通常是由于和发布端设置的加密参数不一致导致的。详见 setEncryptionConfig。

exceptionCopy Anchor Link

exception(event: object): void

SDK 监测到异常事件回调。

该回调报告频道内 SDK 监测出的异常事件。

异常事件不是错误，但是一般会引起通话质量问题。发生异常事件后，如果恢复正常，也会收到该回调。

每个异常事件都有对应的恢复事件。

异常事件见下表：

恢复事件详见下表：

image-moderation-connection-state-changeCopy Anchor Link

image-moderation-connection-state-change(newState: ImageModerationConnectionState, preState: ImageModerationConnectionState): void

第三方视频审核服务连接状态发生改变回调。

client.on("image-moderation-connection-state-change", (curState, preState) => {
   // image-moderation-connection-state-change: CONNECTING to CONNECTED
   console.info(`image-moderation-connection-state-change: ${preState} to ${curState}`);
});

is-using-cloud-proxyCopy Anchor Link

is-using-cloud-proxy(isUsingProxy: boolean): void

SDK 通过这个回调通知当前媒体流是否经云代理服务转发。触发时机如下：

• v4.10.0 之前：成功调用 publish 后。
• v4.10.0 及之后：成功调用 join 后。

join-fallback-to-proxyCopy Anchor Link

join-fallback-to-proxy(proxyServer: string): void

deprecatedCopy Anchor Link

自 4.19.0 起废弃。SDK 不再使用代理保障连通性，因此不会再触发该回调。

SDK 自动切换至 TCP/TLS 443 回调。

自 v4.11.0 起，如果调用 join 后 SDK 直接连接 SD-RTN™ 失败，SDK 会自动切换到 TCP/TLS 443 通道，从而保障 SDK 的连通性。

live-streaming-errorCopy Anchor Link

live-streaming-error(url: string, err: AgoraRTCError): void

推流发生错误回调。

在调用 startLiveStreaming 成功开始推流后，推流中途发生错误时，会通过这个事件抛出。

你可以访问 err.code 来获取错误码字符串，下面列出可能出现的错误：

• LIVE_STREAMING_INVALID_ARGUMENT: 推流参数错误。
• LIVE_STREAMING_INTERNAL_SERVER_ERROR: 推流服务器内部错误。
• LIVE_STREAMING_PUBLISH_STREAM_NOT_AUTHORIZED: 推流 URL 被占用。
• LIVE_STREAMING_TRANSCODING_NOT_SUPPORTED: 在非转码推流中调用了转码参数。
• LIVE_STREAMING_CDN_ERROR: 推流的目标 CDN 出现错误导致推流失败。
• LIVE_STREAMING_INVALID_RAW_STREAM: 推流超时，请确认目标流是否存在。

live-streaming-warningCopy Anchor Link

live-streaming-warning(url: string, warning: AgoraRTCError): void

推流发生警告回调。

在调用 startLiveStreaming 成功开始推流后，推流中途发生警告时，会通过这个事件抛出。

你可以访问 err.code 来获取警告码字符串，下面列举可能出现的警告：

• LIVE_STREAMING_WARN_STREAM_NUM_REACH_LIMIT: 推流超过 10 路流。
• LIVE_STREAMING_WARN_FAILED_LOAD_IMAGE: 推流中的背景图片或者水印地址无法拉取。
• LIVE_STREAMING_WARN_FREQUENT_REQUEST: 推流请求太频繁。

media-reconnect-endCopy Anchor Link

media-reconnect-end(uid: UID): void

SDK 重新建立媒体连接（用于发布和订阅）结束的回调。

media-reconnect-startCopy Anchor Link

media-reconnect-start(uid: UID): void

SDK 开始尝试重新建立媒体连接（用于发布和订阅）的回调。

network-qualityCopy Anchor Link

network-quality(stats: NetworkQuality): void

网络上下行质量报告回调。

用户加入频道后，SDK 会每 2 秒触发一次该回调，报告本地用户当前的上行和下行网络质量。

我们推荐使用此回调来展示你的网络状态。

peerconnection-state-changeCopy Anchor Link

peerconnection-state-change(curState: RTCPeerConnectionState, revState: RTCPeerConnectionState): void

本地媒体连接 PeerConnection 的状态回调。

published-user-listCopy Anchor Link

published-user-list(users: IAgoraRTCRemoteUser[]): void

如果开启了单频道支持 128 位主播的功能，该回调会在调用 join 时触发，返回当前频道内发布音频和视频轨道的用户。

stream-fallbackCopy Anchor Link

stream-fallback(uid: UID, isFallbackOrRecover: "fallback" | "recover"): void

订阅的音视频流回退为音频流或恢复为音视频流回调。

如果在 setStreamFallbackOption 中将 fallbackType 设为 2，当下行网络环境不理想、仅接收远端音频流时，或当下行网络改善、恢复订阅音视频流时，会触发该回调。

stream-messageCopy Anchor Link

stream-message(uid: UID, payload: Uint8Array): void

收到数据流消息的回调。

client.on("stream-message", (uid, payload) => {
   console.info(`received data stream message from ${uid}: `, payload);
});

stream-type-changedCopy Anchor Link

stream-type-changed(uid: UID, streamType: RemoteStreamType): void

订阅的视频流类型发生改变回调。

视频流类型改变指视频大流（高码率、高分辨率）变为视频小流（低码率、低分辨率），或视频小流变为视频大流。

token-privilege-did-expireCopy Anchor Link

token-privilege-did-expire(): void

Token 已过期回调。

在 token 过期后，会收到该回调。

一般情况下，在收到该消息之后，应向服务端重新申请 token，并调用 join 方法传入新的 token 重新加入频道。

client.on("token-privilege-did-expire", async () => {
  // 重新申请 token 后
  await client.join(<APPID>, <CHANNEL NAME>, <NEW TOKEN>);
});

token-privilege-will-expireCopy Anchor Link

token-privilege-will-expire(): void

Token 即将过期回调。

在 token 过期前 30 秒，会收到该回调。

在收到该回调之后，应向服务端重新申请 token，并调用 renewToken 方法传入新的 token。

client.on("token-privilege-will-expire", async function(){
  // 重新申请 token 后
  await client.renewToken(token);
});

user-info-updatedCopy Anchor Link

user-info-updated(uid: UID, msg: "mute-audio" | "mute-video" | "enable-local-video" | "unmute-audio" | "unmute-video" | "disable-local-video"): void

该回调用于提示用户状态变化。

在大部分情况下，你只需要监听 user-published 和 user-unpublished 就可以完成订阅、取消订阅、展示远端用户是否打开了摄像头和麦克风等工作，无需特别关注实际用户状态的变化，SDK 会自动处理用户状态变化。

即使用户状态表示该用户的音视频流是活跃的，不一定意味着该用户可订阅。是否可订阅的唯一标志是收到 user-published 事件。

user-joinedCopy Anchor Link

user-joined(user: IAgoraRTCRemoteUser): void

远端用户或主播加入频道回调。

• 通信场景下，该回调提示有远端用户加入了频道，并返回新加入用户的 ID；如果加入之前，已经有其他用户在频道中了，新加入的用户也会收到这些已有用户加入频道的回调。
• 直播场景下，该回调提示有主播加入了频道，并返回该主播的 ID。如果在加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入频道的回调。声网建议连麦主播不超过 32 人。

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

• 通信场景的远端用户/直播场景的远端主播调用 join 方法加入频道。
• 直播场景的远端观众加入频道后调用 setClientRole 将用户角色改变为主播。
• 通信场景的远端用户/直播场景的远端主播网络中断后重新加入频道。

user-leftCopy Anchor Link

user-left(user: IAgoraRTCRemoteUser, reason: string): void

远端用户离线回调。

该回调通知 app 有远端用户离线，离线包括以下情况：

• 正常离开：用户会收到类似“再见”的消息，接收此消息后，判断对方离开频道。
• 超时掉线：在 20 秒内，用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。
• 用户角色从主播变为观众。

在直播场景中，只有角色为主播的用户会触发该回调。

user-publishedCopy Anchor Link

user-published(user: IAgoraRTCRemoteUser, mediaType: "audio" | "video" | "datachannel", config?: IDataChannelConfig): void

该回调通知远端用户发布了新的音频轨道或者视频轨道。

你可以在该回调中订阅并播放远端用户的音视频轨道。详见 subscribe 和 RemoteTrack.play。

如果用户加入频道时频道内已经有其他用户的音视频轨道，也会收到该回调报告已经存在的远端轨道。

client.on("user-published", async (user, mediaType) => {
  await client.subscribe(user, mediaType);
  if (mediaType === "video") {
    console.log("subscribe video success");
    user.videoTrack.play("xxx");
  }
  if (mediaType === "audio") {
    console.log("subscribe audio success");
    user.audioTrack.play();
  }
})

user-unpublishedCopy Anchor Link

user-unpublished(user: IAgoraRTCRemoteUser, mediaType: "audio" | "video" | "datachannel", config?: IDataChannelConfig): void

该回调通知远端用户取消发布了音频或视频轨道。

volume-indicatorCopy Anchor Link

volume-indicator(result: object[]): void

报告频道内正在说话的本地和远端用户及其音量的回调。

默认禁用。可以通过 enableAudioVolumeIndicator 方法开启；开启后，无论频道内是否有人说话，都会每两秒返回提示音量。

音量范围为 0 到 100 之间。通常在列表中音量大于 60 的用户为持续说话的人。

client.on("volume-indicator", function(result){
    result.forEach(function(volume, index){
    console.log(`${index} UID ${volume.uid} Level ${volume.level}`);
  });
});

PropertiesCopy Anchor Link

channelNameCopy Anchor Link

channelName: string

当前加入的频道名称

如果本地用户没有加入频道，该属性值为 undefined。

connectionStateCopy Anchor Link

connectionState: ConnectionState

SDK 和声网服务器的连接状态。

localTracksCopy Anchor Link

localTracks: ILocalTrack[]

保存当前正在发布的本地轨道对象列表。

• 调用 publish 成功后，发布的轨道对象会自动添加到这个列表中。
• 调用 unpublish 成功后，取消发布的轨道对象会自动从这个列表中移除。

remoteUsersCopy Anchor Link

remoteUsers: IAgoraRTCRemoteUser[]

远端用户信息列表，包含频道中各个远端用户的用户 ID 和轨道信息。

如果本地用户没有加入频道，该列表为空。

uidCopy Anchor Link

uid: UID

本地用户的用户 ID。

如果本地用户没有加入频道，该属性值为 undefined。

Agora Core MethodsCopy Anchor Link

joinCopy Anchor Link

join(appid: string, channel: string, token: string | null, uid?: UID | null, options?: object): Promise<UID>

加入频道。

该方法让用户加入通话频道，在同一个频道内的用户可以互相通话。

调用该方法加入频道时，本地会触发 AgoraRTCClient.on("connection-state-change") 回调。

通信场景下的用户和直播场景下的主播加入频道后，远端会触发 AgoraRTCClient.on("user-joined") 回调。

leaveCopy Anchor Link

leave(): Promise<void>

离开频道。

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

调用该方法离开频道时，本地会触发 AgoraRTCClient.on("connection-state-change") 回调。

通信场景下的用户和直播场景下的主播离开频道后，远端会触发 AgoraRTCClient.on("user-left") 回调。

publishCopy Anchor Link

publish(tracks: ILocalTrack | ILocalTrack[]): Promise<void>

发布本地音视频轨道。

该方法将本地音视频轨道发布至频道中。

发布音视频轨道之后，远端会触发 AgoraRTCClient.on("user-published") 回调。

subscribeCopy Anchor Link

subscribe [1/3]Copy Anchor Link

subscribe(user: IAgoraRTCRemoteUser | UID, mediaType: "video"): Promise<IRemoteVideoTrack>

订阅远端用户的音视频轨道。

await client.subscribe(user，"audio");
user.audioTrack.play();

subscribe [2/3]Copy Anchor Link

subscribe(user: IAgoraRTCRemoteUser | UID, mediaType: "audio"): Promise<IRemoteAudioTrack>

订阅远端用户的音视频轨道。

await client.subscribe(user，"audio");
user.audioTrack.play();

categoryCopy Anchor Link

Agora Core

subscribe [3/3]Copy Anchor Link

subscribe(user: IAgoraRTCRemoteUser | UID, mediaType: "video" | "audio" | "datachannel", channelId?: number): Promise<IRemoteTrack | IRemoteDataChannel>

订阅远端用户的音视频轨道。

await client.subscribe(user，"audio");
user.audioTrack.play();

categoryCopy Anchor Link

Agora Core

unpublishCopy Anchor Link

unpublish(tracks?: ILocalTrack | ILocalTrack[]): Promise<void>

取消发布本地音视频轨道。

取消发布音视频轨道之后，远端会触发 AgoraRTCClient.on("user-unpublished") 回调。

unsubscribeCopy Anchor Link

unsubscribe(user: IAgoraRTCRemoteUser | UID, mediaType?: "video" | "audio" | "datachannel", channelId?: number): Promise<void>

取消订阅远端用户的音视频轨道。

Channel Media Relay MethodsCopy Anchor Link

startChannelMediaRelayCopy Anchor Link

startChannelMediaRelay(config: IChannelMediaRelayConfiguration): Promise<void>

开始跨频道媒体流转发。

调用该方法后，SDK 会触发以下回调：

• AgoraRTCClient.on("channel-media-relay-state")，报告当前的跨频道媒体流转发状态和错误码。

  • 如果转发中途出现异常，该回调中 state 为 3，code 为错误码。你可以尝试再次调用本方法。

• AgoraRTCClient.on("channel-media-relay-event")，报告跨频道媒体流转发相关的事件。

  • 如果跨频道服务开始向目标频道发送数据包，会触发回调，code 为 4.

client.startChannelMediaRelay(config).then(() => {
  console.log("startChannelMediaRelay success");
}).catch(e => {
  console.log("startChannelMediaRelay failed", e);
})

stopChannelMediaRelayCopy Anchor Link

stopChannelMediaRelay(): Promise<void>

停止跨频道媒体流转发。

一旦停止转发，用户会退出所有的目标频道。

updateChannelMediaRelayCopy Anchor Link

updateChannelMediaRelay(config: IChannelMediaRelayConfiguration): Promise<void>

更新媒体流转发的目标频道。

成功开始跨频道转发媒体流后，如果你希望添加或删除媒体流转发的目标频道，可以调用该方法。

Dual Stream MethodsCopy Anchor Link

disableDualStreamCopy Anchor Link

disableDualStream(): Promise<void>

关闭双流模式。

enableDualStreamCopy Anchor Link

enableDualStream(): Promise<void>

开启双流模式。

该方法为本地流开启双流模式。双流为视频大流和视频小流：

• 视频大流指高分辨率、高码率的视频流。
• 视频小流指低分辨率、低码率的视频流。小流的视频属性默认值固定为分辨率（宽 × 高） 160 × 120，码率 50 Kbps，帧率 15 fps。如果你不想要使用默认的小流视频属性，可以调用 setLowStreamParameter 自定义小流参数，防止因小流码率过高而造成带宽压力。

client.enableDualStream().then(() => {
  console.log("Enable Dual stream success!");
}).catch(err => {
  console.log(err);
})

setLowStreamParameterCopy Anchor Link

setLowStreamParameter(streamParameter: LowStreamParameter): void

设置小流视频属性。

如果你调用 enableDualStream 开启了双流模式，该方法设置小流的视频属性。

如果你不设置小流的视频属性，SDK 会根据你的视频流属性自动适配小流的视频属性。

setRemoteDefaultVideoStreamTypeCopy Anchor Link

setRemoteDefaultVideoStreamType(streamType: RemoteStreamType): Promise<void>

设置订阅所有远端用户的视频类型。

如果远端用户开启了双流模式，本地用户调用 subscribe 后会直接订阅本方法中 streamType 参数所指定的流类型。如不设置，默认订阅大流。

• 建议在加入频道前调用 setRemoteDefaultVideoStreamType。
• 如果你调用了 setRemoteVideoStreamType 指定某个用户的流类型，则以该调用为准。

setRemoteVideoStreamTypeCopy Anchor Link

setRemoteVideoStreamType(uid: UID, streamType: RemoteStreamType): Promise<void>

设置订阅特定远端用户的视频类型。

如果远端用户开启了双流模式，该用户会发送两路视频流（一路大流和一路小流）。你可以通过 setRemoteVideoStreamType 在接收端选择订阅该用户的大流还是小流。如不设置，默认订阅大流。

• 该方法只可在发送端通过 enableDualStream 开启双流模式的情况下使用。

• 若该方法和 setStreamFallbackOption 同时被调用，用户实际订阅的视频流取决于不同的设置。主要包括以下两种情况：

  • setStreamFallbackOption 的参数设置为 0 (DISABLE)时，订阅的视频流类型将由 setRemoteVideoStreamType 的设置决定。
  • setStreamFallbackOption 的参数设置为 1 (VIDEO_STREAM_LOW) 或 2 (VIDEO_STREAM_HIGH)，则订阅的视频流类型会先按照 setRemoteVideoStreamType设置，但会根据网络状况进行动态调整。 例如，将 setRemoteVideoStreamType 参数设置为 0（订阅大流），但网络状况较差，SDK 将按照 setStreamFallbackOption 的设置进行弱网回退操作。

setStreamFallbackOptionCopy Anchor Link

setStreamFallbackOption(uid: UID, fallbackType: RemoteStreamFallbackType): Promise<void>

设置媒体流回退策略。

该方法用于设置接收远端音视频流的回退策略。在弱网环境下，SDK 支持订阅视频小流（低分辨率、低码率视频流）或者仅订阅音频流。

当订阅流从视频大流回退为视频小流或从视频小流恢复为视频大流时，本地会触发 AgoraRTCClient.on("stream-type-changed") 回调。当订阅流回退为音频流或从音频流恢复为音视频流时，本地会触发 AgoraRTCClient.on("stream-fallback") 回调。

• 该方法仅在远端用户调用 enableDualStream 开启双流模式后生效。
• 远端用户开启双流模式后，如果本地没有调用过 setStreamFallbackOption，默认的回退策略将生效，即在弱网环境下 SDK 会自动订阅远端用户的视频小流（RemoteStreamFallbackType 为 1）。

Live Streaming MethodsCopy Anchor Link

setLiveTranscodingCopy Anchor Link

setLiveTranscoding(config: LiveStreamingTranscodingConfig): Promise<void>

设置直播推流转码的配置。

该方法用于旁路推流的视图布局及音频设置等。

使用前请确保已开通旁路推流。

startLiveStreamingCopy Anchor Link

startLiveStreaming(url: string, transcodingEnabled?: boolean): Promise<void>

将本地流发布到 CDN。

详见推流到 CDN。

await client.setLiveTranscoding(config);
await client.startLiveStreaming("rtmp://xxxx", true);

stopLiveStreamingCopy Anchor Link

stopLiveStreaming(url: string): Promise<void>

删除旁路推流地址。

该方法每次只能删除一路旁路推流地址。若需删除多路流，则需多次调用该方法。

Other MethodsCopy Anchor Link

_isPreRenderCopy Anchor Link

_isPreRender(): boolean

_setRteInfoCopy Anchor Link

_setRteInfo(rteUrl: string, rteSid: string): void

disableContentInspectCopy Anchor Link

disableContentInspect(): Promise<void>

关闭视频截图上传。

enableAudioVolumeIndicatorCopy Anchor Link

enableAudioVolumeIndicator(): void

启用说话者音量提示。

该方法允许 SDK 定期报告正在说话的本地和远端用户及其音量。

启用音量提示后，无论频道中有没有人说话，SDK 都会每两秒触发 AgoraRTCClient.on("volume-indicator") 回调。

如果本地用户离开频道后再加入频道，你需要重新调用 enableAudioVolumeIndicator。

client.enableAudioVolumeIndicator();
client.on("volume-indicator", volumes => {
  volumes.forEach((volume, index) => {
    console.log(`${index} UID ${volume.uid} Level ${volume.level}`);
  });
})

enableContentInspectCopy Anchor Link

enableContentInspect(inspectConfig: InspectConfiguration): Promise<void>

开启视频截图上传。

开启视频截图上传后，SDK 会根据你在 InspectConfiguration 中设置的类型和频率，对本地用户发送的视频进行截图并上传。 截图完成后，声网服务器会以 HTTPS 请求的形式，向你的服务器发送回调通知，并将所有截图发送至你指定的第三方云存储。具体步骤详见视频截图上传。

SDK 目前支持的最高截图频率为 1000 毫秒/次。

client.enableContentInspect({
  // 设置每 5000ms 对本地视频轨道截一次图
  interval:5000,
  // 设置第三方云存储地址的前缀
  ossFilePrefix:`${channelName}/${uid}`,
  // 设置附加信息，附加信息随截图一起发送给你的服务器
  extraInfo:"fromAgora",
})

getListenersCopy Anchor Link

getListeners(event: string): Function[]

Inherited from EventEmitter.getListeners

指定一个事件名，获取当前所有监听这个事件的回调函数。

getLocalAudioStatsCopy Anchor Link

getLocalAudioStats(): LocalAudioTrackStats

获取本地音频相关信息。

getLocalVideoStatsCopy Anchor Link

getLocalVideoStats(): LocalVideoTrackStats

获取本地视频相关信息。

getNetworkQualityCopy Anchor Link

getNetworkQuality(): NetworkQuality

getNtpWallTimeInMsCopy Anchor Link

getNtpWallTimeInMs(): number

在实时合唱的场景中，特别是在各个接收端由于网络原因导致下行链路不一致的情况下， 可以调用该方法来获取当前的 NTP 时间作为基准时间，以对齐多个接收端的歌词和音乐。

getRTCStatsCopy Anchor Link

getRTCStats(): AgoraRTCStats

获取当前通话的统计信息。

getRemoteAudioStatsCopy Anchor Link

getRemoteAudioStats(): object

获取远端用户的音频相关信息。

getRemoteNetworkQualityCopy Anchor Link

getRemoteNetworkQuality(): object

获取本地订阅的所有远端用户的上下行网络质量。

getRemoteVideoStatsCopy Anchor Link

getRemoteVideoStats(): object

获取远端用户的视频统计信息。

massSubscribeCopy Anchor Link

massSubscribe(subscribeList: object[]): Promise<object[]>

批量订阅远端用户的音视频轨道。

const result = await client.massSubscribe([{user:userA, mediaType:'audio'}, {user: userB, mediaType:'audio'}]);

for(const {track, mediaType, error} of result) {
  if(error) {
    console.error(error);
    continue;
  }

  if(track) {
    if(mediaType === 'audio') {
      track.play();
    }else{
      track.play(document.querySelector('.video-container'));
    }
  }
}

massUnsubscribeCopy Anchor Link

massUnsubscribe(unsubscribeList: object[]): Promise<void>

批量取消订阅远端用户的音视频轨道。

client.massUnsubscribe([{user:userA}, {user: userB}]);

offCopy Anchor Link

off(event: string, listener: Function): void

Inherited from EventEmitter.off

取消一个指定事件的监听。

onCopy Anchor Link

on [1/29]Copy Anchor Link

on(event: "peerconnection-state-change", listener: typeof event_peerconnection_state_change): void

Overrides EventEmitter.on

本地媒体连接 PeerConnection 的状态回调。

on [2/29]Copy Anchor Link

on(event: "connection-state-change", listener: typeof event_connection_state_change): void

Overrides EventEmitter.on

SDK 与服务器的连接状态发生改变回调。

on [3/29]Copy Anchor Link

on(event: "user-joined", listener: typeof event_user_joined): void

Overrides EventEmitter.on

远端用户或主播加入频道回调。

on [4/29]Copy Anchor Link

on(event: "user-left", listener: typeof event_user_left): void

Overrides EventEmitter.on

远端用户离线回调。

on [5/29]Copy Anchor Link

on(event: "user-published", listener: typeof event_user_published): void

Overrides EventEmitter.on

远端用户发布了新的音频轨道或视频轨道回调。

on [6/29]Copy Anchor Link

on(event: "user-unpublished", listener: typeof event_user_unpublished): void

Overrides EventEmitter.on

远端用户停止或取消发布了音频或视频轨道。

on [7/29]Copy Anchor Link

on(event: "user-info-updated", listener: typeof event_user_info_updated): void

Overrides EventEmitter.on

用户状态发生变化回调。

on [8/29]Copy Anchor Link

on(event: "media-reconnect-start", listener: typeof event_media_reconnect_start): void

Overrides EventEmitter.on

SDK 开始尝试重新建立媒体连接（用于发布和订阅）的回调。

on [9/29]Copy Anchor Link

on(event: "media-reconnect-end", listener: typeof event_media_reconnect_end): void

Overrides EventEmitter.on

SDk 重新建立媒体连接（用于发布和订阅）结束的回调。

on [10/29]Copy Anchor Link

on(event: "stream-type-changed", listener: typeof event_stream_type_changed): void

Overrides EventEmitter.on

视频的订阅流类型发生改变回调。

on [11/29]Copy Anchor Link

on(event: "stream-fallback", listener: typeof event_stream_fallback): void

Overrides EventEmitter.on

订阅的音视频流回退为音频流或恢复为音视频流回调。

on [12/29]Copy Anchor Link

on(event: "channel-media-relay-state", listener: typeof event_channel_media_relay_state): void

Overrides EventEmitter.on

跨频道媒体流转发状态发生改变回调。

on [13/29]Copy Anchor Link

on(event: "channel-media-relay-event", listener: typeof event_channel_media_relay_event): void

Overrides EventEmitter.on

跨频道媒体流转发事件回调。

on [14/29]Copy Anchor Link

on(event: "volume-indicator", listener: typeof event_volume_indicator): void

Overrides EventEmitter.on

报告频道内正在说话的本地和远端用户及其音量的回调。

on [15/29]Copy Anchor Link

on(event: "crypt-error", listener: typeof event_crypt_error): void

Overrides EventEmitter.on

解密失败回调。

on [16/29]Copy Anchor Link

on(event: "token-privilege-will-expire", listener: typeof event_token_privilege_will_expire): void

Overrides EventEmitter.on

Token 即将过期回调。

on [17/29]Copy Anchor Link

on(event: "token-privilege-did-expire", listener: typeof event_token_privilege_did_expire): void

Overrides EventEmitter.on

Token 已过期回调。

on [18/29]Copy Anchor Link

on(event: "network-quality", listener: typeof event_network_quality): void

Overrides EventEmitter.on

网络上下行质量报告回调。

on [19/29]Copy Anchor Link

on(event: "live-streaming-error", listener: typeof event_live_streaming_error): void

Overrides EventEmitter.on

推流发生错误回调。

on [20/29]Copy Anchor Link

on(event: "live-streaming-warning", listener: typeof event_live_streaming_warning): void

Overrides EventEmitter.on

推流发生警告回调。

on [21/29]Copy Anchor Link

on(event: "exception", listener: typeof event_exception): void

Overrides EventEmitter.on

SDk 检测到异常事件回调。

on [22/29]Copy Anchor Link

on(event: "is-using-cloud-proxy", listener: typeof event_is_using_cloud_proxy): void

Overrides EventEmitter.on

通知当前媒体流是否经云代理服务转发回调。

on [23/29]Copy Anchor Link

on(event: "join-fallback-to-proxy", listener: typeof event_join_fallback_to_proxy): void

Overrides EventEmitter.on

deprecatedCopy Anchor Link

自 4.19.0 起废弃。 SDK 自动切换连接通道回调。

on [24/29]Copy Anchor Link

on(event: "published-user-list", listener: typeof event_published_user_list): void

Overrides EventEmitter.on

128 人场景下，报告当前频道内发布音频和视频轨道的用户。

on [25/29]Copy Anchor Link

on(event: "content-inspect-connection-state-change", listener: typeof event_content_inspect_connection_state_change): void

Overrides EventEmitter.on

视频截图上传服务的连接状态发生改变回调。

on [26/29]Copy Anchor Link

on(event: "content-inspect-error", listener: typeof event_content_inspect_error): void

Overrides EventEmitter.on

开启视频上传服务出错回调。

on [27/29]Copy Anchor Link

on(event: "image-moderation-connection-state-change", listener: typeof event_image_moderation_connection_state_change): void

Overrides EventEmitter.on

第三方视频审核服务连接状态发生改变回调。

on [28/29]Copy Anchor Link

on(event: "stream-message", listener: typeof event_stream_message): void

Overrides EventEmitter.on

收到数据流消息回调。

on [29/29]Copy Anchor Link

on(event: string, listener: Function): void

Overrides EventEmitter.on

当指定的事件触发时，会调用传入的回调函数。