React Native API Reference

Parameters

• error: ErrorCode

  错误码。如果方法调用失败，会返回错误码 Error Code。

• api: string

  SDK 所调用的 API。

• result: string

  SDK 调用 API 的调用结果。

Returns void

Parameters

• state: AudioMixingStateCode

  混音音乐文件状态。详见 AudioMixingStateCode。

• reason: AudioMixingReason

  音乐文件播放状态改变的原因。详见 AudioMixingReason。

Returns void

Parameters

• uid: number

  用户 ID，指定是谁发的音频流。

• quality: number

  语音质量。

• delay: number

  音频包从发送端到接收端的延迟（毫秒）。包括声音采样前处理、网络传输、网络抖动缓冲引起的延迟。

• lost: number

  音频包从发送端到接收端的丢包率 (%)。

Returns void

Parameters

• routing: AudioOutputRouting

  音频输出路由。

Returns void

Parameters

• speakers: AudioVolumeInfo[]

  每个说话者的用户 ID 和音量信息的数组。

  • 在本地用户的回调中，此数组中包含以下成员:

  • uid = 0;

  • volume 等于 totalVolume，报告本地用户混音后的音量;

  • vad，报告本地用户人声状态。

  • 在远端用户的回调中，此数组中包含以下成员：

  • uid，表示每位说话者的用户 ID；

  • volume，表示各说话者混音后的音量；

  • vad = 0，人声检测对远端用户无效。

  如果报告的 speakers 数组为空，则表示远端此时没有人说话。

• totalVolume: number

  （混音后的）总音量，取值范围 [0,255]。

  • 在本地用户的回调中，totalVolume 为本地用户混音后的音量。
  • 在远端用户的回调中，totalVolume 为所有说话者混音后的总音量。

Returns void

Parameters

• oldRole: ClientRole

  切换前的角色。

• newRole: ClientRole

  切换后的角色。

Returns void

Parameters

• reason: ClientRoleChangeFailedReason

  切换用户角色失败的原因。详见 ClientRoleChangeFailedReason。

• currentRole: ClientRole

  当前的用户角色。详见 ClientRole。

Returns void

Parameters

• state: ConnectionStateType

  当前的网络连接状态。

• reason: ConnectionChangedReason

  引起当前网络连接状态发生改变的原因。

Returns void

Parameters

• result: ContentInspectResult

Returns void

Parameters

• elapsed: number

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

Returns void

Returns void

Parameters

• enabled: boolean

  是否启用麦克风：

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

Returns void

Parameters

• err: ErrorCode

  错误码。

Returns void

Parameters

• imageWidth: number

  摄像头采集画面的宽度 (px)。

• imageHeight: number

  摄像头采集画面的高度 (px)。

• faces: FacePositionInfo[]

  检测到的人脸信息，详见 FacePositionInfo。 检测到几张人脸，就会报告几个 AgoraFacePositionInfo 数组。数组长度可以为 0，表示没有检测到摄像头前出现人脸。

Returns void

Parameters

• isFallbackOrRecover: boolean

  本地推流已回退或恢复：

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

Returns void

Parameters

• uid: number

  远端用户的 ID。

• isFallbackOrRecover: boolean

  远端订阅流已回退或恢复：

  • true: 由于网络环境不理想，远端订阅流已回退为音频流。
  • false: 由于网络环境改善，订阅的音频流已恢复为音视频流。

Returns void

Parameters

• result: LastmileProbeResult

  上下行 Last mile 质量探测结果。

Returns void

Parameters

• state: AudioLocalState

  当前的本地音频状态。

• error: AudioLocalError

  本地音频出错原因。

Returns void

Parameters

• stats: LocalAudioStats

  本地音频统计数据。

Returns void

Parameters

• localVideoState: LocalVideoStreamState

  当前的本地视频状态。

• error: LocalVideoStreamError

  本地视频出错原因。

Returns void

Parameters

• stats: LocalVideoStats

  本地视频统计数据。

Returns void

Parameters

• pitchInHz: number

  本地用户的语音音调，单位为 Hz。

Returns void

Parameters

• code: ChannelMediaRelayEvent

  跨频道媒体流转发事件码。

Returns void

Parameters

• state: ChannelMediaRelayState

  跨频道媒体流转发状态。

• code: ChannelMediaRelayError

  跨频道媒体流转发出错的错误码。

Returns void

Parameters

• buffer: string

  T接收到的 Metadata 数据 Buffer 。

• uid: number

  发送该 Metadata 的远端用户的 ID 。

• timeStampMs: number

  接收到的 Metadata 的时间戳，单位为毫秒 。

Returns void

Parameters

• quality: NetworkQuality

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

Returns void

Parameters

• uid: number

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

• txQuality: NetworkQuality

  该用户的上行网络质量，基于上行视频的发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量，帮助判断是否可以支持当前设置的视频编码属性。假设上行码率是 1000 Kbps， 那么支持 640 × 480 的分辨率、30 fps 的帧率没有问题，但是支持 1280 x 720 的分辨率就会有困难。

• rxQuality: NetworkQuality

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

Returns void

Parameters

• type: NetworkType

  网络连接类型。

Returns void

Parameters

• channel: string

  频道名称。

• uid: number

  用户 ID。

• proxyType: ProxyType

  连接上的代理类型，详见 ProxyType。

• localProxyIp: string

  预留参数，暂不支持。

• elapsed: number

  从调用 joinChannel 到 SDK 触发该回调的经过的时间（毫秒）。

Returns void

Parameters

• info: RecorderInfo

  录制文件信息。详见 RecorderInfo。

Returns void

Parameters

• reason: number

  当前的录制状态：

  • -1：音视频流录制出错，错误原因详见 error 中的提示
  • 2：音视频流录制开始。
  • 3：音视频流录制停止。

• state: number

  录制状态出错的原因：

  • 0：一切正常。
  • 1：录制文件写入失败。
  • 2：没有可录制的音视频流或者录制的音视频流中断超过 5 秒。
  • 3：录制时长超出上限。
  • 4：录制配置改变。
  • 5：在通信场景下，捕捉到 3.0.0 之前版本的用户发送的音视频流。

Returns void

Parameters

• rect: Rect

  镜头内表示对焦的区域。

Returns void

Parameters

• uid: number

  发生音频状态改变的远端用户 ID。

• state: AudioRemoteState

  远端音频流状态。

• reason: AudioRemoteStateReason

  远端音频流状态改变的具体原因。

• elapsed: number

  从本地用户调用 joinChannel 方法到发生本事件经历的时间，单位为 ms。

Returns void

Parameters

• stats: RemoteAudioStats

  接收到的远端音频统计数据。

Returns void

Parameters

• uid: number

  视频状态发生改变的远端用户 ID。

• state: VideoRemoteState

  远端视频流状态。

• reason: VideoRemoteStateReason

  远端视频流状态改变的具体原因。

• elapsed: number

  从本地用户调用 joinChannel 方法到发生本事件经历的时间，单位为 ms。

Returns void

Parameters

• stats: RemoteVideoStats

  远端视频统计数据。

Returns void

Parameters

• info: AudioFileInfo

  音频文件信息。详见 AudioFileInfo。

• error: AudioFileInfoError

  信息获取状态。详见 AudioFileInfoError。

Returns void

Parameters

• stats: RtcStats

  通话相关的统计信息。

Returns void

Parameters

• url: string

  RTMP/RTMPS 推流 URL。

• eventCode: RtmpStreamingEvent

  RTMP/RTMPS 推流事件码。详见 RtmpStreamingEvent。

Returns void

Parameters

• url: string

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

• state: RtmpStreamingState

  当前的推流状态。

• errCode: RtmpStreamingErrorCode

  详细的推流错误信息。

Returns void

Parameters

• channel: string

  频道名。

• uid: number

  用户 ID。如果 uid 为 0，表示本地用户。

• filePath: string

  截图的本地保存路径。

• width: number

  图片宽度（px）。

• height: number

  图片高度（px）。

• errCode: number

  截图成功的提示或失败的原因：

  • 0：截图成功。
  • < 0：截图失败。
    • -1：写入文件失败或 JPEG 编码失败。
    • -2：takeSnapshot 方法调用成功后 1 秒内没有发现指定用户的视频流。

Returns void

Parameters

• soundId: number

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

Returns void

Parameters

• uid: number

  用户 ID。

• streamId: number

  数据流。

• data: string

  接收到的数据

Returns void

Parameters

• uid: number

  用户 ID。

• streamId: number

  数据流 ID。

• error: ErrorCode

  错误码。

• missed: number

  丢失的消息数量。

• cached: number

  数据流中断时，后面缓存的消息数量。

Returns void

Parameters

• channel: string

  频道名。

• oldState: StreamPublishState

  之前的发布状态，详见 StreamPublishState。

• newState: StreamPublishState

  当前的发布状态，详见 StreamPublishState。

• elapseSinceLastState: number

  两次状态变化时间间隔（毫秒）。

Returns void

Parameters

• channel: string

  频道名。

• uid: number

  远端用户的 ID。

• oldState: StreamSubscribeState

  之前的订阅状态，详见 StreamSubscribeState。

• newState: StreamSubscribeState

  当前的订阅状态，详见 StreamSubscribeState。

• elapseSinceLastState: number

  两次状态变化时间间隔（毫秒）。

Returns void

Parameters

• token: string

  即将服务失效的 Token。

Returns void

Parameters

• uid: number

  用户 ID，指定是哪个用户/主播的音频包/视频包。

• delay: number

  音频包/视频包从发送端到接收端的延时（毫秒）。

• lost: number

  音频包/视频包从发送端到接收端的丢包率 (%)。

• rxKBitRate: number

  远端音频包/视频包的接收码率（Kbps）。

Returns void

Parameters

• uid: number

  当前时间段声音最大的用户的 uid。 如果返回的 uid 为 0，则默认为本地用户。

Returns void

Parameters

• channel: string

  频道名。

• uid: number

  用户 ID。

• elapsed: number

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

Returns void

Parameters

• uid: number

  该参数在不同的回调中的含义如下：

  • UserJoined：新加入频道的远端用户/主播 ID。
  • FirstRemoteAudioFrame：发送音频帧的远端用户的 ID。
  • FirstRemoteAudioDecoded：发送音频帧的远端用户的 ID。
  • JoinChannelSuccess：用户 ID。
  • RejoinChannelSuccess：用户 ID。

• elapsed: number

  该参数在不同的回调中的含义如下：

  • UserJoined：从本地用户调用 joinChannel 或 setClientRole 到触发该回调的时间（毫秒）。
  • FirstRemoteAudioFrame：从调用 joinChannel 方法直至触发该回调的时间（毫秒）。
  • FirstRemoteAudioDecoded：从本地用户调用 joinChannel 方法直至触发该回调的时间（毫秒）。
  • JoinChannelSuccess：从本地用户调用 joinChannel 方法直至触发该回调的时间（毫秒）。
  • RejoinChannelSuccess：从本地用户开始重连到触发该回调的时间（毫秒）。

Returns void

Parameters

• uid: number

  用户 ID，提示是哪个用户的视频流。

• enabled: boolean

  是否启用视频功能：

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

Returns void

Parameters

• uid: number

  用户 ID，提示是哪个用户的视频流。

• muted: boolean

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

  • true: 该用户已暂停发送视频流。
  • false: 该用户已恢复发送视频流。

Returns void

Parameters

• url: string

  主播停止推流的 RTMP/RTMPS 地址。

Returns void

Parameters

• url: string

  RTMP/RTMPS 推流 URL。

• error: ErrorCode

  详细的错误信息。

Returns void

Parameters

• uid: number

  本地用户的 ID。

• userAccount: string

  本地用户的 User Account。

Returns void

Parameters

• uid: number

  远端用户 ID。

• userInfo: UserInfo

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

Returns void

Parameters

• uid: number

  主播 ID。

• reason: UserOfflineReason

  离线原因。

Returns void

Parameters

• uid: number

  远端用户 ID。

• enabled: boolean

  是否对远端视频成功开启超分辨率：

  • true：成功开启超分辨率。
  • false：未成功开启超分辨率

• reason: SuperResolutionStateReason

  超分辨率功能未成功开启的原因。详见 SuperResolutionStateReason。

Returns void

Parameters

• width: number

  本地渲染视频的宽（px）。

• height: number

  本地渲染视频的高（px）。

• elapsed: number

  从本地用户调用 joinChannel 方法直至该回调被触发的延迟（毫秒）。 如果在 joinChannel 之前 调用了 startPreview，则返回的是从调用 startPreview 直至该回调被触发的延迟（毫秒）。

Returns void

Parameters

• uid: number

  用户 ID，指定是哪个用户的视频流。

• width: number

  视频流宽（像素）。

• height: number

  视频流高（像素）。

• elapsed: number

  从本地用户调用 joinChannel 加入频道开始到发生此事件过去的时间（毫秒）。

Returns void

Parameters

• uid: number

  图像尺寸和旋转信息发生变化的用户 ID。 如果返回的 uid 为 0，则表示本地用户。

• width: number

  视频流的宽度（像素）。

• height: number

  视频流的高度（像素）。

• rotation: number

  旋转信息 [0,360)。

Returns void

Parameters

• enabled: boolean

  是否已成功开启虚拟背景：

  • true：成功开启虚拟背景。
  • false：未成功开启虚拟背景。

• reason: VirtualBackgroundSourceStateReason

  虚拟背景开启出错的原因或开启成功的提示。详见 VirtualBackgroundSourceStateReason。

Returns void

Parameters

• warn: WarningCode

  警告码。

Returns void

Parameters

• reason: WlAccReason

  Wi-Fi 连接质量不佳的原因，详见 WlAccReason。

• action: WlAccAction

  改善 Wi-Fi 连接质量的操作建议，详见 WlAccAction。

• wlAccMsg: string

  根据 action 的值提供的详细帮助信息：

  • 当 action 为 CloseToWIFI，该参数的值为 NULL。
  • 当 action 为 ConnectSSID，该参数的值为推荐用户连接的网络名称（SSID）。
  • 当 action 为 Check5G，该参数的值为开启路由器 5G 频道的操作步骤的链接。
  • 当 action 为 ModifySSID，该参数的值为修改网络名称（SSID）的操作步骤的链接。

Returns void

Parameters

• currentStats: WlAccStats

  当前的 Wi-Fi 加速效果。详见 WlAccStats。

• averageStats: WlAccStats

  自加入频道后平均的 Wi-Fi 加速效果。详见 WlAccStats。

Returns void