需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

网络及其他

  • C++

更新时间不可用

complain

允许用户在通话结束后投诉通话质量。

C++
virtual int complain(const char* callId, const char* description) = 0;

请在用户离开频道后调用该方法。

参数

参数名描述
callId

当前通话的通话 ID。你可以通过调用 getCallId 获取。

description

（可选）对通话的描述。字符串长度应小于 800 字节。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。

  • < 0：方法调用失败。详见错误码了解详情和解决建议。

    • -1：发生通用错误（无明确原因）。
    • -2：参数无效。
    • -7：在 IRtcEngine 初始化之前调用该方法。

所属接口类

enableEncryption

启用或关闭内置加密功能。

C++
virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0;

用户离开频道后，SDK 会自动关闭内置加密功能。若需启用该功能，请在用户重新加入频道前调用该方法。

注：

  • 同一频道内的所有用户在调用该方法时必须设置相同的加密配置。
  • 启用内置加密功能后，无法使用旁路推流功能。

适用场景

适用于安全性要求较高的场景。

调用时机

请在加入频道前调用该方法。

参数

参数名描述
enabled

是否启用内置加密功能：

  • true：启用内置加密功能。
  • false：（默认）关闭内置加密功能。
config

内置加密配置。详见 EncryptionConfig。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。

  • < 0：方法调用失败。详见错误码了解详情和解决建议。

    • -2：参数无效，请传入有效参数。
    • -4：内置加密模式错误或 SDK 加载外部加密库失败，请检查枚举值或重新加载外部加密库。
    • -7：SDK 未初始化，请先初始化 IRtcEngine 实例后再调用该方法。

所属接口类

enableEncryptionEx

启用或关闭内置加密功能。

C++
virtual int enableEncryptionEx(const RtcConnection& connection, bool enabled, const EncryptionConfig& config) = 0;

用户离开频道后，SDK 会自动关闭内置加密。若需启用内置加密，请在用户重新加入频道前调用该方法。

注：

  • 同一频道内的所有用户在调用该方法时必须设置相同的加密配置。
  • 启用内置加密后，无法使用旁路推流功能。

适用场景

适用于多频道场景，或对安全性要求较高的场景。

调用时机

请在加入频道前调用该方法。

参数

参数名描述
connection

连接信息。详见 RtcConnection。

enabled

是否启用内置加密：

  • true：启用内置加密。
  • false：（默认）关闭内置加密。
config

内置加密配置。详见 EncryptionConfig。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

enableWebSdkInteroperability

启用与声网 Web SDK 的互通功能（仅适用于直播场景）。

C++
virtual int enableWebSdkInteroperability(bool enabled) __deprecated = 0;

废弃

该方法已废弃。SDK 自动开启与 Web SDK 的互通，无需调用该方法开启。

你可以调用该方法启用或关闭与声网 Web SDK 的互通功能。如果频道中有 Web SDK 用户，必须调用该方法，否则 Native 用户的视频画面在 Web 端会显示为黑屏。该方法仅适用于直播场景，在语音通话场景中默认启用互通功能。

参数

参数名描述
enabled

是否启用互通功能：

  • true：启用互通功能。
  • false：（默认）关闭互通功能。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getCallId

获取当前通话 ID。

C++
virtual int getCallId(agora::util::AString& callId) = 0;

当用户在客户端加入频道时，SDK 会生成一个用于标识该通话的 callId。你可以调用该方法获取 callId，并在调用 rate 和 complain 等方法时传入该值。

调用时机

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

参数

参数名描述
callId

输出参数，当前通话的 callId。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getCallIdEx

获取与连接 ID 对应的通话 ID。

C++
virtual int getCallIdEx(agora::util::AString& callId, const RtcConnection& connection) = 0;

当用户在客户端加入频道时，SDK 会生成一个用于标识该通话的 callId。你可以调用该方法获取 callId，并在调用如 rate 和 complain 等方法时传入该值。

适用场景

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

调用时机

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

参数

参数名描述
callId

输出参数，当前通话的 callId。

connection

连接信息。详见 RtcConnection。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getConnectionState

获取 SDK 当前的连接状态。

C++
virtual CONNECTION_STATE_TYPE getConnectionState() = 0;

调用时机

该方法可以在加入频道前或加入频道后调用。

返回值

方法调用成功，返回当前连接状态，详见 CONNECTION_STATE_TYPE。

所属接口类

getConnectionStateEx

获取 SDK 当前的连接状态。

C++
virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection& connection) = 0;

适用场景

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

调用时机

该方法可以在加入频道前或加入频道后调用。

参数

参数名描述
connection

连接信息。详见 RtcConnection。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

当前的连接状态。详见 CONNECTION_STATE_TYPE。

所属接口类

getCurrentMonotonicTimeInMs

获取 SDK 当前的单调时间。

C++
virtual int64_t getCurrentMonotonicTimeInMs() = 0;

在自定义视频采集或自定义音频采集场景中，为确保音视频同步，建议调用该方法获取 SDK 当前的单调时间（单位为毫秒），并将该值传入采集的视频帧（VideoFrame）和音频帧（AudioFrame）的时间戳参数中。单调时间是指一个随时间单调递增的时间序列。

调用时机

该方法可以在加入频道前或加入频道后调用。

返回值

  • ≥ 0：方法调用成功，返回 SDK 当前的单调时间（单位为毫秒）。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getErrorDescription

getErrorDescription：获取警告或错误描述。

C++
virtual const char* getErrorDescription(int code) = 0;

参数

参数名描述
code

SDK 报告的错误码。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 方法调用成功时，返回错误码对应的描述字符串。
  • 方法调用失败时，返回空字符串。

所属接口类

getNetworkType

获取本地网络连接类型。

C++
virtual int getNetworkType() = 0;

注： getNetworkType 方法可在加入频道前或加入频道后调用。

返回值

  • 0：方法调用成功，返回本地网络连接类型。

    • 0：SDK 与网络断开连接。
    • 1：网络类型为 LAN。
    • 2：网络类型为 Wi-Fi（包括热点）。
    • 3：网络类型为移动 2G。
    • 4：网络类型为移动 3G。
    • 5：网络类型为移动 4G。
    • 6：网络类型为移动 5G。

  • < 0：方法调用失败。详见错误码了解详情和解决建议。

    • -1：网络类型未知。

所属接口类

getNtpWallTimeInMs

获取当前的 NTP（网络时间协议）时间。

C++
virtual uint64_t getNtpWallTimeInMs() = 0;

在实时合唱场景中，尤其是当多个接收端因网络问题导致下行链路不一致时，可以调用该方法获取当前的 NTP 时间作为参考时间，以对齐多个接收端的歌词和音乐，实现合唱同步。

返回值

方法调用成功，返回当前 NTP 时间的 Unix 时间戳（毫秒）。

所属接口类

getVersion

获取 SDK 版本号。

C++
virtual const char* getVersion(int* build) = 0;

参数

参数名描述
build

输出参数，表示 SDK 的构建索引。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 方法调用成功时，返回 SDK 的版本号字符串。
  • 方法调用失败，返回空字符串。

所属接口类

isFeatureAvailableOnDevice

检查当前设备是否支持指定的高级功能。

C++
virtual bool isFeatureAvailableOnDevice(FeatureType type) = 0;

自从

自 v4.3.0 版本新增。

你可以通过该方法判断当前设备是否满足使用虚拟背景、美颜特效等高级功能的性能要求，从而避免在低性能设备上启用相关功能导致性能下降或功能不可用。根据返回结果，你可以决定是否展示或启用对应功能按钮，或在设备性能不足时提示用户。

参数

参数名描述
type

高级功能的类型，详见 FeatureType。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • true：当前设备支持指定的功能。
  • false：当前设备不支持指定的功能。

所属接口类

queryDeviceScore

查询设备评分。

C++
virtual int queryDeviceScore() = 0;

在高清或超高清的视频场景中，可以调用该方法查询设备评分。如果返回的评分较低（例如低于 60），建议降低视频分辨率，以避免影响视频体验。不同业务场景对设备评分的最低要求不同，具体建议请联系技术支持。

返回值

  • 方法调用成功，返回当前设备评分，范围为 [0, 100]，数值越大表示设备性能越强。大多数设备评分在 60 到 100 之间。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

queryInterface

获取指定接口的指针。

C++
virtual int queryInterface(INTERFACE_ID_TYPE iid, void** inter) = 0;

参数

参数名描述
iid

接口的 ID，详见 INTERFACE_ID_TYPE。

inter

输出参数，表示指定接口的指针。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

rate

允许用户在通话结束后对通话进行评分。

C++
virtual int rate(const char* callId, int rating, const char* description) = 0;

注： 请确保在离开频道后再调用该方法。

参数

参数名描述
callId

当前通话的 ID。你可以通过调用 getCallId 获取。

rating

评分值，范围为 1（最低分）到 5（最高分）。

description

（可选）通话的描述信息，字符串长度应小于 800 字节。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。

  • < 0：方法调用失败。详见错误码了解详情和解决建议。

    • -1：发生通用错误（无具体原因）。
    • -2：参数无效。

所属接口类

registerPacketObserver

注册一个数据包观察器。

C++
virtual int registerPacketObserver(IPacketObserver* observer) = 0;

调用该方法注册一个数据包观察器。当声网 SDK 触发用于语音或视频数据包传输的 IPacketObserver 回调时，你可以通过该方法处理数据包，例如加密或解密。

注：

  • 处理后发送到网络的数据包大小不得超过 1200 字节，否则 SDK 可能无法发送该数据包。
  • 请确保接收端和发送端都调用该方法，否则可能会出现无声音或黑屏等未定义行为。
  • 当你使用媒体推流或录制功能时，声网不建议调用该方法。
  • 请在加入频道前调用该方法。

参数

参数名描述
observer

数据包观察器。详见 IPacketObserver。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

sendCustomReportMessage

上报自定义消息。

C++
virtual int sendCustomReportMessage(const char* id, const char* category, const char* event, const char* label, int value) = 0;

该功能处于测试阶段，支持上报和分析自定义消息，当前提供免费试用。在测试版本中，最多支持在 6 秒内上报 10 条消息，每条消息不超过 256 字节，每个字符串不超过 100 字节。如需试用该功能，请联系销售并与我们讨论自定义消息的格式。

参数

参数名描述
id

消息的唯一标识。

category

消息的分类。

event

事件名称。

label

消息标签。

value

消息的数值。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

sendCustomReportMessageEx

支持上报和分析自定义消息。

C++
virtual int sendCustomReportMessageEx(const char* id, const char* category, const char* event, const char* label, int value, const RtcConnection& connection) = 0;

该功能目前处于测试阶段，提供免费试用。在测试版本中，最多支持在 6 秒内上报 10 条消息，每条消息不超过 256 字节，每个字符串不超过 100 字节。如需试用该功能，请联系销售并与我们讨论自定义消息的格式。

适用场景

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

参数

参数名描述
id

自定义消息的唯一标识。

category

自定义消息的分类。

event

自定义消息的事件名称。

label

自定义消息的标签。

value

自定义消息的数值。

connection

RtcConnection 对象。详见 RtcConnection。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setAVSyncSource

设置发送端的音视频同步。

C++
virtual int setAVSyncSource(const char* channelId, uid_t uid) = 0;

用户可能会使用两台独立设备分别发送音频和视频流。为了确保接收端的音视频同步，你可以在视频发送端调用该方法，并传入音频发送端的频道名和用户 ID。SDK 会以音频流的时间戳为参考，自动调整视频流，即使两台发送设备处于不同的上行网络（如 Wi-Fi 和 4G），也能实现音视频同步。

注： 声网建议你在加入频道前调用该方法。

参数

参数名描述
channelId

音频发送端的频道名。

uid

音频发送端的用户 ID。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setCloudProxy

设置云代理服务。

C++
virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType) = 0;

自从

自 v3.3.0 版本新增。

当用户的网络访问受防火墙限制时，需要先配置防火墙，允许访问声网提供的特定 IP 地址和端口，然后调用该方法启用云代理，并通过 proxyType 参数设置云代理类型。

成功连接到云代理后，SDK 会触发 onConnectionStateChanged 回调，状态为 CONNECTION_STATE_CONNECTING，原因为 CONNECTION_CHANGED_SETTING_PROXY_SERVER。

要禁用已设置的云代理，请调用 setCloudProxy(NONE_PROXY)。

要更改已设置的云代理类型，请先调用 setCloudProxy(NONE_PROXY)，然后再调用 setCloudProxy 设置新的 proxyType。

注：

  • 建议在加入频道前调用该方法。
  • 当用户处于防火墙之后并使用强制 UDP 云代理时，旁路推流和跨频道联播服务不可用。
  • 当使用强制 TCP 云代理时，调用 startAudioMixing 播放 HTTP 协议的在线音乐文件会发生错误。旁路推流和跨频道联播服务使用基于 TCP 协议的云代理。

相关回调

成功连接到云代理后，SDK 会触发 onConnectionStateChanged 回调，状态为 CONNECTION_STATE_CONNECTING，原因为 CONNECTION_CHANGED_SETTING_PROXY_SERVER。

参数

参数名描述
proxyType

云代理类型，详见 CLOUD_PROXY_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。

  • < 0：方法调用失败。详见错误码了解详情和解决建议。

    • -2：参数无效。
    • -7：SDK 未初始化。

所属接口类

setLocalAccessPoint

配置连接到声网私有媒体服务器接入模块。

C++
virtual int setLocalAccessPoint(const LocalAccessPointConfiguration& config) = 0;

成功部署声网私有媒体服务器并在内网客户端集成 4.x RTC SDK 后，你可以调用该方法指定本地接入点，并将接入模块分配给 SDK。

注： 该方法仅在部署声网混合云解决方案后生效。你可以联系销售了解详情并部署声网混合云。

调用时机

该方法必须在加入频道前调用。

参数

参数名描述
config

本地接入点配置。详见 LocalAccessPointConfiguration。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setLogFile

设置 SDK 输出日志文件路径。

C++
virtual int setLogFile(const char* filePath) = 0;

废弃

该方法已废弃，请改用 initialize 中的 context 设置日志文件路径。

用于指定 SDK 输出日志的文件路径，日志文件记录 SDK 运行过程中的所有日志数据。你需要在调用 initialize 后立即调用该方法，否则日志输出可能不完整。

注： 请确保日志文件所在目录已存在且具有写权限。

调用时机

该方法需要在调用 initialize 后立即调用，否则输出日志可能不完整。

参数

参数名描述
filePath

日志文件的完整路径，使用 UTF-8 编码。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setLogFileSize

设置日志文件大小。

C++
virtual int setLogFileSize(unsigned int fileSizeInKBytes) = 0;

废弃

该方法已废弃，请改用 initialize 中的 logConfig 设置日志文件大小。

默认情况下，SDK 会生成五个 SDK 日志文件和五个 API 调用日志文件，规则如下：

  • SDK 日志文件包括：agorasdk.log、agorasdk.1.log、agorasdk.2.log、agorasdk.3.log 和 agorasdk.4.log。

  • API 调用日志文件包括：agoraapi.log、agoraapi.1.log、agoraapi.2.log、agoraapi.3.log 和 agoraapi.4.log。

  • 每个日志文件的默认大小为 2,048 KB，采用 UTF-8 编码。

  • SDK 会将最新日志写入 agorasdk.log 或 agoraapi.log 文件。

  • 当 agorasdk.log 写满时，SDK 会按以下顺序处理日志文件：

    1. 删除 agorasdk.4.log（如果存在）。
    2. 将 agorasdk.3.log 重命名为 agorasdk.4.log。
    3. 将 agorasdk.2.log 重命名为 agorasdk.3.log。
    4. 将 agorasdk.1.log 重命名为 agorasdk.2.log。
    5. 创建新的 agorasdk.log 文件。

  • agoraapi.log 的覆盖规则与 agorasdk.log 相同。

注： 该方法仅用于设置 agorasdk.log 文件的大小，不影响 agoraapi.log 文件。

参数

参数名描述
fileSizeInKBytes

agorasdk.log 文件的大小（单位：KB）。取值范围为 [128, 20480]。默认值为 2,048 KB。如果设置值小于 128 KB，SDK 会自动调整为 128 KB；如果设置值大于 20,480 KB，SDK 会自动调整为 20,480 KB。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setLogFilter

设置 SDK 的日志输出等级。

C++
virtual int setLogFilter(unsigned int filter) = 0;

废弃

该方法已废弃，请改用 initialize 中的 logConfig 设置日志过滤等级。

你可以使用一个或多个日志过滤等级的组合来设置 SDK 的日志输出等级。日志等级的顺序为 LOG_FILTER_OFF、LOG_FILTER_CRITICAL、LOG_FILTER_ERROR、LOG_FILTER_WARN、LOG_FILTER_INFO 和 LOG_FILTER_DEBUG。选择某个等级后，将输出该等级及更高级别的日志。例如，如果将日志等级设置为 LOG_FILTER_WARN，你将看到 LOG_FILTER_CRITICAL、LOG_FILTER_ERROR 和 LOG_FILTER_WARN 等级的日志。

参数

参数名描述
filter

SDK 的日志输出等级，详见 LOG_FILTER_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setLogLevel

设置 SDK 的输出日志等级。

C++
virtual int setLogLevel(commons::LOG_LEVEL level) = 0;

废弃

该方法已废弃，请改用 initialize 中的 context 设置日志等级。

选择一个日志等级，以查看该等级及以上的日志信息。

参数

参数名描述
level

日志等级，详见 LOG_LEVEL。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setParameters

通过配置 JSON 选项为 SDK 提供技术预览功能或特殊定制。

C++
virtual int setParameters(const char* parameters) = 0;

请联系技术支持以获取 JSON 配置方法。

参数

参数名描述
parameters

指向 JSON 字符串格式的参数集合。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setRemoteSubscribeFallbackOption

根据网络状况设置订阅端的视频流回退选项。

C++
virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0;

不稳定的网络会影响视频通话或互动直播中的音视频质量。你可以通过设置 option 为 STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW 或 STREAM_FALLBACK_OPTION_AUDIO_ONLY，在下行网络无法同时支持音视频时，SDK 会自动将视频从高质量流切换为低质量流，或关闭视频以保障音频质量。SDK 会持续监测网络状况，并在网络改善时恢复音视频流的订阅。

相关回调

当订阅的视频流回退为纯音频流，或从纯音频流恢复为音视频流时，SDK 会触发 onRemoteSubscribeFallbackToAudioOnly 回调。

参数

参数名描述
option

订阅流的回退选项，详见 STREAM_FALLBACK_OPTIONS。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

startEchoTest

启动音视频通话回路测试。

C++
virtual int startEchoTest(const EchoTestConfiguration& config) = 0;

你可以调用该方法进行音视频通话回路测试，用于检测本地音视频设备以及上下行网络是否正常。开始测试后，你需要发出声音或面对摄像头，音频或视频将在约两秒后回放。

  • 如果音频播放正常，说明音频设备和上下行网络正常。
  • 如果视频播放正常，说明视频设备和上下行网络正常。

注：

  • 在频道中调用该方法时，请确保未发布任何音视频流。
  • 调用该方法后需调用 stopEchoTest 结束测试，否则你将无法进行下一次音视频通话回路测试，也无法加入频道。
  • 在直播场景中，该方法仅适用于主播角色。

调用时机

你可以在加入频道前或加入频道后调用该方法。

参数

参数名描述
config

音视频通话回路测试的配置。详见 EchoTestConfiguration。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

startLastmileProbeTest

启动 Last-mile 网络探测测试。

C++
virtual int startLastmileProbeTest(const LastmileProbeConfig& config) = 0;

调用时序：在收到 onLastmileQuality 和 onLastmileProbeResult 回调前，不要调用其他方法，否则可能会中断这些回调。 相关回调：成功调用该方法后，SDK 会依次触发以下两个回调：

  • onLastmileQuality：SDK 会在约两秒内根据网络状况触发该回调。该回调用于评估网络质量，更贴近用户体验。
  • onLastmileProbeResult：SDK 会在约 30 秒内根据网络状况触发该回调。该回调返回网络状况的实时统计数据，更加客观。

参数

参数名描述
config

Last-mile 网络探测测试的配置。详见 LastmileProbeConfig。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

stopEchoTest

停止音频通话测试。

C++
virtual int stopEchoTest() = 0;

调用 startEchoTest 后，必须调用该方法结束测试，否则无法进行下一次音视频通话回路测试，也无法加入频道。

返回值

  • 0：方法调用成功。

  • < 0：方法调用失败。详见错误码了解详情和解决建议。

    • -5（ERR_REFUSED）：停止回声测试失败，可能未在运行中。

所属接口类

stopLastmileProbeTest

停止 Last-mile 网络探测测试。

C++
virtual int stopLastmileProbeTest() = 0;

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

onConnectionBanned

连接被声网服务器封禁时触发的回调。

C++
virtual void onConnectionBanned() __deprecated {}

废弃

该方法已废弃，请改用 onConnectionStateChanged。

所属接口类

onConnectionInterrupted

onConnectionInterrupted 回调。

C++
virtual void onConnectionInterrupted() __deprecated {}

废弃

该方法已废弃，请改用 onConnectionStateChanged。

当 SDK 建立连接后与服务器断开超过 4 秒时，会触发该回调。触发后，SDK 会尝试重新连接服务器。你可以通过该回调实现弹窗提醒功能。

注： onConnectionInterrupted 与 onConnectionLost 的区别如下：

  • 当 SDK 成功加入频道后与服务器断开连接超过 4 秒时，会触发 onConnectionInterrupted 回调。
  • 无论是否加入频道，当 SDK 与服务器断开连接超过 10 秒时，会触发 onConnectionLost 回调。

如果 SDK 在与声网边缘服务器断开连接 20 分钟后仍未重新加入频道，则停止重连。

触发时机

当 SDK 与服务器的连接中断超过 4 秒时触发。

所属接口类

onConnectionLost

onConnectionLost 回调。当 SDK 与声网边缘服务器的连接中断后 10 秒内无法重新连接时触发。

C++
virtual void onConnectionLost() {}

调用 joinChannel 方法后，如果 SDK 与声网边缘服务器的连接中断，并在 10 秒内无法重新连接，则触发该回调。无论此时是否在频道中，都会触发该回调。如果在断开连接后 20 分钟内仍无法重新加入频道，SDK 将停止尝试重新加入。

触发时机

当 SDK 与声网边缘服务器的连接中断后 10 秒内无法重新连接时触发。

所属接口类

onConnectionStateChanged

网络连接状态发生变化时触发的回调。

C++
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)

该回调在网络连接状态发生变化时触发，报告当前的连接状态以及导致状态变化的原因。

参数

参数名描述
state

当前的连接状态。详见 CONNECTION_STATE_TYPE。

reason

连接状态变化的原因。详见 CONNECTION_CHANGED_REASON_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onEncryptionError

报告内置加密错误的回调。

C++
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)

调用 enableEncryption 启用加密功能后，如果在发送端或接收端的加密或解密过程中发生错误，SDK 会触发该回调。

参数

参数名描述
errorType

错误类型，详见 ENCRYPTION_ERROR_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onLastmileProbeResult

上行和下行 Last-mile 网络探测结果回调。

C++
virtual void onLastmileProbeResult(const LastmileProbeResult& result)

调用 startLastmileProbeTest 后，SDK 会在 30 秒内触发该回调。

参数

参数名描述
result

上行和下行 Last-mile 网络探测测试结果。详见 LastmileProbeResult。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onLastmileQuality

报告本地用户的 Last-mile 网络质量回调。

C++
virtual void onLastmileQuality(int quality) { (void)quality; }

该回调在加入频道前触发，用于报告本地用户与声网边缘服务器之间连接的网络质量（即 last-mile 网络状况）。调用 startLastmileProbeTest 后，SDK 会触发该回调。

参数

参数名描述
quality

Last-mile 网络质量，详见 QUALITY_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onMultipathStats

多路径传输统计信息的回调。

C++
virtual void onMultipathStats(const MultipathStats& stats)

自从

自 v4.6.0 版本新增。

触发时机

该回调在你将 enableMultipath 设置为 true 以启用多路径传输后触发。

参数

参数名描述
stats

多路径传输统计信息。详见 MultipathStats。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onNetworkQuality

报告频道中每个用户的 Last-mile 网络质量。

C++
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)

该回调报告频道中每个用户的 Last-mile 网络状况。Last-mile 指的是本地设备与声网边缘服务器之间的连接。SDK 每两秒触发一次该回调。如果频道中有多个用户，SDK 会触发多次该回调。该回调通过在频道内发送和接收广播数据包来反馈网络质量。为避免广播风暴导致频道内数据传输量过大，该回调默认最多同时反馈 4 个远端用户的网络质量。

注： txQuality 在用户未发送流时为 UNKNOWN；rxQuality 在用户未接收流时为 UNKNOWN。

参数

参数名描述
uid

用户 ID。用于指定要报告网络质量的用户。如果该值为 0，则表示报告本地用户的网络质量。

txQuality

用户的上行网络质量评分，依据上行网络的传输码率、丢包率、平均往返时延（RTT）和抖动情况评估。该评分有助于判断当前上行网络是否能支持所选的视频编码器配置。例如，1000 Kbps 的上行网络可能足以支持分辨率为 640 × 480、帧率为 15 fps 的视频帧，但可能不足以支持高于 1280 × 720 的分辨率。详见 QUALITY_TYPE。

rxQuality

用户的下行网络质量评分，依据下行网络的丢包率、平均 RTT 和抖动情况评估。详见 QUALITY_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onNetworkTypeChanged

本地网络类型发生变化时触发的回调。

C++
virtual void onNetworkTypeChanged(NETWORK_TYPE type)

你可以通过该回调获取连接状态及其变化原因。当网络连接中断时，该回调可用于判断中断是由于网络类型变化还是网络状况不佳导致的。

参数

参数名描述
type

本地网络连接的类型，详见 NETWORK_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onPermissionError

报告 SDK 无法获取设备权限。

C++
virtual void onPermissionError(PERMISSION_TYPE permissionType)

该回调在 SDK 无法获取设备权限时触发，用于报告无法获取的设备权限类型。

参数

参数名描述
permissionType

设备权限类型，详见 PERMISSION_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onPermissionGranted

权限被授予时的回调。

C++
virtual void onPermissionGranted(agora::rtc::PERMISSION_TYPE permissionType) {}

参数

参数名描述
permissionType

权限类型，详见 PERMISSION_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onProxyConnected

代理连接状态回调。

C++
virtual void onProxyConnected(const char* channel, uid_t uid, PROXY_TYPE proxyType, const char* localProxyIp, int elapsed)

onProxyConnected 回调用于监听 SDK 连接代理的状态。当用户调用 setCloudProxy 并成功加入频道后，SDK 会触发该回调，报告用户 ID、连接的代理类型，以及从调用 joinChannel 到触发该回调所经历的时间（毫秒）。

参数

参数名描述
channel

频道名。

uid

用户 ID。

proxyType

连接的代理类型，详见 PROXY_TYPE。

localProxyIp

预留参数，暂未使用。

elapsed

从调用 joinChannel 到触发该回调所经历的时间，单位为毫秒。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onReceiveAudioPacket

当本地用户接收到音频包时触发的回调。

C++
virtual bool onReceiveAudioPacket(Packet& packet) = 0;

参数

参数名描述
packet

接收到的音频包。详见 Packet。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

true：音频包接收成功。 false：音频包被丢弃。

所属接口类

onReceiveVideoPacket

本地用户接收到视频数据包时触发的回调。

C++
virtual bool onReceiveVideoPacket(Packet& packet) = 0;

参数

参数名描述
packet

接收到的视频数据包。详见 Packet。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

true：视频数据包接收成功。 false：视频数据包被丢弃。

所属接口类

onRemoteSubscribeFallbackToAudioOnly

远端媒体流因网络变化在音频流与视频流之间切换时触发的回调。

C++
virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover)

如果你调用了 setRemoteSubscribeFallbackOption 并将 option 设置为 STREAM_FALLBACK_OPTION_AUDIO_ONLY，SDK 会在以下情况下触发该回调：

  • 下行网络条件较差，已订阅的视频流被降级为纯音频流。
  • 下行网络条件改善，已订阅的流恢复为视频流。

注： 当远端媒体流因网络较弱切换为视频小流时，你可以通过 onRemoteVideoStats 回调监控高质量与视频小流之间的切换。

参数

参数名描述
uid

远端用户 ID。

isFallbackOrRecover

是否因网络变化导致媒体流切换：

  • true：由于网络条件差，已订阅的媒体流降级为纯音频流。
  • false：网络条件改善后，已订阅的媒体流恢复为视频流。
表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

onSendAudioPacket

本地用户发送音频包时触发的回调。

C++
virtual bool onSendAudioPacket(Packet& packet) = 0;

参数

参数名描述
packet

发送的音频包。详见 Packet。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

true：音频包发送成功。 false：音频包被丢弃。

所属接口类

onSendVideoPacket

本地用户发送视频数据包时触发的回调。

C++
virtual bool onSendVideoPacket(Packet& packet) = 0;

参数

参数名描述
packet

发送的视频数据包。详见 Packet。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

true：视频数据包发送成功。 false：视频数据包被丢弃。

所属接口类

onUplinkNetworkInfoUpdated

上行网络信息发生变化时触发的回调。

C++
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo& info)

注： 该回调仅适用于将外部编码的 H.264 格式视频数据推送至 SDK 的场景。

参数

参数名描述
info

上行网络信息。详见 UplinkNetworkInfo。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利