new User(id, name, data)
用户User构造函数。
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | 用户id |
name |
String | 用户名称 |
data |
String | 用户扩展字段 |
Methods
-
addCallback(type, callback)
-
用户级别的回调
Parameters:
Name Type Description typeUserCallback 回调枚举标识
callbackObject 回调方法名,可以自定义
Example
user.addCallback(UserCallback.microphone_status_notify, onMicrophoneStatusNotify); user.addCallback(UserCallback.camera_status_notify, onCameraStatusNotify); user.addCallback(UserCallback.screen_status_notify, onScreenStatusNotify); user.addCallback(UserCallback.camera_data_notify, onCameraDataNotify); user.addCallback(UserCallback.screen_data_notify, onScreenDataNotify); user.addCallback(UserCallback.publish_camera_notify, onPublishCameraNotify); user.addCallback(UserCallback.unpublish_camera_notify, onUnpublishCameraNotify); user.addCallback(UserCallback.subscrible_camera_result, onSubscribleCameraResult); user.addCallback(UserCallback.unsubscrible_camera_result, onUnsubscribleCameraResult); user.addCallback(UserCallback.publish_screen_notify, onPublishScreenNotify); user.addCallback(UserCallback.unpublish_screen_notify, onUnpublishScreenNotify); user.addCallback(UserCallback.subscrible_screen_result, onSubscribleScreenResult); user.addCallback(UserCallback.unsubscrible_screen_result, onUnsubscribleScreenResult); user.addCallback(UserCallback.publish_microphone_notify, onPublishMicrophoneNotify); user.addCallback(UserCallback.unpublish_microphone_notify, onUnpublishMicrophoneNotify); user.addCallback(UserCallback.subscrible_microphone_result, onSubscribleMicrophoneResult); user.addCallback(UserCallback.unsubscrible_microphone_result, onUnsubscribleMicrophoneResult); user.addCallback(UserCallback.board_add_result, onBoardAddResult); user.addCallback(UserCallback.board_update_result, onBoardUpateResult); user.addCallback(UserCallback.board_remove_result, onBoardremoveResult); 麦克风状态更新 param:status - 状态 param:microphoneId - 麦克风设备Id param:microphoneName - 麦克风设备名称 param:userId - 麦克风设备所属者ID function onMicrophoneStatusNotify(status, microphoneId, microphoneName, userId) { } 摄像头状态更新 param : status - 状态 param : cameraId - 摄像头设备Id param : cameraName- 摄像头设备名称 param : userId- 摄像头设备所属者ID function onCameraStatusNotify(status, cameraId, cameraName, userId) { } 桌面共享状态更新 param : status - 状态 param : cameraId - 桌面共享设备Id param : cameraName- 桌面共享设备名称 param : userId- 桌面共享设置所属者ID function onScreenStatusNotify(status, screenId, screenName, userId) { } 摄像头数据更新 param : level - 级别 param : description - 描述 param : cameraId - 摄像头设备Id param : cameraName- 摄像头设备名称 param : userId- 摄像头设备所属者ID function onCameraDataNotify(level, description, cameraId, cameraName, userId) { } 桌面共享数据更新 param : level - 级别 param : description - 描述 param : screenId - 桌面共享设备Id param : screenName- 桌面共享设备名称 param : userId- 桌面共享设置所属者ID function onScreenDataNotify(level, description, screenId, screenName, userId) { } 发布视频的回调 param : videos - 发布的视频数组 function onPublishCameraNotify(videos) { } 取消发布视频的回调 param : video - 取消发布的视频 function onUnpublishCameraNotify(video) { } 订阅远端视频流反馈 param: stream - 远端视频流 param :userId - 所属用户ID param :userName- 所属用户名称 param :cameraId- 摄像头设备ID function onSubscribleCameraResult(stream, userId, userName,cameraId) { } 取消订阅远端视频流反馈 param :userId- 所属用户ID param :userName-所属用户名称 param : cameraId-摄像头设备ID function onUnsubscribleCameraResult(userId, userName,cameraId){ } 发布桌面共享的回调 param : screens - 发布的桌面共享数组 function onPublishScreenNotify(screens){ } 取消发布桌面共享的回调 param : screen - 取消发布的桌面共享 function onUnpublishScreenNotify(screen) { } 订阅远端桌面共享流反馈 param: stream - 远端桌面共享流 param :userId - 所属用户ID param :userName- 所属用户名称 param :screenId- 桌面共享设备ID param :width- 分辨率宽度 param :height- 分辨率高度 param :framerate- 帧率 function onSubscribleScreenResult(stream, userId, userName,screenId,width,height,framerate) { } 取消订阅远端桌面共享流反馈 param :userId- 所属用户ID param :userName-所属用户名称 param : cameraId-桌面共享设备ID function onUnsubscribleScreenResult(userId, userName,screenId){ } 发布音频的回调 param : audios - 发布的音频数组 function onPublishMicrophoneNotify(audios) { } 取消发布音频的回调 param : audio - 取消发布的音频 function onUnpublishMicrophoneNotify(audio) { } 订阅远端音频流反馈 param:stream- 远端音频流 param:userId- 所属用户ID param:userName-所属用户名称 function onSubscribleMicrophoneResult(stream, userId, userName){ } 取消订阅远端音频流反馈 param :userId- 所属用户ID param : userName-所属用户名称 function onUnsubscribleMicrophoneResult(userId, userName){ } 白板新增操作反馈 param :board-白板对象 function onBoardAddResult(board){ } 白板删除操作反馈 param :boardId-白板对象Id function onBoardRemoveResult(boardId){ } -
attachAudioElementMediaStream(element, stream)
-
音频流渲染进音频控件
Parameters:
Name Type Description elementObject - 音频控件对象
streamObject - 音频流
-
attachScreenElementMediaStream(element, stream)
-
桌面共享流渲染进视频控件
Parameters:
Name Type Description elementObject - 视频控件对象
streamObject - 桌面共享流
-
attachVideoElementMediaStream(element, stream)
-
视频流渲染进视频控件
Parameters:
Name Type Description elementObject - 视频控件对象
streamObject - 视频流
-
bindAudioToVideo(audioId, videoId)
-
仅针对有微信小程序端加入的情况下使用,且当前web端有多个摄像头。一个摄像头原则上不用调该接口。
Parameters:
Name Type Description audioIdString 音频设备ID
videoIdString 视频设备ID
-
closeBoardById(boardId)
-
关闭指定的共享白板
Parameters:
Name Type Description boardIdString 白板Id
-
closeMobileBackVideo()
-
针对移动端H5关闭后置摄像头
-
closeMobileFrontVideo()
-
针对移动端H5关闭前置摄像头
-
createBoard(width, height, backgroundColor, backgroundImage, outputWidth, outputHeight, title)
-
创建白板
Parameters:
Name Type Description widthint 白板的渲染宽度
heightint 白板的渲染高度
backgroundColorString 白板的背景色
backgroundImageString 白板的背景图访问路径
outputWidthint 白板的输出宽度
outputHeightint 白板的输出高度
titleString 白板标题
-
getAllBoards()
-
获取所有的白板
-
getAudio(microphoneId)
-
获取Audio对象
Parameters:
Name Type Description microphoneIdString 麦克风设备ID
Returns:
- audio Audio对象
- Type
- Object
-
getBoard(boardId)
-
通过白板Id获取白板
Parameters:
Name Type Description boardIdString 白板Id
-
getScreen()
-
获取Screen对象
Returns:
- screen Screen对象
- Type
- Object
-
getUserData(userId)
-
获得用户的扩展信息
Parameters:
Name Type Description userIdString 用户id不填,表示自己
-
getVideo(cameraId)
-
获取Video对象
Parameters:
Name Type Description cameraIdString 摄像头设备Id
Returns:
- video Video对象
- Type
- Object
-
openCameraAndMicrophone(video, audio, videoElement, audioElement)
-
打开摄像头和麦克风
Parameters:
Name Type Description videoObejct video对象
audioObejct audio对象
videoElementObject 视频控件对象
audioElementObject 音频控件对象
-
openMobileBackVideo(element)
-
针对移动端H5打开后置摄像头
Parameters:
Name Type Description elementObject 视频控件对象
-
openMobileFrontVideo(element)
-
针对移动端H5打开前置摄像头
Parameters:
Name Type Description elementObject 视频控件对象
-
remotecmdCloseMicrophone(userId)
-
命令远端用户关闭麦克风
Parameters:
Name Type Description userIdString 远端用户Id
-
remotecmdMuteMicrophone(userId)
-
命令远端用户麦克风静音
Parameters:
Name Type Description userIdString 远端用户Id
-
remotecmdOpenMicrophone(userId)
-
命令远端用户打开麦克风
Parameters:
Name Type Description userIdString 远端用户Id
-
remotecmdPublishCamera(video)
-
命令远端用户发布某一摄像头视频
Parameters:
Name Type Description videoObejct 视频对象
-
remotecmdUnmuteMicrophone(userId)
-
命令远端用户麦克风取消静音
Parameters:
Name Type Description userIdString 远端用户Id
-
remotecmdUnpublishCamera(userId, cameraId)
-
命令远端用户取消发布摄像头视频
Parameters:
Name Type Description userIdString 用户Id
cameraIdString 摄像头设备Id
-
removeBoard(userId)
-
删除自己所属的全部白板
Parameters:
Name Type Description userIdString 白板创建者Id
-
removeBoardById(boardId)
-
删除指定的白板
Parameters:
Name Type Description boardIdString 白板Id
-
shareBoardById(boardId, reJoinConnected)
-
共享指定白板
Parameters:
Name Type Description boardIdString 白板Id
reJoinConnectedBoolean 重新加会连接成功状态
-
updateBoard(board)
-
更新白板
Parameters:
Name Type Description boardObject 对象
-
updateUserData(userData)
-
更新用户扩展内容
Parameters:
Name Type Description userDataString 用户扩展内容
-
updateUserName(userName)
-
更新用户名称
Parameters:
Name Type Description userNameString 用户名称