华为云用户手册

  • 实时音视频 SPARKRTC-事件回调(IHRTCConnectionEventHandler):onRemoteShareStatusChangeNotify
    onRemoteShareStatusChangeNotify void onRemoteShareStatusChangeNotify(HRTCConnection conn, String userId, boolean isRecving) 【功能说明】 上报下行辅流状态变化通知，接收端探测网络变化，分配给下行辅流，如果有辅流因为带宽不足被停掉或者带宽恢复而恢复，则上报给产品。 【回调参数】 conn: 连接对象。 userId：下行辅流对应的用户ID。 isRecving：是否接受。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调(IHRTCConnectionEventHandler):onLeaveRoom
    onLeaveRoom void onLeaveRoom(HRTCConnection conn, HRTCLeaveReason reason, HR TCS tatsInfo statsInfo); 【功能说明】 离开房间回调。 【回调参数】 conn：回调对应的HRTCConnection实例。 reason：自己离开房间的原因，具体请参见HRTCLeaveReason。 statsInfo：会议期间的统计信息，具体请参见HRT CS tatsInfo。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:stream-interrupted
    stream-interrupted 【事件说明】 远端流的码流中断事件。中断表示在 enableStreamStateDetection 接口参数 interval 设置的统计周期内未接收到有效视频帧。该事件为 1.4.0 版本新增。 【回调参数】 streamInterruptedEvent：必选，UserList[]类型，已订阅且无视频码流的用户列表。 UserList定义为：{ userId：必选，string类型，用户Id。 isScreen：必选，boolean类型，true表示对应用户的辅流，false表示对应用户的主流。 }
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:rtc-stats
    rtc-stats 【事件说明】 音视频流数据统计事件。该事件为2.0.3版本新增。 【回调参数】 rtcStatsInfo：必选， rtcStatsInfo[]类型。 rtcStatsInfo定义为：{ userName：必选，string类型，用户昵称。 isRemote：必选，boolean类型，是否为远端流，true表示远端流，false表示本地流。 streamType：必选，ContentType类型，流类型。ContentType类型的枚举值如下：{ main：string类型，表示主流。 middle1：string类型，表示主流，middle1~middle4码流依次降低。 middle2：string类型，表示主流，middle1~middle4码流依次降低。 middle3：string类型，表示主流，middle1~middle4码流依次降低。 middle4：string类型，表示主流，middle1~middle4码流依次降低。 slides：string类型，表示主流视频分辨率最小的流。 desktop：string类型，表示共享流。 } mediaType：必选，MediaType类型，媒体类型，音频或视频。 bitrate：必选，number类型，音视频流码率，单位为kbps。 frameRate：必选，number类型，视频帧率，单位为帧/秒。 rtt：必选，number类型，表示SDK到边缘服务器的RTT (Round-Trip Time)，单位毫秒。只有本地流才有rtt 值。 jitter：必选，number类型，音视频流抖动值。 pktLossRate：必选，number类型，音视频流丢包率。 }
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:camera-changed
    camera-changed 【事件说明】 本地摄像头设备变更事件，当插、拔本地摄像头时触发。 【回调参数】 DeviceChangedEvent：必选，DeviceChangedInfo类型，设备变更详情。 DeviceChangedInfo 定义为：{ deviceId：必选，string类型，设备deviceId。 state：必选，DeviceChangeMode类型，DeviceChangeMode枚举值定义如下： ADD：设备添加。 REMOVE：设备移除。 } 视频采集设备，拔插后需要应用层进行相应的处理，如：拔除摄像头的时候是否切换其他视频采集设备重新采集；插入摄像头的时候是否使用新插入设备进行重新采集。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:volume-indicator
    volume-indicator 【事件说明】 音频TopN模式下，房间中当前音量最大的用户提示事件。 【回调参数】 userVolumeInfos：必选， UserVolumeInfo[]类型。 UserVolumeInfo定义为：{ user_id：必选，string类型，用户Id。 volume：可选，number类型，取值范围为[0,100]。 } 该事件仅在音频TopN模式下生效，1.5.0版本新增。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:live-streaming-updated
    live-streaming-updated 【事件说明】 旁路推流状态更新事件。该事件为2.0.1版本新增。 【回调参数】 urlStatus：UrlStatus[]类型，所有CDN推流状态更新。UrlStatus定义如下： url：必选，string类型，表示CDN推流URL status：必选，number类型，表示当前推流状态。 0：初始化。 1：链接正常且有流。 2：链接正常但无流。 3：异常重试。 4：处理失败。 errorCode：可选，number类型，表示详细的失败原因，支持的枚举值如下： 0： 正常。 1： 内部错误。 2： 地址解析失败。 3： 连接失败。 4： RTMP握手失败。 5： 内存错误。 6： 参数错误。 7： 重试失败。 8： 响应超时失败。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:recording-device-changed
    recording-device-changed 【事件说明】 本地录音设备变更事件，当本地录音设备变更时触发。 【回调参数】 DeviceChangedEvent：必选，DeviceChangedInfo类型，设备变更详情。DeviceChangedInfo定义参考camera-changed中的说明。 麦克风采集设备，拔插后需要应用层进行相应的处理，如：拔除麦克风的时候是否切换其他麦克风采集设备重新采集；插入麦克风的时候是否使用新插入设备进行重新采集。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:network-quality
    network-quality 【事件说明】 网络上下行质量报告事件，用户加入房间后，SDK在网络质量变化的时候会触发一次该事件，报告用户的本地网络上下行质量情况。 【回调参数】 NetworkQualityEvent：必选， NetworkQualityInfo类型，网络上下行质量详情。 NetworkQualityInfo定义为：{ uplinkNetworkQuality：必选，number类型，上行网络质量。枚举值如下： 0：质量未知。 1：质量极好。 2：质量较好。 3：质量一般。 4：质量差。 5：质量极差。 6：网络连接断开。 downlinkNetworkQuality：必选，number类型，下行网络质量。枚举值如下： 0：质量未知。 1：质量极好。 2：质量较好。 3：质量一般。 4：质量差。 5：质量极差。 6：网络连接断开。 }
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:remote-user-name-changed
    remote-user-name-changed 【事件说明】 远端用户昵称变更事件。该事件为1.5.0版本新增。 【回调参数】 userNameChangedEvent：必选， UserNameInfo类型。 UserNameInfo定义为：{ roomId：必选，string[64]类型，房间Id。 userId：必选，string[64]类型，用户Id。 userName：必选， string[256]类型，修改后的用户昵称。 }
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:connection-state-changed
    connection-state-changed 【事件说明】 Client连接状态变更事件，Client连接状态变更会收到该事件通知。 【回调参数】 ConnectionStateInfoEvent：{ prevState：必选，ConnectionState类型，变更前状态。 curState：必选，ConnectionState类型，变更后状态。 } 连接状态ConnectionState的取值如下所示： CONNECTING：连接建立中。 CONNECTED：连接已连接。 RECONNECTING：重新连接中。 DISCONNECTED：连接已断开。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:signature-expired
    signature-expired 【事件说明】 签名过期事件。 【回调参数】 errorInfo：错误信息。必选，ErrorInfo类型。 ErrorInfo 定义为：{ errorCode：错误码。必选，string类型。 errorMsg：必选，string类型。取值如下面的取值示例中所示。 } 取值示例，如下所示： 签名过期：{ errorCode: '90100030' errorMsg: 'signature expired' } 签名无效：{ errorCode: '90100031' errorMsg: 'signature invalid' } 监听到签名过期事件后可通过错误码区分是签名无效还是签名过期，签名过期后可通过renewSignature接口更新签名。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:client-banned
    client-banned 【事件说明】 用户被踢下线事件，当用户以相同的userId 在其他Client加入相同的房间后，被踢的Client会收到该事件通知。 【回调参数】 clientBannedEvent：必选，ClientBanInfo类型， ClientBanInfo定义为：{ userId：必选，string[64]类型，被踢用户标识。 reason：必选，string类型，原因描述。 }
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:peer-leave
    peer-leave 【事件说明】 远端用户离开房间事件，远端用户离开房间后会收到该事件通知。 【回调参数】 peerLeaveEvent：必选，PeerLeaveInfo 类型，用户离开信息。 PeerLeaveInfo 定义为：{ userId：必选，string[64]类型，用户标识。 userName：可选，string[256]类型，用户昵称。 reason：可选，HRTCLeaveReason类型。 } HRTCLeaveReason定义为：{ code：number类型, 离开原因枚举，取值如表2 离开房间原因所示。 msg：string类型，原因描述。 } 表2 离开房间原因 枚举值 描述 0 用户主动离开 1 服务器异常 2 sfu服务故障 3 服务不可达503 4 内部错误 5 被踢出房间 6 签名过期 7 重连超时 8 网络检测，UI不需要关注该错误码，不对外体现 9 用户移除 10 房间解散
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-客户端事件通知（ClientEvent）:mute-audio
    mute-audio 【事件说明】 远端用户禁用音频通知事件，当远端用户禁用音频后，流接收端会收到该事件通知。 【回调参数】 mediaStatus：必选，MediaStatusNotifyInfo类型。 MediaStatusNotifyInfo包含如下属性： roomId：必选，string[64]类型。 userId：必选，string[64]类型。 status：必选，MediaStatusAction类型。MediaStatusAction枚举值定义如下所示： 1：媒资状态可用。 2：媒资状态不可用。 reason：必选，MediaStatusReason类型。MediaStatusReason枚举值定义如下所示： 0：媒体离线。 1：媒体静音。 2：媒体不静音。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onError
    connection:onError - (void)connection:(HWRtcConnection *)connection onError:(int)errorCode errorMsg:(NSString * _Nonnull)errorMsg; 【功能说明】 发生错误，触发此回调。返回客户端错误码或者服务端错误码。 【回调参数】 connection：跨房引擎。 errorCode：错误码，具体请参见HRTCErrorCode。 errorMsg：错误信息描述。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onRemoteVideoResolutionChangedNotify
    connection:onRemoteVideoResolutionChangedNotify - (void)connection:(HWRtcConnection *)connection onRemoteVideoResolutionChangedNotify:(NSString *_Nullable)userId width:(NSInteger)width height:(NSInteger)height; 【功能说明】 远端视频大小改变回调。 【回调参数】 connection：跨房引擎。 userId：用户ID。 width：视频流宽度。 height：视频流高度。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onFirstRemoteAuxiliaryStreamDecoded
    connection:onFirstRemoteAuxiliaryStreamDecoded -(void)connection:(HWRtcConnection *)connection onFirstRemoteAuxiliaryStreamDecoded:(NSString * _Nonnull)userId width:(int)width height:(int)height； 【功能说明】 引擎收到第一帧远端视频流并解码成功回调。 【回调参数】 connection：跨房引擎。 userId：视频流对应的用户ID。 width：视频流宽度。 height：视频流高度。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onRemoteUserOnline
    connection:onRemoteUserOnline - (void)connection:(HWRtcConnection *)connection onRemoteUserOnline:(NSString * _Nonnull)userId userName:(NSString * _Nonnull)userName; 【功能说明】 远端用户加入跨房房间成功，触发此回调。该回调提示有远端用户加入了跨房房间，并返回新加入用户信息。 【回调参数】 connection：跨房引擎。 userId：远端用户ID。 userName：远端用户昵称。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onFirstRemoteVideoDecoded
    connection:onFirstRemoteVideoDecoded - (void)connection:(HWRtcConnection *)connection onFirstRemoteVideoDecoded:(NSString * _Nonnull)userId width:(int)width height:(int)height; 【功能说明】 跨房引擎收到第一帧远端视频流并解码成功回调。 【回调参数】 connection：跨房引擎。 userId：用户ID。 width：视频流宽度。 height：视频流高度。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onUserRoleChangedNotify
    connection:onUserRoleChangedNotify - (void)connection:(HWRtcConnection *)connection onUserRoleChangedNotify:(HWRtcRole)oldRole newRole:(HWRtcRole)newRole; 【功能说明】 用户跨房的房间内角色切换成功，触发此回调。 【回调参数】 connection：跨房引擎。 oldRole：切换前的角色，具体请参见HWRtcRole。 newRole：切换成功后的角色，具体请参见HWRtcRole。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onUserAuxiliaryStreamAvailable
    connection:onUserAuxiliaryStreamAvailable - (void)connection:(HWRtcConnection *)connection onUserAuxiliaryStreamAvailable:(NSString * _Nonnull)userId isAvailable:(BOOL)isAvailable; 【功能说明】 远端开启，停止辅流后，触发此回调。 【回调参数】 connection：跨房引擎。 userId：远端用户ID。 isAvailable：YES表示远端开启屏幕共享，NO表示远端停止屏幕共享。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onFirstRemoteAuxiliaryStreamDecoded
    connection:onFirstRemoteAuxiliaryStreamDecoded -(void)connection:(HWRtcConnection *)connection onFirstRemoteAuxiliaryStreamDecoded:(NSString * _Nonnull)userId width:(int)width height:(int)height elapsed:(NSUInteger)elapsed; 【功能说明】 引擎收到第一帧远端视频流并解码成功回调。 【回调参数】 connection：跨房引擎。 userId：视频流对应的用户ID。 width：视频流宽度。 height：视频流高度。 elapsed：首帧解码后消耗的时间，单位ms。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onLeaveRoom
    connection:onLeaveRoom -(void)connection:(HWRtcConnection *)connection onLeaveRoom:(HWRtcLeaveReason)leaveReason statsInfo:(HWRtcStatsInfo * _Nonnull)statsInfo; 【功能说明】 离开房间，触发此回调。 【回调参数】 connection：跨房引擎。 leaveReason：离开的房间原因，具体请参见HWRtcLeaveReason。 statsInfo：卡顿统计信息，具体请参见HWRtcStatsInfo。 APP调用leaveRoom接口时，会返回HWRtcLeaveReasonUserLeaveRoom，APP可以通过以下任一方式回退到登录界面。 APP在调用leaveRoom接口时退到登录界面，或者在收到onLeaveRoom回调，且回调消息不等于HWRtcLeaveReasonUserLeaveRoom时（防止重复操作），退到登录界面。 APP只在收到onLeaveRoom消息时退到登录界面。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onConnectionChangedNotify
    connection:onConnectionChangedNotify - (void)connection:(HWRtcConnection *)connection onConnectionChangedNotify:(HWRtcConnStateType)state reason:(HWRtcConnChangeReason)reason description:(NSString * _Nonnull)description; 【功能说明】 网络连接状态发生变化，触发此回调。 【回调参数】 connection：跨房引擎。 state：链接服务器状态，具体请参见HWRtcConnStateType。 reason：连接状态改变原因，具体请参见HWRtcConnChangeReason。 description：连接状态改变描述。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onRemoteAudioStateChange
    connection:onRemoteAudioStateChange - (void)connection:(HWRtcConnection *)connection onRemoteAudioStateChange:(NSString * _Nonnull)roomid userid:(NSString * _Nonnull)userid state:(HWRtcRemoteAudioState)state reason:(HWRtcRemoteAudioStateReason)reason; 【功能说明】 远端用户音频流状态发生改变，会触发此回调。 【回调参数】 connection：跨房引擎。 roomid：房间ID。 userid：远端用户ID。 state：远端音频流状态，具体请参见HWRtcRemoteAudioState。 reason：远端音频流状态改变原因，具体请参见HWRtcRemoteAudioStateReason。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onRenderSuccessNotify
    connection:onRenderSuccessNotify - (void)connection:(HWRtcConnection *)connection onRenderSuccessNotify:(NSString *_Nonnull)userId isAux:(NSUInteger)isAux; 【功能说明】 用户视频流渲染成功通知回调。首帧渲染成功、分辨率变化或视频流中断后恢复触发。 【回调参数】 connection：跨房引擎。 userId：用户ID。 isAux：YES表示是辅流，NO表示不是辅流。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onTopActiveSpeaker
    connection:onTopActiveSpeaker - (void)connection:(HWRtcConnection *)connection onTopActiveSpeaker:(NSString *_Nonnull)userId noStream:(BOOL)noStream; 【功能说明】 返回当前音量最大的用户ID。 【回调参数】 connection：跨房引擎 userId：用户ID。 noStream：该用户是否有视频流。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onRemoteMicrophoneStateChanged
    connection:onRemoteMicrophoneStateChanged - (void)connection:(HWRtcConnection *)connection onRemoteMicrophoneStateChanged:(NSString * _Nonnull)userId state:(HWRtcRemoteMicState)state; 【功能说明】 远端用户麦克风状态变更通知。 【回调参数】 connection：跨房引擎 userId：远端用户userId。 state：麦克风设备状态，具体请参见HWRtcRemoteMicState。
    实时音视频 SPARKRTC
  • 实时音视频 SPARKRTC-事件回调（HWRtcConnection）:connection:onRemoteUserOffline
    connection:onRemoteUserOffline - (void)connection:(HWRtcConnection *)connection onRemoteUserOffline:(NSString * _Nonnull)userId reason:(NSInteger)reason; 【功能说明】 远端用户离开跨房房间，触发此回调。 本端用户离开当前房间，会回调当前房间所有用户offline。 【回调参数】 connection：跨房引擎。 userId：离开房间的远端用户ID。 reason：远端用户离线原因，预留参数。
    实时音视频 SPARKRTC
共100000条
undefined

搜索反馈

您找到想要的内容了吗?

是的 没有

意见反馈

0/200

提交 取消

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