华为云用户手册

实时音视频 SPARKRTC-事件回调（HWRtcEngine）:onRemoteUserOffline

onRemoteUserOffline - (void)onRemoteUserOffline:(NSString*)roomId userId:(NSString*)userId reason:(NSInteger)reason; 【功能说明】远端用户离开当前房间，触发此回调。本端用户离开当前房间，会回调当前房间所有用户offline。【回调参数】 roomId：当前房间的房间ID。 userId：离开房间的远端用户ID。 reason：远端用户离线原因，预留参数。

实时音视频 SPARKRTC
实时音视频 SPARKRTC-事件回调（HWRtcEngine）:onFirstRemoteAuxiliaryStreamDecoded

onFirstRemoteAuxiliaryStreamDecoded - (void)onFirstRemoteAuxiliaryStreamDecoded:(NSString*)roomId userId:(NSString*)userId width:(int)width height:(int)height elapsed:(NSUInteger)elapsed; 【功能说明】引擎收到第一帧远端视频流并解码成功回调。【回调参数】 roomId：视频流对应的房间ID。 userId：视频流对应的用户ID。 width：视频流宽度。 height：视频流高度。 elapsed：本端订阅远端用户视频到首帧解码后消耗时间，单位ms。

实时音视频 SPARKRTC
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onLocalVideoStatsNotify

onLocalVideoStatsNotify virtual void onLocalVideoStatsNotify(const HRTCLocalVideoStats *localStats, unsigned int localStatsCount) 【功能说明】本地视频流详情，2s触发一次回调。【回调参数】 localStats：本地视频收流统计，具体请参见HRTCLocalVideoStats。 localStatsCount：localStats数组长度。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onRemoteVideoStatsNotify

onRemoteVideoStatsNotify virtual void onRemoteVideoStatsNotify(const HRTCRemoteVideoStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】远端视频流详情，2s触发一次回调。【回调参数】 remoteStats：远端视频收流统计，具体请参见HRTCRemoteVideoStats。 remoteStatsCount：remoteStats数组长度。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onTopActiveSpeaker

onTopActiveSpeaker public void onTopActiveSpeaker(String userId); 【功能说明】上报当前最活跃的用户userId。该回调主要用于0号会场场景（额外订阅uid为0的用户音频）。【回调参数】 userId：返回当前远端音量最活跃的用户ID。 0号会场模式下，SDK会持续监测（根据一定时间内用户音量大小）当前最活跃的用户，如果最活跃用户发生变化，则触发此回调并上报当前最活跃的用户userId。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onLocalVideoStateChangedNotify

onLocalVideoStateChangedNotify virtual void onLocalVideoStateChangedNotify(HRTCLocalVideoStreamState state, HRTCLocalVideoStreamStateReason reason) 【功能说明】本地视频状态改变，触发此回调。【回调参数】 state：本地视频状态，具体请参见HRTCLocalVideoStreamState。 reason：本地视频状态改变原因，具体请参见HRTCLocalVideoStreamStateReason。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onLocalAudioMutedStatusDetected

onLocalAudioMutedStatusDetected void onLocalAudioMutedStatusDetected(); 【功能说明】本端禁音检测回调。通过enableUserVolumeNotify开启并设置回调周期，禁音检测以6次音量回调为一个上报周期，enableUserVolumeNotify的参数建议设置成200（即最快1200ms触发禁音检测回调一次）。【回调参数】无

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onRemoteVideoStateChangedNotify

onRemoteVideoStateChangedNotify virtual void onRemoteVideoStateChangedNotify(const char* userId, HRTCRemoteVideoStreamState state, HRTCRemoteVideoStreamStateReason reason) 【功能说明】远端视频流状态变化回调。【回调参数】 userId：远端用户ID。 state：远端视频流状态，具体请参见HRTCRemoteVideoStreamState。 reason：远端视频流状态变化原因，具体请参见HRTCRemoteVideoStreamStateReason。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onRenderAuxiliaryExternalVideoFrame

onRenderAuxiliaryExternalVideoFrame virtual void onRenderAuxiliaryExternalVideoFrame(const char* roomId, HRTCMediaDirection direction, const char* userId, HRTCVideoFrame& videoFrame) 【功能说明】辅流自渲染回调。需要调用setAuxiliaryExternalVideoFrameOutput接口开启辅流自渲染，从而触发该回调。【回调参数】 roomId：房间ID。 direction：数据源，本地数据，远端数据，具体请参见HRTCMediaDirection。 userId：用户ID。 videoFrame：辅流详情，具体请参见HRTCVideoFrame。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onStartAllRemoteViewResult

onStartAllRemoteViewResult virtual void onStartAllRemoteViewResult(int errCode, const char* errMsg, unsigned int counts, const HR TCS etupRemoteViewResult* results) 【功能说明】批量选看结果回调。【回调参数】 errCode：错误码。 errMsg：错误信息。 counts：results数组大小。 results：批量选看结果，具体请参见HRT CS etupRemoteViewResult。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onStreamPublishStateChange

onStreamPublishStateChange void onStreamPublishStateChange(int code, const char* taskId, const HRTCUrlStatusList * urlStatu); 【功能说明】 RTMP推流状态回调。回调参数 code：错误码，成功为0，失败请参考错误码。 taskId：任务Id。 urlStatu：推流的url状态，具体请参见HRTCUrlStatusList。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onUserNetworkQualityNotify

onUserNetworkQualityNotify void onUserNetworkQualityNotify(String roomId, String userId, HRTCNetworkQualityLevel txQuality, HRTCNetworkQualityLevel rxQuality); 【功能说明】支持用户上报各自与近端SFU间的上下行网络质量，基于用户级，使本地用户能获取同房间内远端用户与其近端SFU间的网络质量。CMD广播时为房间级，将广播给订阅了此主播流的用户或者此主播被选为TOPN用户且观众订阅了该TOPN用户。【回调参数】 roomId：用户所在房间号。 userId：上报的用户id，0为本地，非0为远端。 txQuality：该用户的上行网络质量，具体请参见HRTCNetworkQualityLevel。 rxQuality：该用户的下行网络质量，具体请参见HRTCNetworkQualityLevel。此接口不支持跨房场景、WebRTC场景。不支持RTSA。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onMediaConnectStateChangedNotify

onMediaConnectStateChangedNotify virtual void onMediaConnectStateChangedNotify(HRTCMediaConnStateTypes state, HRTCMediaConnChangeReason reason, const char* description) 【功能说明】媒体服务器连接状态变更通知。【回调参数】 state：与媒体服务器连接状态，具体请参见HRTCMediaConnStateTypes。 reason：连接状态变化的原因，具体请参见HRTCMediaConnChangeReason。 description：连接状态变化原因描述。加入房间过后，收到媒体服务的数据包时，返回Connected消息，超过6s没有收到包，则返回Failed消息。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onMultiRoomMediaRelayStateChanged

onMultiRoomMediaRelayStateChanged void onMultiRoomMediaRelayStateChanged(const char *roomId, HRTCMultiRoomMediaRelayState state, HRTCMultiRoomMediaRelayStateCode code); 【功能说明】跨房状态回调。【回调参数】 roomId：跨房房间号。 state：状态类型，具体请参见HRTCMultiRoomMediaRelayState。 code：状态的具体原因，具体请参见HRTCMultiRoomMediaRelayStateCode。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onUserVolumeStatsNotify

onUserVolumeStatsNotify virtual void onUserVolumeStatsNotify(const HRTCVolumeInfo* userVolumes, unsigned int userVolumesCount, unsigned int totalVolume) 【功能说明】用户音量状态回调。通过enableUserVolumeNotify开启并设置回调周期，定时上报。【回调参数】 userVolumes：用户信息，具体请参见HRTCVolumeInfo。 userVolumesCount：上报的用户人数，包含本地用户。 totalVolume：总音量。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onLocalAudioStateChangedNotify

onLocalAudioStateChangedNotify virtual void onLocalAudioStateChangedNotify(HRTCLocalAudioStreamState state, HRTCLocalAudioStreamStateReason reason) 【功能说明】本地音频状态改变，触发此回调。【回调参数】 state：本地音频状态，具体请参见HRTCLocalAudioStreamState。 reason：本地音频状态改变的原因，具体请参见HRTCLocalAudioStreamStateReason。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onRemoteUserNameChangedNotify

onRemoteUserNameChangedNotify virtual void onRemoteUserNameChangedNotify(const char* roomId, const char* userId, const char* userName) 【功能说明】远端用户昵称变化，触发此回调。【回调参数】 roomId：房间ID。 userId：用户ID。 userName：变更后的昵称。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onDeviceVolumeChangedNotify

onDeviceVolumeChangedNotify virtual void onDeviceVolumeChangedNotify(HRTCDeviceType deviceType, unsigned int volume, unsigned int muted) 【功能说明】音频设备音量发生变化，触发此回调。【回调参数】 deviceType：系统设备类型，具体请参见HRTCDeviceType。 volume：音量。 muted：true表示设备静音，false表示设备未静音。通话前调整音频设备音量和静音会上报变化。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onUserRoleChangedNotify

onUserRoleChangedNotify virtual void onUserRoleChangedNotify(const char* roomId, HRTCRoleType oldRole, HRTCRoleType newRole) 【功能说明】用户角色切换成功，触发此回调。【回调参数】 roomId：发生角色切换的房间号。 oldRole：切换前的角色。具体请参见HRTCRoleType。 newRole：切换成功后的角色。具体请参见HRTCRoleType。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onFirstRemoteAuxiliaryStreamDecoded

onFirstRemoteAuxiliaryStreamDecoded virtual void onFirstRemoteAuxiliaryStreamDecoded(const char* roomId, const char* userId, int width, int height) 【功能说明】接收到第一帧远端辅流并解码成功，触发此回调。【回调参数】 roomId：视频流对应的房间ID。 userId：视频流对应的用户ID。 width：视频流宽。 height：视频流高。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onAudioStatsNotify

onAudioStatsNotify virtual void onAudioStatsNotify(HRTCLocalAudioStats *localStats, unsigned int localStatsCount, HRTCRemoteAudioStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】音频流详情，2s触发一次回调。【回调参数】 localStats：本地音频发流统计，具体请参见HRTCLocalAudioStats。 localStatsCount：localStats数组长度。 remoteStats：远端音频收流统计，具体请参见HRTCRemoteAudioStats。 remoteStatsCount：remoteStats数组长度。当无本地音频时，localStatsCount为0，localStats为空指针，需要先判断不为空再使用，否则可能引发空指针错误。当无远端音频时，remoteStatsCount为0，remoteStats为空指针，需要先判断不为空再使用，否则可能引发空指针错误。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onRemoteAudioStateChangedNotify

onRemoteAudioStateChangedNotify virtual void onRemoteAudioStateChangedNotify(const char* userId, HRTCRemoteAudioStreamState state, HRTCRemoteAudioStreamStateReason reason) 【功能说明】远端音频流状态变化回调。【回调参数】 userId：远端用户ID。 state：远端音频流状态，具体请参见HRTCRemoteAudioStreamState。 reason：远端音频流状态变化原因，具体请参见HRTCRemoteAudioStreamStateReason。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onDeviceStateChangedNotify

onDeviceStateChangedNotify virtual void onDeviceStateChangedNotify(const char* deviceId, HRTCDeviceType deviceType, HRTCDeviceState deviceState) 【功能说明】设备状态发生变化，触发此回调。【回调参数】 deviceId：系统设备标识，如系统音频播放设备标识可通过getPlaybackDevices获取。 deviceType：系统设备类型，具体请参见HRTCDeviceType。 deviceState：系统设备状态，具体请参见HRTCDeviceState。通话前插拔设备会上报变化。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onUserAuxiliaryStreamAvailable

onUserAuxiliaryStreamAvailable virtual void onUserAuxiliaryStreamAvailable(const char* roomId, const char* userId, bool available) 【功能说明】远端开启，停止辅流后，触发此回调。【回调参数】 roomId：房间ID。 userId：远端用户ID。 available：true表示远端开启推辅流，false表示远端停止辅流。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onAuxiliaryStreamStatsNotify

onAuxiliaryStreamStatsNotify virtual void onAuxiliaryStreamStatsNotify(HRTCLocalVideoStats *localStats, unsigned int localStatsCount, HRTCRemoteVideoStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】辅流详情，2s触发一次回调。【回调参数】 localStats：本地辅流发流统计，具体请参见HRTCLocalVideoStats。 localStatsCount：localStats数组长度。 remoteStats：远端辅流收流统计，具体请参见HRTCRemoteVideoStats。 remoteStatsCount：remoteStats数组长度。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onFirstRemoteVideoDecoded

onFirstRemoteVideoDecoded virtual void onFirstRemoteVideoDecoded(const char* roomId, const char* userId, int width, int height) 【功能说明】接收到第一帧远端视频流并解码成功，触发此回调。【回调参数】 roomId：视频流对应的房间ID。 userId：视频流对应的用户ID。 width：视频流宽。 height：视频流高。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onConnectionChangedNotify

onConnectionChangedNotify virtual void onConnectionChangedNotify(HRTCConnStateTypes connType, HRTCConnChangeReason reason, const char* description) 【功能说明】网络连接状态发生变化，触发此回调。【回调参数】 connType：网络连接状态。具体请参见HRTCConnStateTypes。 reason：网络连接状态发生变化原因。具体请参见HRTCConnChangeReason。 description：错误原因描述。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onVideoStatsNotify

onVideoStatsNotify virtual void onVideoStatsNotify(HRTCLocalVideoStats *localStats, unsigned int localStatsCount, HRTCRemoteVideoStats *remoteStats, unsigned int remoteStatsCount) 【功能说明】视频流详情，2s触发一次回调。【回调参数】 localStats：本地视频发流统计，具体请参见HRTCLocalVideoStats。 localStatsCount：localStats数组长度。 remoteStats：远端视频收流统计，具体请参见HRTCRemoteVideoStats。 remoteStatsCount：remoteStats数组长度。当无本地视频时，localStatsCount为0，localStats为空指针，需要先判断不为空再使用，否则可能引发空指针错误。当无远端视频时，remoteStatsCount为0，remoteStats为空指针，需要先判断不为空再使用，否则可能引发空指针错误。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onUserNameChangedNotify

onUserNameChangedNotify virtual void onUserNameChangedNotify(IHRTCConnection* conn, const char* oldUserName, const char* newUserName) 【功能说明】本端用户昵称变化，触发此回调。【回调参数】 conn：连接对象。 oldUserName：变更前的昵称。 newUserName：变更后的昵称。

实时音视频 SPARKRTC 接口参考
实时音视频 SPARKRTC-事件回调（IHRTCEngineEventHandler）:onRemoteAudioStateChangedNotify

onRemoteAudioStateChangedNotify virtual void onRemoteAudioStateChangedNotify(IHRTCConnection* conn, const char* userId, HRTCRemoteAudioStreamState state, HRTCRemoteAudioStreamStateReason reason) 【功能说明】远端音频流状态变化回调。【回调参数】 conn：连接对象。 userId：远端用户ID。 state：远端音频流状态，具体请参见HRTCRemoteAudioStreamState。 reason：远端音频流状态变化原因，具体请参见HRTCRemoteAudioStreamStateReason。

实时音视频 SPARKRTC 接口参考

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线