文档中心
互动直播
Agora.io 社区
中文
search-icon

Agora Electron SDK API Reference

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

AgoraRtcEngine

Hierarchy

  • EventEmitter
    • AgoraRtcEngine

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

customRenderer

customRenderer: any

pauseRender

pauseRender: boolean

renderMode

renderMode: 1 | 2 | 3 | 4

rtcEngine

rtcEngine: NodeRtcEngine

streams

streams: Map<string, Map<string, IRenderer[]>>

Methods

_checkWebGL2

  • _checkWebGL2(): boolean

  • Returns boolean

_getChannelRenderers

  • _getChannelRenderers(channelId: string): Map<string, IRenderer[]>

  • Parameters

    • channelId: string

    Returns Map<string, IRenderer[]>

addInjectStreamUrl

  • 输入在线媒体流。

    该方法适用于 Native SDK v2.4.1 及之后的版本。

    该方法通过在服务端拉取一路视频流并发送到频道中，将正在播出的视频输入到正在进行的直播中。 可主要应用于赛事直播、多人看视频互动等直播场景。

    调用该方法后，SDK 会在本地触发 streamInjectStatus 回调，报告导入在线媒体流的状态。 成功导入媒体流后，该音视频流会出现在频道中，频道内所有用户都会收到 userJoined 回调，其中 uid 为 666。

    warning

    客户端输入在线媒体流功能即将停服。如果你尚未集成该功能，Agora 建议你不要使用。详见《部分服务下架计划》。

    note
    • 该方法只适用于直播场景下的主播。
    • 调用该方法前，请确保已开通旁路推流的功能，详见《推流到 CDN》文档中的 “前提条件”。
    • 请确保在成功加入频道后再调用该接口。
    • 该方法每次只能增加一路媒体流地址。若需输多路流，则需多次调用该方法。

    Parameters

    • url: string

      添加到直播中的媒体流 URL 地址，支持 RTMP， HLS， HTTP-FLV 协议。

      • 支持的 FLV 音频编码格式：AAC
      • 支持的 FLV 视频编码格式：H264 (AVC)
    • config: InjectStreamConfig

      外部导入的媒体流的配置。

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败
      • 2: 输入的 URL 为空。请重新调用该方法，并确认输入的媒体流的 URL 是有效的。
      • 7: 引擎没有初始化。请确认调用该方法前已创建 AgoraRtcEngine 对象并完成初始化。
      • 4: 频道非直播场景。请调用 setChannelProfile 并将频道设置为直播场景再调用该方法。
      • 3: 用户没有加入频道。

addPublishStreamUrl

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

  • 增加旁路推流地址。

    调用该方法后，SDK 会在本地触发 streamPublished 回调，报告增加旁路推流地址的状态。

    note
    • 该方法仅适用于直播场景下的主播，请在加入频道后调用该方法。
    • 确保已开通旁路推流的功能，详见《推流到 CDN》的 “前提条件”。
    • 该方法每次只能增加一路旁路推流地址。若需推送多路流，则需多次调用该方法。

    Parameters

    • url: string

      CDN 推流地址，格式为 RTMP。该字符长度不能超过 1024 字节，且不支持中文等特殊字符。

    • transcodingEnabled: boolean

      设置是否转码：

      • true: 转码。转码是指在旁路推流时对音视频流进行转码处理后， 再推送到其他 RTMP 服务器。多适用于频道内有多个主播，需要进行混流、合图的场景。如果设为 true，需先调用 setLiveTranscoding 方法。
      • false: 不转码。

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败
      • ERR_INVALID_ARGUMENT (2): RTMP 流地址为空或者字符长度为 0。
      • ERR_NOT_INITIALIZED (7): 使用该功能之前没有初始化 AgoraRtcChannel。

addVideoRenderToHighFPS

  • addVideoRenderToHighFPS(uid: number): void

  • 将指定用户的视频流添加为高帧率流。添加为高帧率流后，你可以调用 setVideoRenderHighFPS 方法对视频流进行控制。

    Parameters

    • uid: number

      用户 ID

    Returns void

addVideoWatermark

  • since

    v3.0.0

    添加本地视频水印。

    该方法将一张 PNG 图片作为水印添加到本地发布的直播视频流上，同一直播频道中的观众、 旁路直播观众和录制设备都能看到或采集到该水印图片。Agora 当前只支持在直播视频流中添加一 个水印，后添加的水印会替换掉之前添加的水印。

    水印坐标和 setVideoEncoderConfiguration 中的设置有依赖关系：

    • 如果视频编码方向固定为横屏或自适应模式下的横屏，那么水印使用横屏坐标。
    • 如果视频编码方向固定为竖屏或自适应模式下的竖屏，那么水印使用竖屏坐标。
    • 设置水印坐标时，水印的图像区域不能超出 setVideoEncoderConfiguration 方法中设置 的视频尺寸，否则超出部分将被裁剪。
    note
    • 你需要在调用 enableVideo 后调用该方法。
    • 如果你只是在旁路直播（推流到CDN）中添加水印，你可以使用本方法或 setLiveTranscoding 设置水印。
    • 待添加水印图片必须是 PNG 格式。本方法支持所有像素格式的 PNG 图片：RGBA、RGB、Palette、Gray 和 Alpha_gray。
    • 如果待添加的 PNG 图片的尺寸与你在本方法中设置的尺寸不一致，SDK 会对 PNG 图片进行缩放或裁剪，以与设置相符。
    • 如果你已经使用 startPreview 开启本地视频预览，那么本方法的 visibleInPreview 可设置水印在预览时是否可见。
    • 如果你已设置本地视频为镜像模式，那么此处的本地水印也为镜像。为避免本地用户看本地视频时的水印也被镜像， Agora 建议你不要对本地视频同时使用镜像和水印功能，请在应用层实现本地水印功能。

    Parameters

    • path: string

      待添加的水印图片的本地路径。本方法支持从本地绝对/相对路径添加水印图片。

    • options: WatermarkOptions

      待添加的水印图片的设置选项，详见 WatermarkOptions

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

adjustAudioMixingPlayoutVolume

  • adjustAudioMixingPlayoutVolume(volume: number): number

  • 调节音乐文件的本地播放音量。

    note

    请在频道内调用该方法。

    Parameters

    • volume: number

      音乐文件的本地播放音量，取值范围为 [0, 100]，默认值为 100，表示原始文件音量

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

adjustAudioMixingPublishVolume

  • adjustAudioMixingPublishVolume(volume: number): number

  • 调节音乐文件的远端播放音量。

    note

    请在频道内调用该方法。

    Parameters

    • volume: number

      音乐文件的远端播放音量，取值范围为 [0, 100]，默认值为 100，表示原始文件音量

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

adjustAudioMixingVolume

  • adjustAudioMixingVolume(volume: number): number

  • 调节音乐文件的播放音量。

    note
    • 请在频道内调用该方法。
    • 调用该方法不影响调用 playEffect 播放音效文件的音量。

    Parameters

    • volume: number

      音乐文件播放音量，取值范围为 [0, 100]，默认值为 100，表示原始文件音量

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

adjustLoopbackRecordingSignalVolume

  • adjustLoopbackRecordingSignalVolume(volume: number): number

  • 调节声卡采集信号音量。

    since

    v3.4.2

    调用 enableLoopbackRecording 开启声卡采集后，你可以调用该方法调节声卡采集的信号音量。

    Parameters

    • volume: number

      声卡采集信号音量。取值范围为 [0,100]。默认值为 100，表示原始音量。

    Returns number

    • 0: 方法调用成功
    • < 0: 方法调用失败

adjustPlaybackSignalVolume

  • adjustPlaybackSignalVolume(volume: number): number

  • 调节本地播放的所有远端用户信号音量。

    note
    • 该方法调节的是本地播放的所有远端用户混音后的音量。
    • 静音本地音频需同时调用 adjustPlaybackSignalVolume 和 adjustAudioMixingPlayoutVolume 方法，并将 volume 设置为 0。
    • 该方法在加入频道前后都能调用。

    Parameters

    • volume: number

      播放音量。取值范围为 [0,100]。默认值为 100，表示原始音量。

    Returns number

    • 0: 方法调用成功
    • < 0: 方法调用失败

adjustRecordingSignalVolume

  • adjustRecordingSignalVolume(volume: number): number

  • 调节麦克风采集信号音量。

    note

    该方法在加入频道前后都能调用。

    Parameters

    • volume: number

      麦克风采集信号音量。取值范围为 [0,100]。默认值为 100，表示原始音量。

    Returns number

    • 0: 方法调用成功
    • < 0: 方法调用失败

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：方法调用失败

clearVideoWatermarks

  • clearVideoWatermarks(): number
  • since

    v3.0.0

    删除已添加的视频水印。

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

complain

  • complain(callId: string, desc: string): number

  • 投诉通话质量。

    Parameters

    • callId: string

      通话 getCallId 方法获取的通话 ID

    • desc: string

      给通话的描述。可选参数，长度应小于 800 字节

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

createChannel

  • 创建并获取一个 AgoraRtcChannel 对象。

    你可以多次调用该方法，创建多个 AgoraRtcChannel 对象，再调用各 AgoraRtcChannel 对象 中的 joinChannel 方法，实现同时加入多个频道。

    加入多个频道后，你可以同时订阅各个频道的音、视频流；但是同一时间只能在一个频道发布一路音、视频流。

    note
    • 该参数没有默认值，请确保对参数设值。
    • 请勿将该参数设为空字符 ""，否则 SDK 会返回 ERR_REFUSED(5)

    Parameters

    • channelName: string

      能标识频道的频道名，长度在 64 字节以内的字符。以下为支持的字符集 范围（共 89 个字符）：

      • 26 个小写英文字母 a~z；
      • 26 个大写英文字母 A~Z；
      • 10 个数字 0~9；
      • 空格；
      • "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、 "@"、"["、"]"、"^"、"_"、" {"、"}"、"|"、"~"、","。

    Returns null | AgoraRtcChannel

    • 方法调用成功，返回 AgoraRtcChannel 对象的指针
    • 方法调用失败，返回一个空指针 NULL
    • 如果将 channelName 设为空字符 ""，SDK 会返回 ERR_REFUSED(5)

createDataStream

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

  • 创建数据流。

    deprecated

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

    该方法用于创建数据流。AgoraRtcEngine 生命周期内，每个用户最多只能创建 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

  • 创建数据流。

    since

    v3.3.1

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

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

    Parameters

    Returns number

    • 返回数据流 ID，创建数据流成功。
    • < 0: 创建数据流失败。

destroyRender

  • destroyRender(key: "local" | "videosource" | number, channelId: string | undefined, onFailure?: undefined | function): void

  • 销毁渲染器对象。

    Parameters

    • key: "local" | "videosource" | number

      存储渲染器 Map 的关键标识，如 uid、videoSource 或 local

    • channelId: string | undefined
    • Optional onFailure: undefined | function

      destroyRenderer 方法的错误回调

    Returns void

destroyRenderView

  • destroyRenderView(key: "local" | "videosource" | number, channelId: string | undefined, view: Element, onFailure?: undefined | function): void

  • Parameters

    • key: "local" | "videosource" | number
    • channelId: string | undefined
    • view: Element
    • Optional onFailure: undefined | function

    Returns void

disableAudio

  • disableAudio(): number

  • 关闭音频模块。

    note

    • 该方法设置的是内部引擎为开启状态，在频道内和频道外均可调用，且在 leaveChannel 后仍然有效。

    • 该方法重置整个引擎，响应速度较慢，因此 Agora 建议使用如下方法来控制音频模块：

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

disableLastmileTest

  • disableLastmileTest(): number

  • 关闭网络测试。

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

disableVideo

  • disableVideo(): number

  • 关闭视频模块。

    该方法可以在加入频道前或者通话中调用：

    • 在加入频道前调用，则自动开启纯音频模式；
    • 在通话中调用，则由视频模式切换为纯音频频模式。

    成功掉调用该方法后，远端会触发 userEnableVideo(fasle) 回调。

    若想再次开启视频模块，请调用 enableVideo 方法。

    note

    • 该方法设置的是内部引擎为开启状态，在频道内和频道外均可调用，且在 leaveChannel 后仍然有效。

    • 该方法重置整个引擎，响应速度较慢，因此 Agora 建议使用如下方法来控制视频模块：

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableAudio

  • enableAudio(): number

  • 启用音频模块（默认为开启状态）。

    note

    • 该方法设置的是内部引擎为开启状态，在频道内和频道外均可调用，且在 leaveChannel 后仍然有效。

    • 该方法重置整个引擎，响应速度较慢，因此 Agora 建议使用如下方法来控制音频模块：

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableAudioVolumeIndication

  • enableAudioVolumeIndication(interval: number, smooth: number, report_vad?: boolean): number

  • 启用说话者音量提示。

    该方法允许 SDK 定期向 App 反馈当前谁在说话以及说话者的音量。启用该方法后，无论频道内是否有人说话， 都会在说话声音音量提示回调 groupAudioVolumeIndication 回调中按设置的间隔时间返回音量提示。

    Parameters

    • interval: number

      指定音量提示的时间间隔：

      • ≤ 0: 不启用音量提示功能
      • > 0: 返回音量提示的间隔，单位为毫秒。建议设置到大于 200 毫秒。最小不得少于 10 毫秒，否则会收不到 groupAudioVolumeIndication 回调。
    • smooth: number

      平滑系数，指定音量提示的灵敏度。取值范围为 [0, 10]。建议值为 3，数字越大，波动越灵敏；数字越小，波动越平滑

    • Default value report_vad: boolean = false
      • true: 开启本地人声检测功能。开启后，groupAudioVolumeIndication 回调的 vad 参数会报告是否在本地检测到人声。
      • false:（默认）关闭本地人声检测功能。除引擎自动进行本地人声检测的场景外，groupAudioVolumeIndication 回调的 vad 参数不会报告是否在本地检测到人声。

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableDeepLearningDenoise

  • enableDeepLearningDenoise(enabled: boolean): number

  • 开启或关闭 AI 降噪模式。

    SDK 默认开启传统降噪模式，以消除大部分平稳噪声。如果你还需要消除非平稳噪声，Agora 推荐你按如下步骤开启 AI 降噪模式：

    1. 将 libs 文件夹中的动态库集成到项目中。
      • macOS: AgoraAIDenoiseExtension.framework
      • Windows: libagora_ai_denoise_extension.dll
    2. 调用 enableDeepLearningDenoise(true)。

    AI 降噪模式需使用高性能的设备，如 MacBook Pro 2015。只有在设备性能良好的情况下， SDK 才会成功开启 AI 降噪模式。

    成功开启 AI 降噪模式后，如果 SDK 检测到当前设备的性能不足，SDK 会自动关闭 AI 降噪模式，并开启传统降噪模式。

    在频道内，如果你调用了 enableDeepLearningDenoise(false) 或 SDK 自动关闭了 AI 降噪模式，当你需要重新开启 AI 降噪模式时， 你需要先调用 leaveChannel，再调用 enableDeepLearningDenoise(true)。

    note
    • 该方法需要动态加载动态库，所以 Agora 推荐在加入频道前调用该方法。
    • 该方法对人声的处理效果最佳，Agora 不推荐调用该方法处理含音乐的音频数据。

    Parameters

    • enabled: boolean

    Returns number

    • 0: 方法调用成功
    • < 0: 方法调用失败
      • -157: 未集成用于 AI 降噪的动态库。

enableDualStreamMode

  • enableDualStreamMode(enable: boolean): number

  • 开/关视频双流模式。

    该方法设置单流（默认）或者双流模式。发送端开启双流模式后，接收端可以选择接收大流还是小流。

    其中，大流指高分辨率、高码率的视频流，小流指低分辨率、低码率的视频流。

    Parameters

    • enable: boolean

      指定双流或者单流模式：

      • true：开启双流
      • false：不开启双流（默认）

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableEncryption

  • 开启或关闭内置加密。

    since

    v3.2.0

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

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

    note

    如果开启了内置加密，则不能使用 RTMP/RTMPS 推流功能。

    Parameters

    • enabled: boolean

      是否开启内置加密：

      • true: 开启
      • false: 关闭
    • config: EncryptionConfig

      配置内置加密模式和密钥。

    Returns number

    • 0: 方法调用成功
    • < 0: 方法调用失败
      • -2: 调用了无效的参数。需重新指定参数。
      • -4: 设置的加密模式不正确或加载外部加密库失败。需检查枚举值是否正确或重新加载外部加密库。
      • -7: SDK 尚未初始化。需在调用 API 之前已创建 AgoraRtcEngine 对象并完成初始化。

enableLastmileTest

  • enableLastmileTest(): number

  • 启用网络测试。

    该方法启用网络连接质量测试，用于检测用户网络接入质量。默认该功能为关闭状态。

    该方法主要用于以下两种场景：

    • 用户加入频道前，可以调用该方法判断和预测目前的上行网络质量是否足够好。
    • 直播场景下，当用户角色想由观众切换为主播时，可以调用该方法判断和预测目前的上行网络质量是否足够好。
    note
    • 该方法请勿与 startLastmileProbeTest 方法同时使用。
    • 调用该方法后，在收到 lastMileQuality 回调之前请不要调用其他方法，否则可能会由于 API 操作过于频繁导致此回调无法执行。
    • 启用该方法会消耗一定的网络流量，影响通话质量。在收到 lastMileQuality 回调后， 需调用 stopEchoTest 方法停止测试，再加入频道或切换用户角色。
    • 直播场景下，主播在加入频道后，请勿调用该方法。
    • 加入频道前调用该方法检测网络质量后，SDK 会占用一路视频的带宽，码率与 setVideoEncoderConfiguration 中设置的码率相同。加入频道后，无论是否调用了 disableLastmileTest，SDK 均会自动停止带宽占用。

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableLocalAudio

  • enableLocalAudio(enable: boolean): number

  • 开/关本地音频采集。

    当 App 加入频道时，它的语音功能默认是开启的。该方法可以关闭或重新开启本地语音功能，即停止或重新开始本地音频采集。

    该方法不影响接收或播放远端音频流，enableLocalAudio(false) 适用于只听不发的用户场景。语音功能关闭或重新开启后，会收到回调 microphoneEnabled。

    note

    该方法与 muteLocalAudioStream 的区别在于：

    • enableLocalAudio: 使用 enableLocalAudio 关闭或开启本地采集后，本地听远端播放会有短暂中断。
    • muteLocalAudioStream: 使用 muteLocalAudioStream 停止或继续发送本地音频流后，本地听远端播放不会有短暂中断。

    Parameters

    • enable: boolean
      • true：开启本地音频采集（默认）
      • false：关闭本地音频采集

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableLocalVideo

  • enableLocalVideo(enable: boolean): number

  • 开/关本地视频采集。

    该方法禁用或重新启用本地视频采集，不影响接收远端视频。

    调用 enableVideo 后，本地视频即默认开启。你可以调用 enableLocalVideo(false) 关闭本地视频采集。关闭后如果想要重新开启，则可调用 enableLocalVideo(true)。

    成功禁用或启用本地视频采集后，远端会触发 userEnableLocalVideo 回调。

    Parameters

    • enable: boolean
      • true：开启本地视频采集和渲染（默认）
      • false：关闭本地视频采集和渲染。关闭后，远端用户会接收不到本地用户的视频流；但本地用户依然可以接收远端用户的视频流

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableLoopbackRecording

  • enableLoopbackRecording(enable?: boolean, deviceName?: string | null): number

  • 开启声卡采集。

    启用声卡采集功能后，声卡播放的声音会被合到本地音频流中，从而可以发送到远端。

    note

    该方法在加入频道前后都能调用。

    Parameters

    • Default value enable: boolean = false

      是否开启声卡采集：

      • true：开启声卡采集
      • false：（默认）关闭声卡采集
    • Default value deviceName: string | null = null

      声卡的设备名。

      • 默认设为 null，即使用当前声卡采集。
      • 如果用户使用虚拟声卡，如 Soundflower，可以将虚拟声卡名称 "soundflower" 作为参数传入，SDK 会找到对应的虚拟声卡设备，并开始采集。Note: macOS 系统默认声卡 不支持采集功能，如需开启此功能需要 App 自己启用一个虚拟声卡，并将该虚拟声卡的名字 作为 deviceName 传入 SDK。 Agora 测试并推荐 soundflower 作为虚拟声卡。

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableSoundPositionIndication

  • enableSoundPositionIndication(enable: boolean): number

  • 开启/关闭远端用户的语音立体声。

    如果想调用 setRemoteVoicePosition 实现听声辨位的功能，请确保在调用 joinChannel 方法前调用该方法。

    Parameters

    • enable: boolean

      是否开启远端用户语音立体声：

      • true：开启
      • false：（默认）关闭

    Returns number

    • 0：方法调用成功
    • -1：方法调用失败

enableVideo

  • enableVideo(): number

  • 启用视频模块。

    该方法可以在加入频道前或者通话中调用。

    • 在加入频道前调用，则自动开启视频模式；
    • 在通话中调用则由音频模式切换为视频模式。

    成功调用该方法后，远端会触发 userEnableVideo(true) 回调。

    若想关闭视频模式，请调用 disableVideo 方法。

    note

    • 该方法设置的是内部引擎为开启状态，在频道内和频道外均可调用，且在 leaveChannel 后仍然有效。

    • 该方法重置整个引擎，响应速度较慢，因此 Agora 建议使用如下方法来控制视频模块：

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

enableVirtualBackground

  • 开启/关闭虚拟背景。（beta 功能）

    since

    3.4.5

    开启虚拟背景功能后，你可以使用自定义的背景图替代本地用户原来的背景图。替换后，频道内所有用户都能看到自定义的背景图。 你可以从 virtualBackgroundSourceEnabled 回调了解虚拟 背景是否成功开启和相应的出错原因。

    note
    • 调用该方法前，请确保你已经将如下动态库集成到项目文件中：
      • macOS: AgoraVideoSegmentationExtension.framework
      • Windows: libagora_segmentation_extension.dll
    • 请在 enableVideo 后调用该方法。
    • 该功能对设备性能要求较高，Agora 推荐你在 CPU 为 i5 及更好的设备上使用。
    • Agora 建议你在满足如下条件的场景中使用该功能：
      • 使用高清摄像设备、摄像环境光照均匀。
      • 摄像画面中，物件较少，用户的人像为半身人像且基本无遮挡，背景色较单一且与用户着装颜色不同。
    note

    为将自定义背景图的分辨率与 SDK 的视频采集分辨率适配，SDK 会在保证自定义背景图内容不变形的前提下，对自定义背景图进行缩放和裁剪。

    Parameters

    Returns number

    • 0: 方法调用成功
    • < 0: 方法调用失败

enableWebSdkInteroperability

  • enableWebSdkInteroperability(enable: boolean): number
  • deprecated

    该方法已废弃。自 Native SDK v3.0.0 及之后，SDK 自动开启与 Web SDK 的互通，无需调用该方法开启。

    打开与 Web SDK 的互通（仅在直播下适用）。

    该方法打开或关闭与 Agora Web SDK 的互通。该方法仅在直播场景下适用，通信场景下默认互通是打开的。

    如果有用户通过 Web SDK 加入频道，请确保调用该方法，否则 Web 端用户看 Native 端的画面会是黑屏。

    Parameters

    • enable: boolean

      是否打开与 Agora Web SDK 的互通：

      • true：打开互通
      • false：关闭互通（默认）

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

getAudioMixingCurrentPosition

  • getAudioMixingCurrentPosition(): number

  • 获取音乐文件的播放进度。

    note
    • 播放进度的单位为毫秒。
    • 请在频道内调用该方法。

    Returns number

    • < 0：方法调用失败
    • 其他值：方法调用成功并返回伴奏播放进度

getAudioMixingDuration

  • getAudioMixingDuration(): number

  • 获取音乐文件总时长。

    deprecated

    自 v3.4.2 废弃，请改用 getAudioMixingFileDuration。

    该方法获取音乐文件总时长，单位为毫秒。请在频道内调用该方法。

    note

    你需要在调用 startAudioMixing 并收到 audioMixingStateChanged(710) 回调后调用该方法。

    Returns number

    • ≥ 0：方法调用成功，返回音乐文件时长。
    • < 0：方法调用失败。

getAudioMixingFileDuration

  • getAudioMixingFileDuration(filePath: string): number

  • 获取指定音乐文件总时长。

    since

    v3.4.2

    note

    该方法需要在加入频道后调用。

    Parameters

    • filePath: string

      音乐文件的绝对路径或 URL 地址，需精确到文件名及后缀。 例如：C:\music\audio.mp4。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP。 详见 Supported Media Formats in Media Foundation。

    Returns number

    • ≥ 0: 方法调用成功，返回指定音乐文件总时长（毫秒）
    • < 0: 方法调用失败

getAudioMixingPlayoutVolume

  • getAudioMixingPlayoutVolume(): number

  • 获取音乐文件的本地播放音量。

    该方法获取混音的音乐文件本地播放音量，方便排查音量相关问题。

    note

    请在频道内调用该方法。

    Returns number

    • ≥ 0：方法调用成功则返回音量值，范围为 [0,100]
    • < 0：方法调用失败

getAudioMixingPublishVolume

  • getAudioMixingPublishVolume(): number

  • 调节音乐文件远端播放音量。

    该方法调节混音音乐文件在远端的播放音量大小。

    note
    • 请在频道内调用该方法。
    • 音乐文件音量范围为 0~100。100 （默认值） 为原始文件音量。

    Returns number

    • ≥ 方法调用成功则返回音量值
    • < 0 方法调用失败

getAudioPlaybackDeviceMute

  • getAudioPlaybackDeviceMute(): boolean

  • 获取当前音频播放设备的静音状态。

    Returns boolean

    • true：当前音频播放设备静音
    • false：当前音频播放设备不静音

getAudioPlaybackDevices

  • getAudioPlaybackDevices(): Array<Object>

  • 获取音频播放设备列表。

    Returns Array<Object>

    音频播放设备的 Array

getAudioPlaybackVolume

  • getAudioPlaybackVolume(): number

  • 获取音频播放设备的音量

    Returns number

    播放设备音量（分贝）。取值范围 [0,255]

getAudioRecordingDeviceMute

  • getAudioRecordingDeviceMute(): boolean

  • 获取当前音频录制设备的静音状态。

    Returns boolean

    • true：当前音频录制设备静音
    • false：当前音频录制设备不静音

getAudioRecordingDevices

  • getAudioRecordingDevices(): Array<Object>

  • 获取音频录制设备

    Returns Array<Object>

    音频录制设备的 Array

getAudioRecordingVolume

  • getAudioRecordingVolume(): number

  • 获取录制设备的音量。

    Returns number

    录音设备音量（分贝）。取值范围 [0,255]

getCallId

  • getCallId(): string

  • 获取通话 ID。

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

    Returns string

    通话 ID

getConfigObject

  • getConfigObject(): Config

  • Returns Config

getConnectionState

  • 获取当前网络连接状态。

    Returns ConnectionState

    connect 网络连接状态

getCurrentAudioPlaybackDevice

  • getCurrentAudioPlaybackDevice(): Object

  • 获取当前的音频播放设备。

    Returns Object

    音频播放设备对象

getCurrentAudioRecordingDevice

  • getCurrentAudioRecordingDevice(): Object

  • 获取当前的音频录制设备。

    Returns Object

    音频录制设备对象

getCurrentVideoDevice

  • getCurrentVideoDevice(): Object

  • 获取当前的视频设备。

    Returns Object

    视频设备对象

getEffectCurrentPosition

  • getEffectCurrentPosition(soundId: number): number

  • 获取指定音效文件的播放进度。

    since

    v3.4.2

    note

    该方法需要在 playEffect 后调用。

    Parameters

    • soundId: number

      音效 ID。请确保与 playEffect 中设置的 soundId 一致。

    Returns number

    • ≥ 0: 方法调用成功。
    • < 0: 方法调用失败。
      • -22: 无法找到音效文件。请填写正确的 soundId。

getEffectDuration

  • getEffectDuration(filePath: string): number

  • 获取指定音效文件总时长。

    since

    v3.4.2

    note

    该方法需要在加入频道后调用。

    Parameters

    • filePath: string

      音效文件的绝对路径或 URL 地址，需精确到文件名及后缀。 例如：C:\music\audio.mp4。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP。 详见 Supported Media Formats in Media Foundation。

    Returns number

    • ≥ 0: 方法调用成功，返回指定音效文件时长（毫秒）。
    • < 0: 方法调用失败。
      • -22: 无法找到音效文件。请填写正确的 filePath。

getEffectsVolume

  • getEffectsVolume(): number

  • 获取播放音效文件音量。

    Returns number

    • ≥ 0：方法调用成功则返回音量值，范围为 [0.0, 100.0]
    • < 0：方法调用失败

getErrorDescription

  • getErrorDescription(errorCode: number): string

  • 获取指定错误码的详细错误信息。

    Parameters

    • errorCode: number

      错误码

    Returns string

    errorCode 描述

getPlaybackDeviceInfo

  • getPlaybackDeviceInfo(deviceId: string, deviceName: string): number

  • 获取播放设备信息。

    Parameters

    • deviceId: string

      设备 ID

    • deviceName: string

      设备名称

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

getRealScreenDisplaysInfo

getRecordingDeviceInfo

  • getRecordingDeviceInfo(deviceId: string, deviceName: string): number

  • 获取录制设备信息。

    Parameters

    • deviceId: string

      设备 ID

    • deviceName: string

      设备名

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

getScreenDisplaysInfo

  • getScreenDisplaysInfo(): Array<Object>

  • 获取屏幕信息。

    该方法获取所有的系统（macOS 或 Windows）屏幕 ID，以及相关信息。你可以使用获取到的屏幕 ID 进行屏幕共享。

    Returns Array<Object>

    系统屏幕 ID 和相关信息列表。Windows 和 macOS 系统中返回的屏幕 ID（displayId）不同。 你无需关注返回对象的具体内容，直接使用它进行屏幕共享即可。

getScreenWindowsInfo

  • getScreenWindowsInfo(): Array<Object>

  • 获取系统窗口信息。

    该方法获取所有系统（macOS 或 Windows）窗口 ID，以及相关信息。你可以使用获取到的窗口 ID 进行屏幕共享。

    Returns Array<Object>

    系统窗口 ID 和相关信息列表

getUserInfoByUid

  • getUserInfoByUid(uid: number): object

  • 通过 UID 获取用户信息。

    远端用户加入频道后， SDK 会获取到该远端用户的 UID 和 User Account，然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表， 并在本地触发 userInfoUpdated 回调。你收到这个回调后，可以调用该方法，通过传入 UID 获取包含了指定用户 User Account 的 UserInfo 对象。

    Parameters

    • uid: number

      用户 UID

    Returns object

    • errCode 方法调用失败，返回错误码
    • userInfo 方法调用成功，返回包含了指定用户 User Account 的 UserInfo 对象

getUserInfoByUserAccount

  • getUserInfoByUserAccount(userAccount: string): object

  • 通过 User Account 获取用户信息。

    远端用户加入频道后，SDK 会获取到该远端用户的 UID 和 User Account，然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表， 并在本地触发 userInfoUpdated 回调。你收到这个回调后，可以调用该方法，通过传入 User Account 获取包含了指定用户 UID 的 UserInfo 对象。

    Parameters

    • userAccount: string

      用户 User Account

    Returns object

    • errCode 方法调用失败，返回错误码
    • userInfo 方法调用成功，获取包含了指定用户 UID 的 UserInfo 对象

getVersion

  • getVersion(): string

  • 获取当前 SDK 的版本和 Build 信息。

    Returns string

    当前 SDK 的版本

getVideoDevices

  • getVideoDevices(): Array<Object>

  • Returns Array<Object>

initRender

  • initRender(key: "local" | "videosource" | number, view: Element, channelId: string | undefined, options?: RendererOptions): void

  • 初始化渲染器对象。

    Parameters

    • key: "local" | "videosource" | number

      存储渲染器 Map 的关键标识，如 uid、videosource 或 local

    • view: Element

      渲染视频的 Dom

    • channelId: string | undefined
    • Optional options: RendererOptions

    Returns void

initialize

  • 初始化一个 AgoraRtcEngine 实例。

    Parameters

    • appid: string

      Agora 为 App 开发者签发的 App ID，每个项目都应该有一个独一无二的 App ID

    • Default value areaCode: AREA_CODE = (0xFFFFFFFF)

      服务器的访问区域。该功能为高级设置，适用于有访问安全限制的场景。支持的区域详见 AREA_CODE 指定访问区域后，Agora SDK 会连接指定区域内的 Agora 服务器。注解：仅支持指定单个访问区域。

    • Optional logConfig: LogConfig

      Agora SDK 日志文件配置。默认情况下，SDK 会生成 agorasdk.log、agorasdk_1.log、agorasdk_2.log、agorasdk_3.log、agorasdk_4.log 这 5 个日志文件。 每个文件的默认大小为 1024 KB。日志文件为 UTF-8 编码。最新的日志永远写在 agorasdk.log 中。agorasdk.log 写满后，SDK 会从 1-4 中删除修改时间最早的一个文件，然后将 agorasdk.log 重命名为该文件，并建立新的 agorasdk.log 写入最新的日志。

    Returns number

    • 0：方法调用成功
    • < 0：方法调用失败

joinChannel

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

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

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

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

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

    note

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

    Parameters

    • token: string

      在服务端生成的用于鉴权的 Token。 详见从服务端生成 Token。

    • channel: string

      标识通话的频道名称，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 89 个字符）:

      • 26 个小写英文字母 a~z；
      • 26 个大写英文字母 A~Z；
      • 10个数字 0~9；
      • 空格；
      • "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、"["、"]"、"^"、"_"、" {"、"}"、"|"、"~"、","。
    • info: string

      (非必选项) 预留参数。

    • uid: number

      (非必选项) 用户 ID，32位无符号整数。建议设置范围：1到 232-1，并保证唯一性。如果不指定（即设为0），SDK 会自动分配一个， 并在 joinedChannel 回调方法中返回，App 层必须记住该返回值并维护，SDK 不对该返回值进行维护。 请注意：频道内每个用户的 UID 必须是唯一的。如果想要从不同的设备同时接入同一个频道，请确保每个设备上使用的 UID 是不同的。

    • Optional 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, channel: string, userAccount: string, options?: ChannelMediaOptions): number

  • 使用 User Account 加入频道。

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

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

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

    note

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

    Parameters

    • token: string

      在服务端生成的用于鉴权的 Token。详见从服务端生成 Token。

    • channel: string
    • userAccount: string

      用户 User Account。该参数为必需，最大不超过 255 字节，不可为 null。请确保注册的 User Account 的唯一性。以下为支持的字符集范围（共 89 个字符）：

      • 26 个小写英文字母 a-z
      • 26 个大写英文字母 A-Z
      • 10 个数字 0-9
      • 空格
      • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
    • Optional options: ChannelMediaOptions

    Returns number

    • 0: 方法调用成功
    • < 0: 方法调用失败
      • -2
      • -3
      • -5
      • -7

leaveChannel

  • leaveChannel(): number

  • 离开频道。

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

    该方法会把回话相关的所有资源都释放掉。该方法是异步操作，调用返回时并没有真正退出频道。 真正退出频道后，本地会触发 leaveChannel 回调；通信场景下的用户和直播场景下的主播离开频道后，远端会触发 removeStream 回调。

    note
    • 若想开始下一次通话，必须先调用该方法结束本次通话。
    • 不管当前是否在通话中，都可以调用该方法，没有副作用。
    • 如果你调用该方法后立即调用 release 方法，SDK 将无法触发 leaveChannel 回调。
    • 如果你在输入在线媒体流的过程中调用了该方法， SDK 将自动调用 removeInjectStreamUrl 方法。

    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

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

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

    note
    • 该方法不影响音频采集状态，因为没有禁用音频采集设备。
    • 该方法在加入频道前后都能调用。如果你在该方法后调用 setChannelProfile 方法， SDK 会根据你设置的频道场景以及用户角色，重新设置是否取消发布本地音频。因此我们建议在 setChannelProfile 后调用该方法。

    Parameters

    • mute: boolean

      是否取消发布本地音频流。

      • true: 取消发布。
      • false:（默认）发布。

    Returns number

    • 0: 方法调用成功
    • < 0: 方法调用失败

muteLocalVideoStream

  • muteLocalVideoStream(mute: boolean): number

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

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

    note
    • 相比于调用 enableLocalVideo 控制本地视频流发送，调用该方法响应速度更快。
    • 该方法不影响视频采集状态，因为没有禁用摄像头。
    • 该方法在加入频道前后都能调用。如果你在该方法后调用 setChannelProfile 方法， SDK 会根据你设置的频道场景以及用户角色，重新设置是否取消发布本地视频。因此我们建议在 setChannelProfile 后调用该方法。

    Parameters

    • mute: boolean

      是否取消发布本地视频流。

      • true: 取消发布。
      • false: （默认）发布。

    Returns number

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: "apiCallExecuted", cb: function): this
  • on(evt: "warning", cb: function): this
  • on(evt: "error", cb: function): this
  • on(evt: "joinedChannel", cb: function): this
  • on(evt: "rejoinedChannel", cb: function): this
  • on(evt: "audioVolumeIndication", cb: function): this
  • on(evt: "groupAudioVolumeIndication", cb: function): this
  • on(evt: "leaveChannel", cb: function): this
  • on(evt: "rtcStats", cb: function): this
  • on(evt: "localVideoStats", cb: function): this
  • on(evt: "localAudioStats", cb: function): this
  • on(evt: "remoteVideoStats", cb: function): this
  • on(evt: "remoteAudioStats", cb: function): this
  • on(evt: "remoteVideoTransportStats", cb: function): this
  • on(evt: "remoteAudioTransportStats", cb: function): this
  • on(evt: "audioDeviceStateChanged", cb: function): this
  • on(evt: "audioMixingStateChanged", cb: function): this
  • on(evt: "remoteAudioMixingBegin", cb: function): this
  • on(evt: "remoteAudioMixingEnd", cb: function): this
  • on(evt: "audioEffectFinished", cb: function): this
  • on(evt: "videoDeviceStateChanged", cb: function): this
  • on(evt: "networkQuality", cb: function): this
  • on(evt: "lastMileQuality", cb: function): this
  • on(evt: "lastmileProbeResult", cb: function): this
  • on(evt: "firstLocalVideoFrame", cb: function): this
  • on(evt: "addStream", cb: function): this
  • on(evt: "videoSizeChanged", cb: function): this
  • on(evt: "firstRemoteVideoFrame", cb: function): this
  • on(evt: "userJoined", cb: function): this
  • on(evt: "removeStream", cb: function): this
  • on(evt: "userOffline", cb: function): this
  • on(evt: "userMuteAudio", cb: function): this
  • on(evt: "userMuteVideo", cb: function): this
  • on(evt: "userEnableVideo", cb: function): this
  • on(evt: "userEnableLocalVideo", cb: function): this
  • on(evt: "cameraReady", cb: function): this
  • on(evt: "videoStopped", cb: function): this
  • on(evt: "connectionLost", cb: function): this
  • on(evt: "connectionBanned", cb: function): this
  • on(evt: "streamMessage", cb: function): this
  • on(evt: "streamMessageError", cb: function): this
  • on(evt: "mediaEngineStartCallSuccess", cb: function): this
  • on(evt: "requestChannelKey", cb: function): this
  • on(evt: "firstLocalAudioFrame", cb: function): this
  • on(evt: "firstRemoteAudioFrame", cb: function): this
  • on(evt: "firstRemoteAudioDecoded", cb: function): this
  • on(evt: "activeSpeaker", cb: function): this
  • on(evt: "clientRoleChanged", cb: function): this
  • on(evt: "audioDeviceVolumeChanged", cb: function): this
  • on(evt: "videoSourceJoinedSuccess", cb: function): this
  • on(evt: "videoSourceRequestNewToken", cb: function): this
  • on(evt: "videoSourceLeaveChannel", cb: function): this
  • on(evt: "videoSourceLocalAudioStats", cb: function): this
  • on(evt: "videoSourceLocalVideoStats", cb: function): this
  • on(evt: "videoSourceVideoSizeChanged", cb: function): this
  • on(evt: "videoSourceLocalVideoStateChanged", cb: function): this
  • on(evt: "videoSourceLocalAudioStateChanged", cb: function): this
  • on(evt: "remoteVideoStateChanged", cb: function): this
  • on(evt: "cameraFocusAreaChanged", cb: function): this
  • on(evt: "cameraExposureAreaChanged", cb: function): this
  • on(evt: "tokenPrivilegeWillExpire", cb: function): this
  • on(evt: "streamPublished", cb: function): this
  • on(evt: "streamUnpublished", cb: function): this
  • on(evt: "rtmpStreamingStateChanged", cb: function): this
  • on(evt: "transcodingUpdated", cb: function): this
  • on(evt: "streamInjectStatus", cb: function): this
  • on(evt: "localPublishFallbackToAudioOnly", cb: function): this
  • on(evt: "remoteSubscribeFallbackToAudioOnly", cb: function): this
  • on(evt: "microphoneEnabled", cb: function): this
  • on(evt: "connectionStateChanged", cb: function): this
  • on(evt: "networkTypeChanged", cb: function): this
  • on(evt: "localUserRegistered", cb: function): this
  • on(evt: "userInfoUpdated", cb: function): this
  • on(evt: "localVideoStateChanged", cb: function): this
  • on(evt: "localAudioStateChanged", cb: function): this
  • on(evt: "remoteAudioStateChanged", cb: function): this
  • on(evt: "channelMediaRelayState", cb: function): this
  • on(evt: "channelMediaRelayEvent", cb: function): this
  • on(evt: "receiveMetadata", cb: function): this
  • on(evt: "sendMetadataSuccess", cb: function): this
  • on(evt: "firstLocalAudioFramePublished", cb: function): this
  • on(evt: "firstLocalVideoFramePublished", cb: function): this
  • on(evt: "rtmpStreamingEvent", 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: "uploadLogResult", cb: function): this
  • on(evt: "virtualBackgroundSourceEnabled", cb: function): this
  • on(evt: string, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • API 方法已执行回调。

    Parameters

    • evt: "apiCallExecuted"
    • cb: function
        • (api: string, err: number): void

        • Parameters

          • api: string

            SDK 执行的 API

          • err: number

            当该方法调用失败时 SDK 返回的错误码

          Returns void

    Returns this

  • 发生警告回调。

    Parameters

    • evt: "warning"
    • cb: function
        • (warn: number, msg: string): void

        • Parameters

          • warn: number

            警告码

          • msg: string

            详细的警告信息

          Returns void

    Returns this

  • 发生错误回调。

    Parameters

    • evt: "error"
    • cb: function
        • (err: number, msg: string): void

        • Parameters

          • err: number

            错误码

          • msg: string

            详细的错误信息

          Returns void

    Returns this

  • 成功加入频道。

    Parameters

    • evt: "joinedChannel"
    • cb: function
        • (channel: string, uid: number, elapsed: number): void

        • Parameters

          • channel: string

            频道名

          • uid: number

            用户 ID

          • elapsed: number

            从调用 joinChannel 开始到发生此事件过去的时间（毫秒)

          Returns void

    Returns this

  • 重新加入频道回调。

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

    Parameters

    • evt: "rejoinedChannel"
    • cb: function
        • (channel: string, uid: number, elapsed: number): void

        • Parameters

          • channel: string

            频道名

          • uid: number

            用户 ID

          • elapsed: number

            从调用 joinChannel 开始到发生此事件过去的时间（毫秒)

          Returns void

    Returns this

  • deprecated

    本回调为废弃回调。Agora 推荐你使用 groupAudioVolumeIndication 回调。

    Parameters

    • evt: "audioVolumeIndication"
    • cb: function
        • (uid: number, volume: number, speakerNumber: number, totalVolume: number): void

        • Parameters

          • uid: number
          • volume: number
          • speakerNumber: number
          • totalVolume: number

          Returns void

    Returns this

  • 提示频道内谁在说话以及说话者音量的回调。

    该回调提示频道内瞬时音量较高的几个用户的用户 ID 及他们的音量。默认禁用。可以通过 enableAudioVolumeIndication 方法开启；开启后，无论频道内是否有人说话，都会按方法中设置的时间间隔返回提示音量。

    note
    • 本地用户返回 uid 为 0，speakerNumber 始终为 1。
    • 用户调用 muteLocalAudioStream 方法会对该回调产生影响：
      • 本地用户：随即不再返回该回调。
      • 远端用户：15 秒后，该回调的报告中不再包含该远端用户。

    Parameters

    • evt: "groupAudioVolumeIndication"
    • cb: function
        • (speakers: object[], speakerNumber: number, totalVolume: number): void

        • Parameters

          • speakers: object[]

            音量较高的说话者的信息，包含：

            • uid：用户 ID
            • volume：本地用户：该用户的说话音量；远端用户：说话者各自混音后的音量
            • vad：本地用户：报告本地用户人声状态；远端用户：0
          • speakerNumber: number

            音量较高的用户人数：

            • 本地用户：1
            • 远端用户：3
          • totalVolume: number

            混音后总音量（分贝）。取值范围 [0,255]：

            • 本地用户：本地用户混音后的音量
            • 远端用户：所有说话者混音后的总音量

          Returns void

    Returns this

  • 用户离开频道。

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

    Parameters

    • evt: "leaveChannel"
    • cb: function

    Returns this

  • 通话相关统计信息。

    Parameters

    • evt: "rtcStats"
    • cb: function

        • Parameters

          Returns void

    Returns this

  • 通话中本地视频流的统计信息回调。

    note

    如果你此前调用 enableDualStreamMode 方法，则本回调描述本地设备发送的视频大流的统计信息。

    Parameters

    Returns this

  • 通话中本地音频流的统计信息回调。

    Parameters

    Returns this

  • 通话中远端视频流的统计信息回调。

    Parameters

    Returns this

  • 通话中远端音频流的统计信息回调。

    Parameters

    Returns this

  • deprecated

    该回调已废弃。请改用 remoteVideoStats 回调。

    通话中远端视频流传输的统计信息回调。

    该回调描述远端用户通话中端到端的网络统计信息，通过视频包计算，用客观的数据，如丢包、网络延迟等 ，展示当前网络状态。

    通话中，当用户收到远端用户/主播发送的视频数据包后，会每 2 秒触发一次该回调。和 remoteVideoStats 回调相比，该回调以数据展示当前网络状态，因此更客观。

    Parameters

    Returns this

  • deprecated

    该回调已废弃。请改用 remoteAudioStats 回调。

    通话中远端音频流传输的统计信息回调。

    Parameters

    Returns this

  • 音频设备状态已改变回调。

    Parameters

    • evt: "audioDeviceStateChanged"
    • cb: function
        • (deviceId: string, deviceType: number, deviceState: number): void

        • Parameters

          • deviceId: string

            设备 ID

          • deviceType: number

            设备类型，详见 MediaDeviceType

          • deviceState: number

            设备状态：

            • macOS：
              • 0: 设备就绪
              • 8: 设备被拔出
            • Windows：
              • 0：设备就绪
              • 1：设备正在使用
              • 2：设备被禁用
              • 4：没有此设备
              • 8：设备被拔出
              • 16：不推荐使用该设备

          Returns void

    Returns this

  • 本地用户的音乐文件播放状态已改变回调。

    since

    v3.4.2

    该回调在音乐文件播放状态发生改变时触发，并报告当前的播放状态和播放状态改变的原因。

    Parameters

    • evt: "audioMixingStateChanged"
    • cb: function
        • (state: number, reason: number): void

        • Parameters

          • state: number

            当前音乐文件播放状态：

            • 710：音乐文件正常播放。该状态可能由 reason 720、721、722、或 726 导致。
            • 711：音乐文件暂停播放。该状态由 reason 725 导致。
            • 713：音乐文件停止播放。该状态可能由 reason 723 或 724 导致。
            • 714：音乐文件播放失败。该状态可能由 reason 701、702、或 703 导致。
          • reason: number

            音乐文件播放状态改变的原因：

            • 701：音乐文件打开出错。例如，本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL。
            • 702：音乐文件打开太频繁。如需多次调用 startAudioMixing，请确保调用间隔大于 500 ms。
            • 703：音乐文件播放中断。
            • 720：成功调用 startAudioMixing 播放音乐文件。
            • 721：音乐文件完成一次循环播放。
            • 722：音乐文件开始新的一次循环播放。
            • 723：音乐文件完成所有循环播放。
            • 724：成功调用 stopAudioMixing 停止播放音乐文件。
            • 725：成功调用 pauseAudioMixing 暂停播放音乐文件。
            • 726：成功调用 resumeAudioMixing 恢复播放音乐文件。

          Returns void

    Returns this

  • 远端音乐文件播放已开始回调。

    当远端有用户调用 startAudioMixing 播放本地音乐文件，SDK 会触发该回调。

    Parameters

    • evt: "remoteAudioMixingBegin"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • 远端音乐文件播放已结束回调。

    Parameters

    • evt: "remoteAudioMixingEnd"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • 本地音效文件播放已结束回调。

    当播放音效结束后，会触发该回调。

    Parameters

    • evt: "audioEffectFinished"
    • cb: function
        • (soundId: number): void

        • Parameters

          • soundId: number

            指定音效的 ID。每个音效均有唯一的 ID。

          Returns void

    Returns this

  • 视频设备变化回调。

    该回调提示系统视频设备状态发生改变，比如被拔出或移除。如果设备已使用外接摄像头采集，外接摄像头被拔开后，视频会中断。

    Parameters

    • evt: "videoDeviceStateChanged"
    • cb: function
        • (deviceId: string, deviceType: number, deviceState: number): void

        • Parameters

          • deviceId: string

            设备 ID

          • deviceType: number

            设备类型，详见 MediaDeviceType

          • deviceState: number

            设备状态：

            • macOS：
              • 0: 设备就绪
              • 8: 设备被拔出
            • Windows：
              • 0：设备就绪
              • 1：设备正在使用
              • 2：设备被禁用
              • 4：没有此设备
              • 8：设备被拔出
              • 16：不推荐使用该设备

          Returns void

    Returns this

  • 通话中每个用户的网络上下行 last mile 质量报告回调。

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

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

    Parameters

    • evt: "networkQuality"
    • cb: function

        • Parameters

          • uid: number

            用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。 当 uid 为 0 时，返回的是本地用户的网络质量

          • txquality: AgoraNetworkQuality

            该用户的上行网络质量，基于上行发送码率、上行丢包率、平均往返时延和网络 抖动计算。

          • rxquality: AgoraNetworkQuality

            该用户的下行网络质量，基于下行网络的丢包率、平均往返延时和网络抖动计算。

          Returns void

    Returns this

  • 通话前网络上下行 last mile 质量报告回调。

    该回调描述本地用户在加入频道前的 last mile 网络探测的结果，其中 last mile 是指设备到 Agora 边缘服务器的网络状态。

    在调用 enableLastmileTest 之后，该回调函数每 2 秒触发一次。如果远端有多个用户/主播，该回调每 2 秒会被触发多次。

    Parameters

    • evt: "lastMileQuality"
    • cb: function

        • Parameters

          • quality: AgoraNetworkQuality

            网络上下行质量，基于上下行网络的丢包率和抖动计算，探测结果主要反映上行网络的状态。

          Returns void

    Returns this

  • 通话前网络质量探测报告回调。

    在调用 startLastmileProbeTest 之后，SDK 会在约 30 秒内返回该回调。

    Parameters

    Returns this

  • 已显示本地视频首帧回调。

    本地视频首帧显示在本地视图上时，SDK 会触发此回调。

    Parameters

    • evt: "firstLocalVideoFrame"
    • cb: function
        • (width: number, height: number, elapsed: number): void

        • Parameters

          • width: number

            本地渲染视频的宽 (px)

          • height: number

            本地渲染视频的高 (px)

          • elapsed: number

            从本地调用 joinChannel 到发生此事件过去的时间（毫秒)

          Returns void

    Returns this

  • deprecated

    这个回调已被废弃，请改用 remoteVideoStateChanged 回调。

    已接收到远端视频并完成解码回调。

    引擎收到第一帧远端视频流并解码成功时，触发此调用。有两种情况：

    • 远端用户首次上线后发送视频
    • 远端用户视频离线再上线后发送视频。出现这种中断的可能原因包括：
      • 远端用户离开频道
      • 远端用户掉线
      • 远端用户调用 muteLocalVideoStream 方法停止发送本地视频流
      • 远端用户调用 disableVideo 方法关闭视频模块

    Parameters

    • evt: "addStream"
    • 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

  • depreacted

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

    已显示首帧远端视频回调。

    第一帧远端视频显示在视图上时，触发此调用。

    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

  • 远端用户（通信场景）/主播（直播场景）加入当前频道回调。

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

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

    • 远端用户/主播调用 joinChannel 方法加入频道
    • 远端用户加入频道后调用 setClientRole 将用户角色改变为主播
    • 远端用户/主播网络中断后重新加入频道
    • 主播通过调用 addInjectStreamUrl 方法成功导入在线媒体流
    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: "removeStream"
    • cb: function
        • (uid: number, reason: number): void

        • Parameters

          • uid: number

            离线用户或主播的用户 ID。

          • reason: number

            离线原因

            • 0：用户主动离开。
            • 1：因过长时间收不到对方数据包，超时掉线。注意：由于 SDK 使用的是不可靠通道，也有可能对方主动离开本方没收到对方离开消息而误判为超时掉线。
            • 2：用户身份从主播切换为观众。

          Returns void

    Returns this

  • 远端用户（通信场景）/主播（直播场景）离开当前频道回调。

    用户离开频道有两个原因，即正常离开和超时掉线：

    • 正常离开的时候，远端用户/主播会收到类似“再见”的消息，接收此消息后，判断用户离开频道
    • 超时掉线的依据是，在一定时间内（约 20 秒），用户没有收到对方 的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。Agora 建议使用信令系统 来做可靠的掉线检测

    Parameters

    • evt: "userOffline"
    • cb: function
        • (uid: number, reason: number): void

        • Parameters

          • uid: number

            主播 ID

          • reason: number

            离线原因

            • 用户主动离开
            • 因过长时间收不到对方数据包，超时掉线。注意：由于 SDK 使用的是不可靠通道，也有可能对方 主动离开本方没收到对方离开消息而误判为超时掉线
            • （直播场景下）用户身份从主播切换为观众

          Returns void

    Returns this

  • deprecated

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

    远端用户暂停/重新发送音频流回调。

    该回调是由远端用户调用 muteLocalAudioStream 方法关闭或开启音频发送触发的。

    note

    当频道内的主播超过 20 人时，该回调不生效。

    Parameters

    • evt: "userMuteAudio"
    • cb: function
        • (uid: number, muted: boolean): void

        • Parameters

          • uid: number

            远端用户 ID

          • muted: boolean

            该用户是否暂停发送音频流

            • true：该用户已暂停发送音频流
            • false：该用户已重新发送音频流

          Returns void

    Returns this

  • 远端用户暂停/重新发送视频流回调。

    该回调是由远端用户调用 muteLocalVideoStream 方法关闭或开启音频发送触发的。

    note

    当频道内的主播超过 20 人时，该回调不生效。

    Parameters

    • evt: "userMuteVideo"
    • cb: function
        • (uid: number, muted: boolean): void

        • Parameters

          • uid: number

            远端用户 ID

          • muted: boolean

            该用户是否暂停发送视频流

            • true：该用户已暂停发送视频流
            • false：该用户已重新发送视频流

          Returns void

    Returns this

  • deprecated

    这个回调已被废弃，请改用 remoteVideoStateChanged 回调。

    远端用户开启/关闭视频模块回调。

    该回调是由远端用户调用 enableVideo 或 disableVideo 方法开启或关闭视频模块触发的。

    note

    Agora 视频模块指视频处理过程，而不是 SDK 中的模块实物。发送视频流时，视频模块指视频采集、前处理、编码等处理过程；接收视频流时，视频模块指视频解码、后处理、渲染/播放等处理过程。

    Parameters

    • evt: "userEnableVideo"
    • cb: function
        • (uid: number, enabled: boolean): void

        • Parameters

          • uid: number

            用户 ID

          • enabled: boolean

            该用户是否开启或关闭视频模块：

            • true：该用户已启用视频模块。启用后，该用户可以进行视频通话或直播。
            • false：该用户已关闭视频模块。关闭后，该用户只能进行语音通话或直播，不能显示、发送自己的视频，也不能接收、显示别人的视频。

          Returns void

    Returns this

  • deprecated

    这个回调已被废弃，请改用 remoteVideoStateChanged 回调。

    远端用户开启/关闭本地视频采集。

    该回调是由远端用户调用 enableLocalVideo 方法开启或关闭视频采集触发的。

    Parameters

    • evt: "userEnableLocalVideo"
    • cb: function
        • (uid: number, enabled: boolean): void

        • Parameters

          • uid: number

            用户 ID

          • enabled: boolean

            该用户是否开启或关闭本地视频采集：

            • true：该用户已启用本地视频采集。启用后，其他用户可以接收到该用户的视频流。
            • false：该用户已关闭视频采集。关闭后，该用户仍然可以接收其他用户的视频流，但其他用户接收不到该用户的视频流。

          Returns void

    Returns this

  • deprecated

    该回调已废弃。请改用 localVideoStateChanged 回调。

    摄像头就绪回调。

    Parameters

    • evt: "cameraReady"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • deprecated

    该回调已废弃。请改用 localVideoStateChanged 回调。

    视频停止播放回调。

    Parameters

    • evt: "videoStopped"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • 网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。

    note

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

    Parameters

    • evt: "connectionLost"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • deprecated

    该回调已废弃。请改用 connectionStateChanged 回调。

    网络连接已被服务器禁止回调。

    当你被服务端禁掉连接的权限时，会触发该回调。

    Parameters

    • evt: "connectionBanned"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • 接收到对方数据流消息的回调。

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

    Parameters

    • evt: "streamMessage"
    • cb: function
        • (uid: number, streamId: number, msg: string, len: number): void

        • Parameters

          • uid: number

            用户 ID

          • streamId: number

            数据流 ID

          • msg: string

            接收到的流消息

          • len: number

            流消息数据长度

          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

  • 媒体引擎成功启动的回调。

    Parameters

    • evt: "mediaEngineStartCallSuccess"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • Token 已过期回调。

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

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

    Parameters

    • evt: "requestChannelKey"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • 已发送本地音频首帧回调。

    deprecated

    该回调自 v3.2.0 已废弃，请改用 firstLocalAudioFramePublished。

    Parameters

    • evt: "firstLocalAudioFrame"
    • cb: function
        • (elapsed: number): void

        • Parameters

          • elapsed: number

            从本地用户调用 joinChannel 方法直至该回调被触发的延迟（毫秒）。

          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

  • 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

  • 检测到活跃用户回调。

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

    Parameters

    • evt: "activeSpeaker"
    • cb: function
        • (uid: number): void

        • Parameters

          • uid: number

            当前时间段内声音最大的用户的 uid（本地用户 uid 为 0）

          Returns void

    Returns this

  • 用户角色已切换回调。

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

    Parameters

    Returns this

  • 回放、录音设备、或 App 的音量发生改变。

    Parameters

    • evt: "audioDeviceVolumeChanged"
    • cb: function

        • Parameters

          • deviceType: MediaDeviceType

            设备类型

          • volume: number

            当前音量（分贝）。取值范围 [0, 255]

          • muted: boolean

            音频设备是否为静音状态

            • true：音频设备已静音
            • false：音频设备未被静音

          Returns void

    Returns this

  • 屏幕共享对象成功加入频道回调。

    Parameters

    • evt: "videoSourceJoinedSuccess"
    • cb: function
        • (uid: number): void

        • Parameters

          • uid: number

            该对象的用户 ID

          Returns void

    Returns this

  • 屏幕共享对象 Token 已过期回调。

    Parameters

    • evt: "videoSourceRequestNewToken"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • 屏幕共享对象离开频道回调。

    Parameters

    • evt: "videoSourceLeaveChannel"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • 通话中本地音频流的统计信息回调。

    Parameters

    • evt: "videoSourceLocalAudioStats"
    • cb: function

    Returns this

  • 通话中本地视频流的统计信息回调。

    note

    如果你此前调用 enableDualStreamMode 方法，则本回调描述本地设备发送的视频大流的统计信息。

    Parameters

    • evt: "videoSourceLocalVideoStats"
    • cb: function

    Returns this

  • 本地或远端视频大小和旋转信息发生改变回调。

    Parameters

    • evt: "videoSourceVideoSizeChanged"
    • 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

  • 本地视频状态发生改变回调

    本地视频的状态发生改变时，SDK 会触发该回调返回当前的本地视频状态。你可以通过该回调了解当前视频的状态以及出现故障的原因，方便排查问题。

    SDK 会在如下情况触发 localVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_FAILED，LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE) 回调：

    • 应用退到后台，系统回收摄像头。
    • 摄像头正常启动，但连续 4 秒都没有输出采集的视频。

    摄像头输出采集的视频帧时，如果连续 15 帧中，所有视频帧都一样，SDK 触发 localVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_CAPTURING，LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE) 回调。 注意：帧重复检测仅针对分辨率大于 200 × 200，帧率大于等于 10 fps，码率小于 20 Kbps 的视频帧。

    note

    对某些机型而言，当本地视频采集设备正在使用中时，SDK 不会在本地视频状态发生改变时触发该回调，你需要自行做超时判断。

    Parameters

    Returns this

  • 本地音频状态发生改变回调。

    本地音频的状态发生改变时（包括本地麦克风采集状态和音频编码状态）， SDK 会触发该回调报告当前的本地音频状态。在本地音频出现故障时， 该回调可以帮助你了解当前音频的状态以及出现故障的原因，方便你排查问题。

    note

    当状态为 LOCAL_AUDIO_STREAM_STATE_FAILED(3) 时， 你可以在 err 参数中查看返回的错误信息。

    Parameters

    Returns this

  • 远端用户视频流状态发生改变回调。

    Parameters

    • evt: "remoteVideoStateChanged"
    • cb: function

    Returns this

  • 相机对焦区域已改变回调。

    Parameters

    • evt: "cameraFocusAreaChanged"
    • cb: function
        • (x: number, y: number, width: number, height: number): void

        • Parameters

          • x: number

            发生改变的对焦区域相对于左上角的 x 坐标。

          • y: number

            发生改变的对焦区域相对于左上角的 y 坐标。

          • width: number

            发生改变的对焦区域的宽度 (px)。

          • height: number

            发生改变的对焦区域的高度 (px)。

          Returns void

    Returns this

  • 摄像头曝光区域已改变回调。

    Parameters

    • evt: "cameraExposureAreaChanged"
    • cb: function
        • (x: number, y: number, width: number, height: number): void

        • Parameters

          • x: number

            发生改变的曝光区域相对于左上角的 x 坐标。

          • y: number

            发生改变的曝光区域相对于左上角的 y 坐标。

          • width: number

            发生改变的曝光区域的宽度 (px)。

          • height: number

            发生改变的曝光区域的高度 (px)。

          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

  • deprecated

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

    开启旁路推流的结果回调。

    该回调返回 addPublishStreamUrl 方法的调用结果。用于通知主播是否推流成功。如果不成功，你可以在 error 参数中查看详细的错误信息。

    Parameters

    • evt: "streamPublished"
    • cb: function
        • (url: string, error: number): void

        • Parameters

          • url: string

            新增的推流地址。

          • error: number

            详细的错误信息

            • 0：推流成功
            • 1：推流失败
            • 2：参数错误。如果你在调用 addPublishStreamUrl 前没有调用 setLiveTranscoding 配置 LiveTranscoding，SDK 会返回该错误
            • 10：推流超时未成功
            • 19：推流地址已经在推流
            • 130：推流已加密不能推流

          Returns void

    Returns this

  • 停止旁路推流的结果回调。

    该回调返回 removePublishStreamUrl 方法的调用结果。用于通知主播是否停止推流成功。

    Parameters

    • evt: "streamUnpublished"
    • cb: function
        • (url: string): void

        • Parameters

          • url: string

            主播停止推流的 RTMP 地址。

          Returns void

    Returns this

  • RTMP 推流状态发生改变回调。

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

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

    Parameters

    • evt: "rtmpStreamingStateChanged"
    • cb: function
        • (url: string, state: number, code: number): void

        • Parameters

          • url: string

            推流状态发生改变的 URL 地址

          • state: number

            推流状态：

            • 0: 推流未开始或已结束。成功调用 removePublishStreamUrl 后会返回该状态。
            • 1: 正在连接 Agora 推流服务器和 RTMP 服务器。调用 addPublishStreamUrl 后会返回该状态。
            • 2: 推流正在进行。成功推流后，会返回该状态。
            • 3: 正在恢复推流。当 CDN 出现异常，或推流短暂中断时，SDK 会自动尝试恢复推流，并返回该状态。
              • 如成功恢复推流，则进入状态 2。
              • 如服务器出错或 60 秒内未成功恢复，则进入状态 4。如果觉得 60 秒太长，也可以主动调用 addPublishStreamUrl，再调用 removePublishStreamUrl 尝试重连。
            • 4: 推流失败。失败后，你可以通过返回的错误码排查错误原因，也可以再次调用 addPublishStreamUrl 重新尝试推流。
          • code: number

            推流错误码：

            • 0: 推流成功。
            • 1: 参数无效。请检查输入参数是否正确。
            • 2: 推流已加密，不能推流。
            • 3: 推流超时未成功。可调用 addPublishStreamUrl 重新推流。
            • 4: 推流服务器出现错误。请调用 addPublishStreamUrl 重新推流。
            • 5: RTMP 服务器出现错误。
            • 6: 推流请求过于频繁。
            • 7: 单个主播的推流地址数目达到上线 10。请删掉一些不用的推流地址再增加推流地址。
            • 8: 主播操作不属于自己的流。例如更新其他主播的流参数、停止其他主播的流。请检查 App 逻辑。
            • 9: 服务器未找到这个流。
            • 10: 推流地址格式有错误。请检查推流地址格式是否正确。
            • 100: 推流已正常结束。当你调用 removePublishStreamUrl 结束推流后，SDK 会返回该值。

          Returns void

    Returns this

  • 旁路推流设置被更新回调。该

    回调用于通知主播 CDN 转码已成功更新。

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

    note

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

    Parameters

    • evt: "transcodingUpdated"
    • cb: function
        • (): void

        • Returns void

    Returns this

  • 导入在线媒体流状态回调。

    该回调表明向直播导入的外部视频流的状态。

    warning

    客户端输入在线媒体流功能即将停服。如果你尚未集成该功能，Agora 建议你不要使用。详见《部分服务下架计划》。

    Parameters

    • evt: "streamInjectStatus"
    • cb: function
        • (url: string, uid: number, status: number): void

        • Parameters

          • url: string

            导入进直播的外部视频源的 URL 地址。

          • uid: number

            用户 ID。

          • status: number

            导入的外部视频源状态

            • 0：外部视频流导入成功
            • 1：外部视频流已存在
            • 2：外部视频流导入未经授权
            • 3：导入外部视频流超时
            • 4：外部视频流导入失败
            • 5：外部视频流停止导入失败
            • 6：未找到要停止导入的外部视频流
            • 7：要停止导入的外部视频流未经授权
            • 8：停止导入外部视频流超时
            • 9：停止导入外部视频流失败
            • 10：导入的外部视频流被中断

          Returns void

    Returns this

  • 本地发布流已回退为音频流回调。

    如果你调用了设置本地推流回退选项 setLocalPublishFallbackOption 并将 option 设置为 2 时，当上行网络环境不理想、本地发布的媒体流回退为音频流时，或当上行网络改善、媒体流恢复为音视频流时，会触发该回调。

    如果本地推流已回退为音频流，远端的 App 上会收到 userMuteVideo 的回调事件。

    Parameters

    • evt: "localPublishFallbackToAudioOnly"
    • cb: function
        • (isFallbackOrRecover: boolean): void

        • Parameters

          • isFallbackOrRecover: boolean

            本地推流已回退或恢复：

            • true：由于网络环境不理想，本地发布的媒体流已回退为音频流
            • false：由于网络环境改善，发布的音频流已恢复为音视频流

          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

  • deprecated

    这个回调已被废弃，请改用 localAuidoStateChanged 回调。

    麦克风状态已改变回调。

    该回调由本地用户开启或关闭本地音频采集触发的。

    Parameters

    • evt: "microphoneEnabled"
    • cb: function
        • (enabled: boolean): void

        • Parameters

          • enabled: boolean

            是否开启麦克风：

            • true：麦克风已启用
            • false：麦克风已禁用

          Returns void

    Returns this

  • 网络连接状态已改变回调。

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

    Parameters

    Returns this

  • Parameters

    Returns this

  • 本地用户成功注册 User Account 回调。

    本地用户成功调用 registerLocalUserAccount 方法注册用户 User Account，或调用 joinChannelWithUserAccount 加入频道后，SDK 会触发该回调，并告知本地用户的 UID 和 User Account。包含如下参数：

    Parameters

    • evt: "localUserRegistered"
    • cb: function
        • (uid: number, userAccount: string): void

        • Parameters

          • uid: number

            本地用户的 UID

          • userAccount: string

            本地用户的 User account

          Returns void

    Returns this

  • 远端用户信息已更新回调。

    远端用户加入频道后， SDK 会获取到该远端用户的 UID 和 User Account，然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表，并在本地触发该回调。

    Parameters

    • evt: "userInfoUpdated"
    • cb: function
        • (uid: number, userInfo: UserInfo): void

        • Parameters

          • uid: number

            远端用户的 ID

          • userInfo: UserInfo

            标识用户信息的 UserInfo 对象，包含用户 UID 和 User account

          Returns void

    Returns this

  • 本地视频状态发生改变回调

    本地视频的状态发生改变时，SDK 会触发该回调返回当前的本地视频状态。你可以通过该回调了解当前视频的状态以及出现故障的原因，方便排查问题。

    SDK 会在如下情况触发 localVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_FAILED，LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE) 回调：

    • 应用退到后台，系统回收摄像头。
    • 摄像头正常启动，但连续 4 秒都没有输出采集的视频。

    摄像头输出采集的视频帧时，如果连续 15 帧中，所有视频帧都一样，SDK 触发 localVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_CAPTURING，LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE) 回调。 注意：帧重复检测仅针对分辨率大于 200 × 200，帧率大于等于 10 fps，码率小于 20 Kbps 的视频帧。

    note

    对某些机型而言，当本地视频采集设备正在使用中时，SDK 不会在本地视频状态发生改变时触发该回调，你需要自行做超时判断。

    Parameters

    Returns this

  • 本地音频状态发生改变回调。

    本地音频的状态发生改变时（包括本地麦克风采集状态和音频编码状态）， SDK 会触发该回调报告当前的本地音频状态。在本地音频出现故障时， 该回调可以帮助你了解当前音频的状态以及出现故障的原因，方便你排查问题。

    note

    当状态为 LOCAL_AUDIO_STREAM_STATE_FAILED(3) 时， 你可以在 err 参数中查看返回的错误信息。

    Parameters

    Returns this

  • 远端音频流状态发生改变回调。

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

    Parameters

    • evt: "remoteAudioStateChanged"
    • cb: function

    Returns this

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

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