Class: User

User

new User(id, name, data, password)

User构造函数。
Parameters:
Name Type Description
id String 用户id
name String 用户名称
data String 用户扩展字段
password String 房间密码或主持人密码
Source:

Methods

addCallback(type, callback)

用户级别的回调
Parameters:
Name Type Description
type UserCallback 回调枚举标识
callback Object 回调方法名,可以自定义
Source:
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.subscrible_microphone_result, onSubscribleMicrophoneResult);
user.addCallback(UserCallback.unsubscrible_microphone_result, onUnsubscribleMicrophoneResult);


麦克风状态更新
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 :cameraId- 桌面共享设备ID

function onSubscribleScreenResult(stream, userId, userName,screenId) {

}


取消订阅远端桌面共享流反馈
param :userId- 所属用户ID
param :userName-所属用户名称
param : cameraId-桌面共享设备ID

function onUnsubscribleScreenResult(userId, userName,screenId){

}


订阅远端音频流反馈
param:stream- 远端音频流
param:userId- 所属用户ID
param:userName-所属用户名称

function onSubscribleMicrophoneResult(stream, userId, userName){

} 



取消订阅远端音频流反馈
param :userId- 所属用户ID
param : userName-所属用户名称

function onUnsubscribleMicrophoneResult(userId, userName){ 

}

attachAudioElementMediaStream(element, stream)

音频流渲染进音频控件
Parameters:
Name Type Description
element Object - 音频控件
stream Object - 音频流
Source:

attachScreenElementMediaStream(element, stream)

桌面共享流渲染进视频控件
Parameters:
Name Type Description
element Object - 视频控件
stream Object - 桌面共享流
Source:

attachVideoElementMediaStream(element, stream)

视频流渲染进视频控件
Parameters:
Name Type Description
element Object - 视频控件
stream Object - 视频流
Source:

getAudio(microphoneId)

获取Audio对象
Parameters:
Name Type Description
microphoneId String 麦克风设备ID
Source:

getScreen(screenId)

获取screen对象
Parameters:
Name Type Description
screenId String 桌面共桌Id,获取自己时,可以不填
Source:

getUserData(userId)

获得用户的扩展信息
Parameters:
Name Type Description
userId String 用户id,不填,表示自己
Source:

getVideo(cameraId)

获取video对象
Parameters:
Name Type Description
cameraId String 摄像头设备Id
Source:

openCameraAndMicrophone(video, audio, videoElement, audioElement)

预览摄像头及发布流和打开麦克风
Parameters:
Name Type Description
video Video video对象
audio Audio audio对象
videoElement Object 视频控件
audioElement Object 音频控件
Source:

remotecmdCloseMicrophone(userId)

命令远端用户关闭麦克风
Parameters:
Name Type Description
userId String 远端用户Id
Source:

remotecmdOpenMicrophone(userId)

命令远端用户打开麦克风
Parameters:
Name Type Description
userId String 远端用户Id
Source:

remotecmdPublishCamera(video)

命令远端用户发布某一摄像头视频
Parameters:
Name Type Description
video Object 视频对象,可预设分辨率等参数
Source:

remotecmdUnpublishCamera(cameraId)

命令远端用户取消发布摄像头视频
Parameters:
Name Type Description
cameraId String 摄像头设备Id
Source:

updateUserData(userData)

更新用户扩展内容
Parameters:
Name Type Description
userData String 用户扩展内容
Source: