Global

Members

(constant) annoSelectTypeEnum :number

Description:

  • 注释选择类别

Properties:
Name Type Description
mouse number
draw number
eraser number

注释选择类别

Type:
  • number

(constant) AnnotationInitTypeEnum :String

Description:

  • 批注层初始化类型枚举

Properties:
Name Type Description
proportional String

按比例缩放，推荐外部容器为div，此模式下SDK会根据外部容器元素宽高计算渲染的白板宽高，渲染的远端白板可以保持比例，不会造成画笔或者背景图的形变；SDK会自动创建背景层，无需应用层自动创建，SDK会自动更新背景图和背景色及下载白板时可以带背景层下载
full String

平铺，外部容器可以为div也可以直接传入canvas，此模式下白板会撑满容器的宽高，可能会和远端白板比例不一致，造成画笔或者背景图的形变

批注层初始化类型枚举

Type:
  • String

(constant) appDataKeyEnum :String

Description:

  • 房间级别的AppData中KEY枚举

Properties:
Name Type Description
lecturer String

当前发言人userId，通过语音激励来获取音量最大的用户
voiceActivated String

服务器下发的要求汇报人userId,如等于自己,进行语音激励汇报

房间级别的AppData中KEY枚举

Type:
  • String

(constant) Appender :number

Description:

  • 日志显示方式枚举

Properties:
Name Type Description
alert number

使用alert语句显示日志
inpage number

内嵌到页面显示日志
popup number

弹出对话框显示日志
browserConsole number

浏览器控制台显示日志

日志显示方式枚举

Type:
  • number

(constant) arrowTypeEnum :number

Description:

  • 箭头类别

Properties:
Name Type Description
none number
begin number
end number
double number

箭头类别

Type:
  • number

(constant) AudioCodingType :number

Description:

  • 音频编码格式枚举

Properties:
Name Type Description
ISAC_16k number
ISAC_32k number
opus number
G722 number
PCMA number
PCMU number

音频编码格式枚举

Type:
  • number

(constant) boardStatusEnum :number

Description:

  • 注释选择类别

Properties:
Name Type Description
close number
open number

注释选择类别

Type:
  • number

(constant) CameraType :number

Description:

  • 摄像头前后置枚举

Properties:
Name Type Description
unknown number

未知
front number

前置
back number

后置

摄像头前后置枚举

Type:
  • number

(constant) canvasTypeEnum :number

Description:

  • 注释形状类别

Properties:
Name Type Description
mouse number
line number
rect number
ellipse number
polyline number
hlight_point number
hlight_texttag number
eraser number
rhomb number
arrow number
success number
failure number
clear number

注释形状类别

Type:
  • number

(constant) changeTypeEnum :number

Description:

  • 引擎级别设备变化事件类型枚举

Properties:
Name Type Description
remove number
add number

引擎级别设备变化事件类型枚举

Type:
  • number

(constant) connectionEventTypeEnum :number

Description:

  • 箭头类别

Properties:
Name Type Description
sendVideo number
recvVideo number
sendAudio number
recvAudio number
conndidate number

箭头类别

Type:
  • number

(constant) ConnectionStatus :number

Description:

  • 网络状态枚举

Properties:
Name Type Description
init number

初始状态
connecting number

连接中
connected number

连接成功
connectFailed number

连接失败
reJoinRoomTimeOut number

重新加会超时
reJoinConnected number

重新加会成功
reconnected number

重连成功

网络状态枚举

Type:
  • number

(constant) DataCryptoType :number

Description:

  • 数据加密类型枚举

Properties:
Name Type Description
AES128 number
AES256 number
SM4 number

数据加密类型枚举

Type:
  • number

(constant) exporterStatusEnum :number

Description:

  • 录制状态枚举

Properties:
Name Type Description
stop number
live number
pause number

录制状态枚举

Type:
  • number

(constant) exporterTypeEnum :number

Description:

  • 创建流导出类型枚举

Properties:
Name Type Description
record number
record_real_time number
liver number
avc_media_mixer number

创建流导出类型枚举

Type:
  • number

(constant) fillTypeEnum :number

Description:

  • 填充类别

Properties:
Name Type Description
none number
full number

填充类别

Type:
  • number

(constant) LiveEnum :number

Description:

  • 直播的各种类型枚举

Properties:
Name Type Description
VideoType number
AudioType number

直播的各种类型枚举

Type:
  • number

(constant) LogLevel :number

Description:

  • 日志显示级别枚举

Properties:
Name Type Description
all number
trace number
debug number
info number
warn number
error number
fatal number
off number

日志显示级别枚举

Type:
  • number

(constant) OperType :number

Description:

  • 操作类型枚举

Properties:
Name Type Description
add number
remove number
update number
share number
close number

操作类型枚举

Type:
  • number

(constant) RecordEnum :number

Description:

  • 录制各种类型枚举

Properties:
Name Type Description
VideoType number
AudioType number
FileType number

录制各种类型枚举

Type:
  • number

(constant) recorderAudioEnum :string

Description:

  • 录制声音枚举

Properties:
Name Type Description
AVD_userId_allUser string

所有用户
AVD_userId_allUserWithoutMe string

除自己外的所有用户
AVD_userId_noneUser string

没有用户

录制声音枚举

Type:
  • string

(constant) Resolution :Object

Description:

  • 分辨率枚举

Properties:
Name Type Description
"1920*1280" Object
"1920*1080" Object
"1280*1024" Object
"1280*720" Object
"960*720" Object
"640*1024" Object
"640*960" Object
"640*480" Object
"640*360" Object
"508*360" Object
"480*854" Object
"480*800" Object
"320*480" Object
"320*240" Object
"320*180" Object
"160*120" Object

分辨率枚举

Type:
  • Object

(constant) ResolutionSetType :number

Description:

  • 分辨率设置类型枚举

Properties:
Name Type Description
exact number

强制使用该分辨率（不支持则报错）
ideal number

期望分辨率（不支持时可向下兼容）

分辨率设置类型枚举

Type:
  • number

(constant) RoomCallback :String

Description:

  • 房间级别callback枚举

Properties:
Name Type Description
connection_status String
connection_indicator String
room_status_notify String
app_data_notify String
user_data_notify String
user_name_notify String
public_data String
private_data String
private_data_to_user String
public_message String
private_message String
user_join_notify String
user_leave_notify String
leave_indication String
close_room_result String
close_room_notify String
screen_sharing_ended String
mcu_peerconnection_completed String
outgoing_invite_status_notify String
room_control_change_notify String
mediaplay_started_notify String
mediaplay_stoped_notify String
mediaplay_progress_notify String
stream_keep_alive_timeout_notify String

房间级别callback枚举

Type:
  • String

(constant) RoomStateEnum :String

Description:

  • 房间状态

Properties:
Name Type Description
DISCONNECTED String

未通过join加入房间或者已经通过leave离开房间
CONNECTING String

调用join时为此状态
CONNECTED String

已经加入房间
RECONNECTING String

正在重新加会
DISCONNECTING String

调用leave、重连中、重新加会中

房间状态

Type:
  • String

(constant) RoomStatus :number

Description:

  • 房间状态枚举

Properties:
Name Type Description
scheduled number
opening number
locked number
closed number

房间状态枚举

Type:
  • number

(constant) RoomTypeEnum :String

Description:

  • 房间类型枚举

Properties:
Name Type Description
join_host_first String
net_acc String
host_control String
free_speech String

房间类型枚举

Type:
  • String

(constant) ScreenDisplaySurface :string

Description:

  • 桌面共享弹窗显示内容选项

Properties:
Name Type Description
browser string

Prefer to share a browser tab
window string

Prefer to share a window
monitor string

Prefer to share an entire screen
preferCurrentTab string

refer Current browser Tab

桌面共享弹窗显示内容选项

Type:
  • string

(constant) shapeTypeEnum :String

Description:

  • 注释形状类别

Properties:
Name Type Description
mouse String
line String
rect String
ellipse String
polyline String
hlight_point String
hlight_texttag String
eraser String
rhomb String
arrow String
success String
failure String
clear String
img String
txt String

注释形状类别

Type:
  • String

(constant) StreamStatus :number

Description:

  • 流状态枚举

Properties:
Name Type Description
none number
init number

初始状态
published number

流发布状态
muted number

流禁用状态
forbided number
subed number
opened number

流状态枚举

Type:
  • number

(constant) UserCallback :String

Description:

  • 用户级别callback枚举

Properties:
Name Type Description
microphone_status_notify String
camera_status_notify String
screen_status_notify String
screen_audio_status_notify String
camera_data_notify String
screen_data_notify String
publish_camera_notify String
unpublish_camera_notify String
subscrible_camera_result String
unsubscrible_camera_result String
publish_screen_notify String
unpublish_screen_notify String
subscrible_screen_result String
unsubscrible_screen_result String
publish_microphone_notify String
unpublish_microphone_notify String
subscrible_microphone_result String
unsubscrible_microphone_result String
board_add_result String
board_update_result String
board_remove_result String
board_share_result String
board_close_result String
room_set_stream_name_rep_success String
room_set_stream_name_rep_error String
video_stream_control_rep_success String
video_stream_control_rep_error String
subscrible_screen_audio_result String
unsubscrible_screen_audio_result String

用户级别callback枚举

Type:
  • String

(constant) VideoCodingType :number

Description:

  • 视频编码格式枚举

Properties:
Name Type Description
VP8 number
VP9 number
H264 number

视频编码格式枚举

Type:
  • number

(constant) VideoQualityType :number

Description:

  • 视频质量枚举

Properties:
Name Type Description
high number

高
normal number

中
low number

低

视频质量枚举

Type:
  • number

(constant) viewLayoutModeEnum :number

Description:

  • 混屏布局枚举

Properties:
Name Type Description
fixation number

手动布局
auto number

画廊自动布局
auto_orato number

演讲者自动布局

混屏布局枚举

Type:
  • number

Methods

getCompatibleSize(outWidth, outHeight, contentWidth, contentHeight)

Description:

  • 通过外部盒子和内容盒子的宽高，算出内容盒子撑满外部盒子的宽或者高的结果

Parameters:
Name Type Description
outWidth int

外部容器宽
outHeight int

外部容器高
contentWidth int

内容的宽
contentHeight int

内容的高