网络及其他
介绍跟网络相关的方法以及其他方法和回调。
Complain
投诉通话质量。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int Complain(FString callId, FString description);
详情
该方法允许用户就通话质量进行投诉。需要在离开频道后调用。
参数
- callId
- 通话 ID。你可以通过调用 GetCallId 获取该参数。
- description
- (非必选项)通话的描述。长度应小于 800 字节。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2: 参数无效。
- -3:SDK 尚未准备好。可能的原因有:
- IRtcEngine 初始化失败。请重新初始化 IRtcEngine。
- 调用方法时用户尚未加入频道。请检查方法的调用逻辑。
- 调用 Rate 或 Complain 方法时用户尚未离开频道。请检查方法的调用逻辑。
- 请检查是否已开启音频模块。请检查程序集完整性。
EnableEncryption
开启或关闭内置加密。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int EnableEncryption(bool enabled, const FEncryptionConfig& config);
详情
在安全要求较高的场景下,建议你在加入频道前,调用本方法开启内置加密。
同一频道内所有用户必须使用相同的加密模式和密钥。用户离开频道后,SDK 会自动关闭加密。如需重新开启加密,你需要在用户再次加入频道前调用该方法。
参数
- enabled
- 是否开启内置加密:
- true: 开启内置加密。
- false: 关闭内置加密。
- config
- 配置内置加密模式和密钥。详见 FEncryptionConfig。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败
- -2: 调用了无效的参数。需重新指定参数。
- -4: 设置的加密模式不正确或加载外部加密库失败。需检查枚举值是否正确或重新加载外部加密库。
- -7: SDK 尚未初始化。需在调用 API 之前已创建 IRtcEngine 对象并完成初始化。
EnableWebSdkInteroperability
打开与 Web SDK 的互通(仅在直播场景适用)。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int EnableWebSdkInteroperability(bool enabled);
详情
该方法打开或关闭与 Web SDK 的互通。如果有用户通过 Web SDK 加入频道,请确保调用该方法,否则 Web 端用户看 Native 端的画面会是黑屏。
该方法仅在直播场景下适用,通信场景下默认互通是打开的。
参数
- enabled
- 是否打开与 Web SDK 的互通:
true
: 打开互通。false
: (默认) 关闭互通。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
GetCallId
获取通话 ID。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int GetCallId(FString& callId);
详情
客户端在每次加入频道后会生成一个对应的 callId,标识该客户端的此次通话。有些方法,如 Rate、Complain 等,需要在通话结束后调用,向 SDK 提交反馈。这些方法中需要填入指定的 callId 参数。
参数
- callId
- 输出参数,当前的通话 ID。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
GetConnectionState
获取当前网络连接状态。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
ECONNECTION_STATE_TYPE GetConnectionState();
详情
该方法在加入频道前后都能调用。
返回值
当前网络连接状态。详见 ECONNECTION_STATE_TYPE。
所属接口类GetConnectionStateEx
获取当前网络连接状态。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
ECONNECTION_STATE_TYPE GetConnectionStateEx(const FRtcConnection& connection);
详情
该方法在加入频道前后都能调用。
参数
- connection
- Connection 信息。详见 FRtcConnection。
返回值
当前网络连接状态。详见 ECONNECTION_STATE_TYPE。
所属接口类GetCurrentMonotonicTimeInMs
获取 SDK 当前的 Monotonic Time。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int64 GetCurrentMonotonicTimeInMs();
详情
Monotonic Time 是指一个单调递增的时间序列,它的值会随着时间的推移而增加。单位为毫秒。
在自定义视频采集、自定义音频采集场景中,为确保音视频同步,声网建议你调用该方法获取 SDK 当前的 Monotonic Time 后,将该值传入采集的视频帧(FVideoFrame)、音频帧(FAudioFrame)的时间戳参数。
返回值
- ≥0: 方法调用成功,返回 SDK 当前的 Monotonic Time(毫秒)。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
GetErrorDescription
GetNetworkType
获取本地网络连接类型。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int GetNetworkType();
详情
你可以在任何阶段通过该方法获取正在使用的网络类型。
返回值
- ≥ 0: 方法调用成功,返回本地网络连接类型。
- 0:网络连接已断开。
- 1:网络类型为 LAN。
- 2:网络类型为 Wi-Fi(包含热点)。
- 3:网络类型为 2G 移动网络。
- 4:网络类型为 3G 移动网络。
- 5:网络类型为 4G 移动网络。
- 6:网络类型为 5G 移动网络。
- < 0: 方法调用失败,返回错误码。
- -1:网络连接类型未知。
GetNtpWallTimeInMs
GetVersion
QueryInterface
获取指定接口类的指针。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
UObject* QueryInterface(EINTERFACE_ID_TYPE iid);
参数
- iid
- 想要获取的接口类 ID。详见 EINTERFACE_ID_TYPE。
- inter
- 输出参数。指定接口的对象指针。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
Rate
给通话评分。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int Rate(FString callId, int rating, FString description);
详情
参数
- callId
- 通话 ID。你可以通过调用 GetCallId 获取该参数。
- rating
- 给通话的评分,最低 1 分,最高 5 分,如超过这个范围,SDK 会返回 -2(
ERR_INVALID_ARGUMENT
) 错误。 - description
- (非必选项)给通话的描述。长度应小于 800 字节。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2(
ERR_INVALID_ARGUMENT
)。 - -3(
ERR_NOT_READY
)。
- -2(
RegisterPacketObserver
注册数据包观测器。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int RegisterPacketObserver(UIPacketObserver* observer);
详情
该方法注册数据包观测器 (Packet Observer)。在 SDK 发送/接收(语音、视频)网络包时,会回调 IPacketObserver 定义的接口,App 可用此接口对数据做处理,例如加解密。
- 处理后发送到网络的包大小不应超过 1200 字节,否则有可能发送失败。
- 若需调用此方法,需确保接收端和发送端都调用此方法,否则会出现未定义行为(例如音频无声或视频黑屏)。
- 若在直播场景下使用旁路推流、录制,不建议调用此方法。
- 你需要在加入频道前调用该方法。
参数
- observer
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SendCustomReportMessage
发送自定义上报消息。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SendCustomReportMessage(FString id, FString category, FString event, FString label, int value);
详情
声网提供自定义数据上报和分析服务。该服务当前处于免费内测期。内测期提供的能力为 6 秒内最多上报 10 条数据,每条自定义数据不能超过 256 字节,每个字符串不能超过 100 字节。如需试用该服务,请联系 sales@agora.io 开通并商定自定义数据格式。
所属接口类SendCustomReportMessageEx
自定义数据上报和分析服务。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SendCustomReportMessageEx(FString id, FString category, FString event, FString label, int value, const FRtcConnection& connection);
详情
声网提供自定义数据上报和分析服务。该服务当前处于免费内测期。内测期提供的能力为 6 秒内最多上报 10 条数据,每条自定义数据不能超过 256 字节,每个字符串不能超过 100 字节。如需试用该服务,请联系 sales@agora.io 开通并商定自定义数据格式。
所属接口类SetAVSyncSource
设置发流端音画同步。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetAVSyncSource(FString channelId, int64 uid);
详情
同一用户可能使用两个设备分别发送音频流和视频流,为保证接收端听到和看到的音频和视频的时间同步性,你可以在视频发送端调用该方法,并传入音频发送端的频道名、用户 ID。 SDK 会以发送的音频流的时间戳为基准进行自动调节发送的视频流,以保证即使在两个发送端的上行网络情况不一致(如分别使用 Wi-Fi 和 4G 网络)的情况下,也能让接收到的音视频具有时间同步性。
参数
- channelId
- 标识音频发送端所在频道的频道名。
- uid
- 音频发送端的用户 ID。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetCloudProxy
设置云代理服务。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetCloudProxy(ECLOUD_PROXY_TYPE proxyType);
详情
当用户的网络访问受到防火墙限制时,你需要将声网提供的 IP 和端口号添加到防火墙白名单,然后调用该方法开启云代理,并通过 proxyType 参数设置云代理类型。
成功连接云代理后,SDK 会触发 FOnConnectionStateChanged (CONNECTION_STATE_CONNECTING, CONNECTION_CHANGED_SETTING_PROXY_SERVER) 回调。
如果你想关闭已设置的 Force UDP 或 Force TCP 云代理,请调用 SetCloudProxy(NONE_PROXY)
。
如果你想更改已设置的云代理类型,请先调用 SetCloudProxy(NONE_PROXY)
,再调用 SetCloudProxy 并传入你期望的 proxyType 值。
- 建议你在频道外调用该方法。
- 如果用户处于内网防火墙环境下,使用 Force UDP 云代理时,旁路推流和跨频道媒体流转发功能不可用。
- 使用 Force UDP 云代理时,调用 StartAudioMixing 方法时无法播放 HTTP 协议的在线音频文件。旁路推流和跨频道媒体流转发功能会使用 TCP 协议的云代理。
参数
- proxyType
云代理类型,详见 ECLOUD_PROXY_TYPE。
该参数为必填参数,如果你不赋值,SDK 会报错。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2: 传入的参数无效。
- -7: SDK 尚未初始化。
SetEncryptionMode
启用内置的加密方案。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetEncryptionMode(FString encryptionMode);
详情
SDK 支持内置加密方案,默认支持 AES-128-GCM。如需采用其他加密方案,可以调用本方法。同一频道内的所有用户必须设置相同的加密方式和 secret 才能进行通话。关于这几种加密方式的区别,请参考 AES 加密算法的相关资料。
参数
- encryptionMode
- 加密模式:
- "
aes-128-xts
": 128 位 AES 加密,XTS 模式; - "
aes-128-ecb
": 128 位 AES 加密,ECB 模式; - "
aes-256-xts
": 256 位 AES 加密,XTS 模式; - "
sm4-128-ecb
": 128 位 SM4 加密,ECB 模式; - "
aes-128-gcm
": 128 位 AES 加密,GCM 模式; - "
aes-256-gcm
": 256 位 AES 加密,GCM 模式; - "": 设置为空字符串时,默认使用加密方式 "
aes-128-gcm
"。
- "
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetEncryptionSecret
启用内置加密,并设置数据加密密码。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetEncryptionSecret(FString secret);
详情
在加入频道之前, App 需调用该方法指定 secret 来启用内置的加密功能,同一频道内的所有用户应设置相同的 secret。 当用户离开频道时,该频道的 secret 会自动清除。如果未指定 secret 或将 secret 设置为空,则无法激活加密功能。
- 请不要在旁路推流时调用此方法。
- 为保证最佳传输效果,请确保加密后的数据大小不超过原始数据大小 + 16 字节。16 字节是 AES 通用加密模式下最大填充块大小。
参数
- secret
- 加密密码。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetLocalAccessPoint
配置与声网私有媒体服务器 Native 接入模块的连接。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetLocalAccessPoint(const FLocalAccessPointConfiguration& config);
详情
成功部署声网私有媒体服务器并在内网终端集成 RTC SDK v4.x 后,你可以调用该方法指定 Local Access Point,给 SDK 分配 Native 接入模块。
- 该方法仅在部署声网混合云方案后生效。你可以联系 sales@agora.io 了解和部署声网混合云。
- 该方法需要在加入频道前调用。
参数
- config
- Local Access Point 配置。详见 FLocalAccessPointConfiguration。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetLogFile
设置日志文件
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetLogFile(FString filePath);
详情
logConfig
参数设置日志文件路径 。设置 SDK 的输出 log 文件。SDK 运行时产生的所有 log 将写入该文件。App 必须保证指定的目录存在而且可写。
如需调用本方法,请在调用 Initialize 方法初始化 IRtcEngine 对象后立即调用,否则输出日志可能不完整。
参数
- filePath
- 日志文件的完整路径。该日志文件为 UTF-8 编码。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetLogFileSize
设置 SDK 输出的日志文件的大小。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetLogFileSize(int fileSizeInKBytes);
详情
logConfig
参数设置日志文件大小。默认情况下,SDK 会生成 5 个 SDK 日志文件和 5 个 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
。 - 每个 SDK 日志文件的默认大小为 1,024 KB;API 调用日志文件的默认大小为 2,048 KB。日志文件均为 UTF-8 编码。
- 最新的日志永远写在
agorasdk.log
和agoraapi.log
中。 - 当
agorasdk.log
写满后,SDK 会按照以下顺序对日志文件进行操作:- 删除
agorasdk.4.log
文件(如有)。 - 将
agorasdk.3.log
重命名为agorasdk.4.log
。 - 将
agorasdk.2.log
重命名为agorasdk.3.log
。 - 将
agorasdk.1.log
重命名为agorasdk.2.log
。 - 新建
agorasdk.log
文件。
- 删除
agoraapi.log
文件的覆盖规则与agorasdk.log
相同。
该方法仅用于设置 agorasdk.log
文件的大小,对agoraapi.log
不生效。
参数
- fileSizeInKBytes
- 单个
agorasdk.log
日志文件的大小,单位为 KB,取值范围为 [128,20480],默认值为 2,048 KB。如果你将fileSizeInKByte
设为小于 128 KB,SDK 会自动调整到 128 KB;如果你将fileSizeInKByte
设为大于 20,480 KB,SDK 会自动调整到 20,480 KB。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetLogFilter
设置日志输出等级。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetLogFilter(int filter);
详情
该方法设置 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
- 日志过滤等级。
- LOG_FILTER_OFF (0):不输出日志信息。
- LOG_FILTER_DEBUG (0x80f):输出所有 API 日志信息。如果你想获取最完整的日志,可以将日志级别设为该等级。
- LOG_FILTER_INFO (0x0f):输出 LOG_FILTER_CRITICAL、LOG_FILTER_ERROR、LOG_FILTER_WARN 和 LOG_FILTER_INFO 级别的日志信息。建议你将日志级别设为该等级。
- LOG_FILTER_WARN (0x0e):输出 LOG_FILTER_CRITICAL、LOG_FILTER_ERROR 和 LOG_FILTER_WARN 级别的日志信息。
- LOG_FILTER_ERROR (0x0c):输出 LOG_FILTER_CRITICAL 和 LOG_FILTER_ERROR 级别的日志信息。
- LOG_FILTER_CRITICAL (0x08):输出 LOG_FILTER_CRITICAL 级别的日志信息。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetLogLevel
设置 SDK 的日志输出级别。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int SetLogLevel(ELOG_LEVEL level);
详情
选择一个级别,你就可以看到该级别的日志信息。
参数
- level
- 日志级别: ELOG_LEVEL。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
SetParameters
StartEchoTest
开始音视频通话回路测试。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int StartEchoTest(const FEchoTestConfiguration& config);
详情
为测试用户本地发流、收流是否正常,你可以调用该方法进行音视频通话回路测试,即测试系统的音视频设备和用户的上下行网络是否正常。
- 该方法在加入频道前后均可调用。在频道内调用时,需确保当前没有发布音视频流。
- 调用该方法后,必须调用 StopEchoTest 结束测试,否则该用户无法进行下一次音视频通话回路测试, 也无法加入频道。
- 直播场景下,该方法仅能由主播调用。
参数
- config
- 音视频通话回路测试的配置。详见 FEchoTestConfiguration。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
StartLastmileProbeTest
开始通话前网络质量探测。
UFUNCTION(BlueprintCallable, Category = "Agora|RtcEngineProxy")
int StartLastmileProbeTest(const FLastmileProbeConfig& config);
详情
开始通话前网络质量探测,向用户反馈上下行网络的带宽、丢包、网络抖动和往返时延数据。
- FOnLastmileQuality,视网络情况约 2 秒内返回。该回调通过打分反馈上下行网络质量,更贴近用户的主观感受。
- FOnLastmileProbeResult,视网络情况约 30 秒内返回。该回调通过具体数据反馈上下行网络质量,更加客观。
该方法需要在加入频道前调用,用于判断和预测目前的上行网络质量是否足够好。
- 调用该方法后,在收到 FOnLastmileQuality 和 FOnLastmileProbeResult 回调之前请不要调用其他方法,否则可能会由于 API 操作过于频繁导致此方法无法执行。
- 在直播场景中,如果本地用户为主播,请勿加入频道后调用该方法。
参数
- config
- Last mile 网络探测配置,详见 FLastmileProbeConfig。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
StopEchoTest
StopLastmileProbeTest
FOnConnectionBanned
FOnConnectionInterrupted
网络连接中断回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnConnectionInterrupted);
详情
- FOnConnectionInterrupted 回调一定是发生在成功加入频道后,且 SDK 刚失去和服务器连接超过 4 秒时触发。
- FOnConnectionLost 回调是无论是否成功加入频道,只要 10 秒内和服务器无法建立连接都会触发。
FOnConnectionLost
网络连接中断,且 SDK 无法在 10 秒内连接服务器回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnConnectionLost);
详情
SDK 在调用 JoinChannel 后,无论是否加入成功,只要 10 秒和服务器无法连接就会触发该回调。如果 SDK 在断开连接后,20 分钟内还是没能重新加入频道,SDK 会停止尝试重连。
所属接口类FOnConnectionStateChanged
网络连接状态已改变回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnConnectionStateChanged, ECONNECTION_STATE_TYPE, state, ECONNECTION_CHANGED_REASON_TYPE, reason);
详情
该回调在网络连接状态发生改变的时候触发,并告知用户当前的网络连接状态和引起网络状态改变的原因。
参数
- state
当前网络连接状态。详见 ECONNECTION_STATE_TYPE。
- reason
引起当前网络连接状态改变的原因。详见 ECONNECTION_CHANGED_REASON_TYPE。
FOnEncryptionError
内置加密出错回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnEncryptionError, EENCRYPTION_ERROR_TYPE, errorType);
详情
调用 EnableEncryption 开启加密后, 如果发流端、收流端出现加解密出错,SDK 会触发该回调。
参数
- errorType
- 错误类型,详见 EENCRYPTION_ERROR_TYPE。
FOnLastmileProbeResult
通话前网络上下行 Last mile 质量探测报告回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnLastmileProbeResult, const FLastmileProbeResult&, result);
详情
在调用 StartLastmileProbeTest 之后,SDK 会在约 30 秒内返回该回调。
参数
- result
- 上下行 Last mile 质量探测结果。 详见: FLastmileProbeResult。
FOnLastmileQuality
网络上下行 last mile 质量报告回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnLastmileQuality, int, quality);
详情
该回调描述本地用户在加入频道前的 last mile 网络探测的结果,其中 last mile 是指设备到声网边缘服务器的网络状态。
加入频道前,调用 StartLastmileProbeTest 之后,SDK 触发该回调报告本地用户在加入频道前的 last mile 网络探测的结果。
参数
- quality
- Last mile 网络质量。
- QUALITY_UNKNOWN (0):质量未知。
- QUALITY_EXCELLENT (1):质量极好。
- QUALITY_GOOD (2):用户主观感觉和极好差不多,但码率可能略低于极好。
- QUALITY_POOR (3):用户主观感受有瑕疵但不影响沟通。
- QUALITY_BAD (4):勉强能沟通但不顺畅。
- QUALITY_VBAD (5):网络质量非常差,基本不能沟通。
- QUALITY_DOWN (6):网络连接断开,完全无法沟通。
FOnNetworkQuality
通话中每个用户的网络上下行 last mile 质量报告回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FOnNetworkQuality, int64, uid, int, txQuality, int, rxQuality);
详情
该回调描述每个用户在通话中的 last mile 网络状态,其中 last mile 是指设备到声网边缘服务器的网络状态。
该回调每 2 秒触发一次。如果远端有多个用户,该回调每 2 秒会被触发多次。
UNKNOWN
;用户不收流时,rxQuality 为 UNKNOWN
。参数
- uid
用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。如果当 uid 为 0 时,返回的是本地用户的网络质量。
- txQuality
- 该用户的上行网络质量,基于发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量,帮助判断是否可以支持当前设置的视频编码属性。 假设上行码率是 1000 Kbps,那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题,但是支持 1280 × 720 的分辨率就会有困难。
- QUALITY_UNKNOWN (0):质量未知。
- QUALITY_EXCELLENT (1):质量极好。
- QUALITY_GOOD (2):用户主观感觉和极好差不多,但码率可能略低于极好。
- QUALITY_POOR (3):用户主观感受有瑕疵但不影响沟通。
- QUALITY_BAD (4):勉强能沟通但不顺畅。
- QUALITY_VBAD (5):网络质量非常差,基本不能沟通。
- QUALITY_DOWN (6):网络连接断开,完全无法沟通。
- rxQuality
- 该用户的下行网络质量,基于下行网络的丢包率、平均往返延时和网络抖动计算。
- QUALITY_UNKNOWN (0):质量未知。
- QUALITY_EXCELLENT (1):质量极好。
- QUALITY_GOOD (2):用户主观感觉和极好差不多,但码率可能略低于极好。
- QUALITY_POOR (3):用户主观感受有瑕疵但不影响沟通。
- QUALITY_BAD (4):勉强能沟通但不顺畅。
- QUALITY_VBAD (5):网络质量非常差,基本不能沟通。
- QUALITY_DOWN (6):网络连接断开,完全无法沟通。
FOnNetworkTypeChanged
本地网络类型发生改变回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnNetworkTypeChanged, FENUMWRAP_NETWORK_TYPE, type);
详情
本地网络连接类型发生改变时,SDK 会触发该回调,并在回调中明确当前的网络连接类型。你可以通过该回调获取正在使用的网络类型;当连接中断时,该回调能辨别引起中断的原因是网络切换还是网络条件不好。
参数
- type
本地网络连接类型。详见 EENUMCUSTOM_NETWORK_TYPE。
FOnPermissionError
获取设备权限出错回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnPermissionError, EPERMISSION_TYPE, permissionType);
详情
无法获取设备权限时,SDK 会触发该回调,报告哪个设备的权限无法获取。
参数
- permissionType
- 设备权限类型。详见 EPERMISSION_TYPE。
FOnProxyConnected
代理连接状态回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FiveParams(FOnProxyConnected, FString, channel, int64, uid, EPROXY_TYPE, proxyType, FString, localProxyIp, int, elapsed);
详情
通过该回调你可以监听 SDK 连接代理的状态。例如,当用户调用 SetCloudProxy 设置代理并成功加入频道后,SDK 会触发该回调报告用户 ID、连接的代理类型和从调用 JoinChannel 到触发该回调经过的时间等。
参数
- channel
- 频道名称。
- uid
- 用户 ID
- proxyType
- 连接上的代理类型。详见 EPROXY_TYPE。
- localProxyIp
- 预留参数,暂不支持。
- elapsed
- 从调用 JoinChannel 到 SDK 触发该回调的经过的时间(毫秒)。
FOnReceiveAudioPacket
FOnReceiveVideoPacket
FOnSendAudioPacket
FOnSendVideoPacket
FOnUplinkNetworkInfoUpdated
上行网络信息变化回调。
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnUplinkNetworkInfoUpdated, const FUplinkNetworkInfo&, info);
详情
只有当上行网络信息发生变化时,SDK 才会触发该回调。
参数
- info
- 上行网络信息,详见 FUplinkNetworkInfo。