Windows(C++)[v1.7.5.0]
Public 成员函数 | 所有成员列表
RtcEngine::Callback类 参考

RtcEngine的回调函数, 在使用RtcEngine之前必须要设置回调以获取事件通知。 更多...

#include <PanoRtcEngine.h>

Public 成员函数

virtual void onChannelJoinConfirm (QResult result)
 
virtual void onChannelLeaveIndication (QResult result)
 
virtual void onChannelCountDown (uint32_t remain)
 
virtual void onUserJoinIndication (uint64_t userId, const char *userName)
 
virtual void onUserLeaveIndication (uint64_t userId, UserLeaveReason reason)
 
virtual void onUserAudioStart (uint64_t userId)
 
virtual void onUserAudioStop (uint64_t userId)
 
virtual void onUserAudioSubscribe (uint64_t userId, MediaSubscribeResult result)
 
virtual void onUserVideoStart (uint64_t userId, VideoProfileType maxProfile)
 
virtual void onUserVideoStop (uint64_t userId)
 
virtual void onUserVideoSubscribe (uint64_t userId, MediaSubscribeResult result)
 
virtual void onUserAudioMute (uint64_t userId)
 
virtual void onUserAudioUnmute (uint64_t userId)
 
virtual void onUserVideoMute (uint64_t userId)
 
virtual void onUserVideoUnmute (uint64_t userId)
 
virtual void onUserScreenStart (uint64_t userId)
 
virtual void onUserScreenStop (uint64_t userId)
 
virtual void onUserScreenSubscribe (uint64_t userId, MediaSubscribeResult result)
 
virtual void onUserScreenMute (uint64_t userId)
 
virtual void onUserScreenUnmute (uint64_t userId)
 
virtual void onWhiteboardAvailable ()
 
virtual void onWhiteboardUnavailable ()
 
virtual void onWhiteboardStart ()
 
virtual void onWhiteboardStop ()
 
virtual void onWhiteboardStart (const char *whiteboardId)
 
virtual void onWhiteboardStop (const char *whiteboardId)
 
virtual void onFirstAudioDataReceived (uint64_t userId)
 
virtual void onFirstVideoDataReceived (uint64_t userId)
 
virtual void onFirstScreenDataReceived (uint64_t userId)
 
virtual void onFirstVideoFrameRendered (uint64_t userId)
 
virtual void onFirstScreenFrameRendered (uint64_t userId)
 
virtual void onAudioDeviceStateChanged (const char deviceID[kMaxDeviceIDLength], AudioDeviceType deviceType, AudioDeviceState deviceState)
 
virtual void onAudioDefaultDeviceChanged (const char deviceID[kMaxDeviceIDLength], AudioDeviceType deviceType)
 
virtual void onVideoDeviceStateChanged (const char deviceID[kMaxDeviceIDLength], VideoDeviceType deviceType, VideoDeviceState deviceState)
 
virtual void onVideoCaptureStateChanged (const char deviceID[kMaxDeviceIDLength], VideoCaptureState state)
 
virtual void onChannelFailover (FailoverState state)
 
virtual void onActiveSpeakerListUpdated (const uint64_t *userIds, size_t count)
 
virtual void onAudioMixingStateChanged (int64_t taskId, AudioMixingState state)
 
virtual void onVideoSnapshotCompleted (bool succeed, uint64_t userId, const char *filename)
 
virtual void onNetworkQuality (uint64_t userId, QualityRating quality)
 
virtual void onAudioStartResult (QResult result)
 音频开启成功与否的通知 更多...
 
virtual void onVideoStartResult (QResult result)
 视频开启成功与否的通知 更多...
 
virtual void onScreenStartResult (QResult result)
 共享开启成功与否的通知 更多...
 
virtual void onScreenCaptureStateChanged (ScreenCaptureState state, QResult reason)
 
virtual void onSoundCardShareStartResult (QResult result)
 音频共享开启成功与否的通知 更多...
 
virtual void onSoundCardMonitorStartResult (QResult result)
 声卡数据监控器开启成功与否的通知 更多...
 
virtual void onUserAudioControlMessageReceived (uint64_t userId, const PanoData &data)
 音频控制消息的通知 更多...
 
virtual void onUserAudioCallTypeChanged (uint64_t userId, AudioCallType type)
 音频接入类型变化的通知 更多...
 
virtual void onCalloutResult (const char *phoneNo, QResult result)
 电话拨出成功与否的通知 更多...
 

详细描述

RtcEngine的回调函数, 在使用RtcEngine之前必须要设置回调以获取事件通知。

成员函数说明

◆ onActiveSpeakerListUpdated()

virtual void RtcEngine::Callback::onActiveSpeakerListUpdated ( const uint64_t *  userIds,
size_t  count 
)
inlinevirtual

活跃用户列表变更通知

参数
userIds用户 ID 列表, 按声音能量值排序
count用户列表大小

◆ onAudioDefaultDeviceChanged()

virtual void RtcEngine::Callback::onAudioDefaultDeviceChanged ( const char  deviceID[kMaxDeviceIDLength],
AudioDeviceType  deviceType 
)
inlinevirtual

音频系统默认设备变化的通知

参数
deviceID设备ID
deviceType设备类型

◆ onAudioDeviceStateChanged()

virtual void RtcEngine::Callback::onAudioDeviceStateChanged ( const char  deviceID[kMaxDeviceIDLength],
AudioDeviceType  deviceType,
AudioDeviceState  deviceState 
)
inlinevirtual

音频设备状态变化的通知

参数
deviceID设备ID
deviceType设备类型
deviceState设备状态

◆ onAudioMixingStateChanged()

virtual void RtcEngine::Callback::onAudioMixingStateChanged ( int64_t  taskId,
AudioMixingState  state 
)
inlinevirtual

混音任务状态变更通知

参数
taskId任务标识
state混音状态

◆ onAudioStartResult()

virtual void RtcEngine::Callback::onAudioStartResult ( QResult  result)
inlinevirtual

音频开启成功与否的通知

参数
result音频开启的结果

◆ onCalloutResult()

virtual void RtcEngine::Callback::onCalloutResult ( const char *  phoneNo,
QResult  result 
)
inlinevirtual

电话拨出成功与否的通知

参数
phoneNo电话号码
result电话拨打结果

◆ onChannelCountDown()

virtual void RtcEngine::Callback::onChannelCountDown ( uint32_t  remain)
inlinevirtual

频道倒计时通知

参数
remain频道剩余时间,单位:秒。

◆ onChannelFailover()

virtual void RtcEngine::Callback::onChannelFailover ( FailoverState  state)
inlinevirtual

频道错误恢复通知

参数
state错误恢复状态

◆ onChannelJoinConfirm()

virtual void RtcEngine::Callback::onChannelJoinConfirm ( QResult  result)
inlinevirtual

加入频道的通知

参数
resultOK 表示加入频道成功, 其他表示加入频道失败。

◆ onChannelLeaveIndication()

virtual void RtcEngine::Callback::onChannelLeaveIndication ( QResult  result)
inlinevirtual

离开频道的通知

参数
resultOK 表示正常离开频道, 其他表示非正常离开频道。

◆ onFirstAudioDataReceived()

virtual void RtcEngine::Callback::onFirstAudioDataReceived ( uint64_t  userId)
inlinevirtual

第一个音频包到达通知

参数
userId用户ID。

◆ onFirstScreenDataReceived()

virtual void RtcEngine::Callback::onFirstScreenDataReceived ( uint64_t  userId)
inlinevirtual

第一个屏幕共享包到达通知

参数
userId用户ID。

◆ onFirstScreenFrameRendered()

virtual void RtcEngine::Callback::onFirstScreenFrameRendered ( uint64_t  userId)
inlinevirtual

第一个屏幕共享帧渲染通知。

参数
userId用户ID。

◆ onFirstVideoDataReceived()

virtual void RtcEngine::Callback::onFirstVideoDataReceived ( uint64_t  userId)
inlinevirtual

第一个视频包到达通知

参数
userId用户ID。

◆ onFirstVideoFrameRendered()

virtual void RtcEngine::Callback::onFirstVideoFrameRendered ( uint64_t  userId)
inlinevirtual

第一个视频帧渲染通知。

参数
userId用户ID。

◆ onNetworkQuality()

virtual void RtcEngine::Callback::onNetworkQuality ( uint64_t  userId,
QualityRating  quality 
)
inlinevirtual

通话中的网络质量通知

参数
userId用户ID
quality网络质量

◆ onScreenCaptureStateChanged()

virtual void RtcEngine::Callback::onScreenCaptureStateChanged ( ScreenCaptureState  state,
QResult  reason 
)
inlinevirtual

屏幕采集状态变化的通知。

参数
state采集状态。
reason状态变化原因。

◆ onScreenStartResult()

virtual void RtcEngine::Callback::onScreenStartResult ( QResult  result)
inlinevirtual

共享开启成功与否的通知

参数
result共享开启的结果

◆ onSoundCardMonitorStartResult()

virtual void RtcEngine::Callback::onSoundCardMonitorStartResult ( QResult  result)
inlinevirtual

声卡数据监控器开启成功与否的通知

参数
result开启声卡数据监控器的结果

◆ onSoundCardShareStartResult()

virtual void RtcEngine::Callback::onSoundCardShareStartResult ( QResult  result)
inlinevirtual

音频共享开启成功与否的通知

参数
result音频共享开启的结果

◆ onUserAudioCallTypeChanged()

virtual void RtcEngine::Callback::onUserAudioCallTypeChanged ( uint64_t  userId,
AudioCallType  type 
)
inlinevirtual

音频接入类型变化的通知

参数
userId用户ID
type音频接入类型

◆ onUserAudioControlMessageReceived()

virtual void RtcEngine::Callback::onUserAudioControlMessageReceived ( uint64_t  userId,
const PanoData data 
)
inlinevirtual

音频控制消息的通知

参数
userId用户ID
data音频控制消息数据

◆ onUserAudioMute()

virtual void RtcEngine::Callback::onUserAudioMute ( uint64_t  userId)
inlinevirtual

用户设置静音通知

参数
userId用户ID。

◆ onUserAudioStart()

virtual void RtcEngine::Callback::onUserAudioStart ( uint64_t  userId)
inlinevirtual

用户打开音频通知

参数
userId用户ID。

◆ onUserAudioStop()

virtual void RtcEngine::Callback::onUserAudioStop ( uint64_t  userId)
inlinevirtual

用户关闭音频通知

参数
userId用户ID。

◆ onUserAudioSubscribe()

virtual void RtcEngine::Callback::onUserAudioSubscribe ( uint64_t  userId,
MediaSubscribeResult  result 
)
inlinevirtual

用户音频订阅结果通知

参数
userId用户ID。
result订阅结果。

◆ onUserAudioUnmute()

virtual void RtcEngine::Callback::onUserAudioUnmute ( uint64_t  userId)
inlinevirtual

用户取消静音通知

参数
userId用户ID。

◆ onUserJoinIndication()

virtual void RtcEngine::Callback::onUserJoinIndication ( uint64_t  userId,
const char *  userName 
)
inlinevirtual

其他人员的加入通知

参数
userId用户ID。
userName用户名字, 可能为空字符串。

◆ onUserLeaveIndication()

virtual void RtcEngine::Callback::onUserLeaveIndication ( uint64_t  userId,
UserLeaveReason  reason 
)
inlinevirtual

其他人员离开通知。

参数
userId用户ID。
reason用户离开的原因, OK表示正常离开, 其他为非正常离开。

◆ onUserScreenMute()

virtual void RtcEngine::Callback::onUserScreenMute ( uint64_t  userId)
inlinevirtual

用户暂停屏幕共享通知

参数
userId用户ID。

◆ onUserScreenStart()

virtual void RtcEngine::Callback::onUserScreenStart ( uint64_t  userId)
inlinevirtual

用户开启屏幕共享通知

参数
userId用户ID。

◆ onUserScreenStop()

virtual void RtcEngine::Callback::onUserScreenStop ( uint64_t  userId)
inlinevirtual

用户关闭屏幕共享通知

参数
userId用户ID。

◆ onUserScreenSubscribe()

virtual void RtcEngine::Callback::onUserScreenSubscribe ( uint64_t  userId,
MediaSubscribeResult  result 
)
inlinevirtual

用户桌面共享订阅结果通知

参数
userId用户ID。
result订阅结果。

◆ onUserScreenUnmute()

virtual void RtcEngine::Callback::onUserScreenUnmute ( uint64_t  userId)
inlinevirtual

用户恢复屏幕共享通知

参数
userId用户ID。

◆ onUserVideoMute()

virtual void RtcEngine::Callback::onUserVideoMute ( uint64_t  userId)
inlinevirtual

用户暂停视频通知

参数
userId用户ID。

◆ onUserVideoStart()

virtual void RtcEngine::Callback::onUserVideoStart ( uint64_t  userId,
VideoProfileType  maxProfile 
)
inlinevirtual

用户开启视频通知

参数
userId用户ID。
maxProfile用户视频能力

◆ onUserVideoStop()

virtual void RtcEngine::Callback::onUserVideoStop ( uint64_t  userId)
inlinevirtual

用户关闭视频通知

参数
userId用户ID。

◆ onUserVideoSubscribe()

virtual void RtcEngine::Callback::onUserVideoSubscribe ( uint64_t  userId,
MediaSubscribeResult  result 
)
inlinevirtual

用户视频订阅结果通知

参数
userId用户ID。
result订阅结果。

◆ onUserVideoUnmute()

virtual void RtcEngine::Callback::onUserVideoUnmute ( uint64_t  userId)
inlinevirtual

用户恢复视频通知

参数
userId用户ID。

◆ onVideoCaptureStateChanged()

virtual void RtcEngine::Callback::onVideoCaptureStateChanged ( const char  deviceID[kMaxDeviceIDLength],
VideoCaptureState  state 
)
inlinevirtual

视频采集状态变化的通知。

参数
deviceID设备ID。
state采集状态。

◆ onVideoDeviceStateChanged()

virtual void RtcEngine::Callback::onVideoDeviceStateChanged ( const char  deviceID[kMaxDeviceIDLength],
VideoDeviceType  deviceType,
VideoDeviceState  deviceState 
)
inlinevirtual

视频设备状态变化的通知

参数
deviceID设备ID
deviceType设备类型
deviceState设备状态

◆ onVideoSnapshotCompleted()

virtual void RtcEngine::Callback::onVideoSnapshotCompleted ( bool  succeed,
uint64_t  userId,
const char *  filename 
)
inlinevirtual

用户视频快照完成通知

参数
succeed是否成功写入文件
userId快照所属的用户ID
filename快照文件完整路径

◆ onVideoStartResult()

virtual void RtcEngine::Callback::onVideoStartResult ( QResult  result)
inlinevirtual

视频开启成功与否的通知

参数
result视频开启的结果

◆ onWhiteboardAvailable()

virtual void RtcEngine::Callback::onWhiteboardAvailable ( )
inlinevirtual

白板服务可用通知

◆ onWhiteboardStart() [1/2]

virtual void RtcEngine::Callback::onWhiteboardStart ( )
inlinevirtual

开始默认共享白板通知

◆ onWhiteboardStart() [2/2]

virtual void RtcEngine::Callback::onWhiteboardStart ( const char *  whiteboardId)
inlinevirtual

开始共享白板通知

参数
whiteboardId白板Id

◆ onWhiteboardStop() [1/2]

virtual void RtcEngine::Callback::onWhiteboardStop ( )
inlinevirtual

终止默认共享白板通知

◆ onWhiteboardStop() [2/2]

virtual void RtcEngine::Callback::onWhiteboardStop ( const char *  whiteboardId)
inlinevirtual

终止共享白板通知

参数
whiteboardId白板Id

◆ onWhiteboardUnavailable()

virtual void RtcEngine::Callback::onWhiteboardUnavailable ( )
inlinevirtual

白板服务不可用通知


该类的文档由以下文件生成: