跳到主要内容

MeetingApi

MeetingApi


new MeetingApi()

Meeting SDK入口

Methods


<async> Mute(params) → {promise}

哑音操作

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
muteboolean

0: 取消哑音; 1: 哑音;

Returns:

返回一个promise

Type

promise


<async> Silence(params) → {promise}

静音操作

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
silenceboolean

0: 取消静音; 1: 静音;

Returns:

返回一个promise

Type

promise


<async> addCallback(name, callback) → {promise}

设置meetingSDK回调接口

Parameters:
NameTypeDescription
namestring回调名
callbackfunction回调函数
Returns:

返回一个promise

Type

promise


<async> addMts(conf_id, from_audiences, mtlist) → {promise}

批量添加本级终端

Parameters:

NameTypeDescription
conf_idstring会议conf_id
from_audiencesnumber是否是从观众席切换过来的,非切换可不填写此参数. 0-否;1-是;
mtlistarray终端对象数组, 终端对象具体内容请参见 "科达视讯平台会控API"-"批量添加本级终端"

Returns:

返回一个promise,data.mts:添加的终端数组

Type

promise


<async> applyBroadcast() → {promise}

举手:申请成为发言人

Returns:

返回一个promise

Type

promise


<async>changeRemoteCameraStatus(params)→ {promise}

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
userIdstring

用户id

bTurnOnuint32_t

摄像头状态

指定远端用户摄像头状态

Parameters:


<async> confNameChange(conf_id, conf_name) → {promise}

修改会议名称

Parameters:

NameTypeDescription
conf_idstring

会议id

conf_namestring
会议名称
1.字符限制:
a.仅允许输入:英文、汉字、数字、符号包含下划线【_】、减号【-】、小数点【.】、左括号【(】、右括号【)】、@、#
b.不支持输入特殊字符:% & * ^ ~ ' " " ? / \ < > | ` " $
c.且首字符和尾字符仅允许输入:英文、数字、汉字
2.最大字符长度:128个字节,最大字符:32字符

Returns:

返回一个promise

Type

promise


<async> confSubscribeCmd(subscribe) → {promise}

终端向平台订阅:终端上/下线消息

Parameters:

NameTypeDescription
subscribeboolean

Returns:

返回一个promise

Type

promise


<async> createBookedConf(createParams) → {promise}

创建预约会议

Parameters:

NameTypeDescription
createParamsobject

创会参数,具体数据参见 "科达视讯平台会管API"

Properties
NameTypeDescription
conf_namestring

会议名称

start_timestring

会议开始时间

durationnumber

会议时长

bitratenumber

会议码率

conf_typenumber

会议类型

max_join_mtnumber

最大与会终端数

bHighDefinitionnumber

主视频码率,1:1080p,其他为720p

Returns:

返回一个promise,data.conf_id:会议conf_id,data.meeting_id:会议meeting_id

Type

promise


<async> createConf(createParams) → {promise}

创建即时会议

Parameters:

NameTypeDescription
createParamsobject

创会参数,具体数据参见 "科达视讯平台会管API"

Properties
NameTypeDescription
conf_namestring

会议名称

durationnumber

会议时长

bitratenumber

会议码率

conf_typenumber

会议类型

max_join_mtnumber

最大与会终端数

bHighDefinitionnumber

主视频码率,1:1080p,其他为720p

Returns:

返回一个promise,data.conf_id:会议conf_id,data.meeting_id:会议meeting_id

Type

promise


<async> createVirtualMeetingRoom(createParams) → {promise}

创建虚拟会议室

Parameters:

NameTypeDescription
createParamsCreateVirtualMeetingRoomParam

虚拟会议室参数

Properties
NameTypeDescription
conf_namestring

会议名称

bitratenumber

会议码率

conf_typenumber

会议类型

max_join_mtnumber

最大与会终端数

bHighDefinitionnumber

主视频码率,1:1080p,其他为720p

Returns:

返回一个promise, data.id:虚拟会议室id

Type

promise


<async> delBookedConf(conf_id) → {promise}

删除预约会议

Parameters:

NameTypeDescription
conf_idstring会议conf_id

Returns:

返回一个promise

Type

promise


<async> delMts(conf_id, mtidlist) → {promise}

批量删除本级终端

Parameters:

NameTypeDescription
conf_idstring会议conf_id
mtidlistarray终端id数组, id最大字符长度:48个字节

Returns:

返回一个promise

Type

promise


<async> delVirtualMeetingRoom(virtual_room_id) → {promise}

删除虚拟会议室

Parameters:

NameTypeDescription
virtual_room_idstring虚拟会议室ID

Returns:

返回一个promise

Type

promise


<async> delayConf(conf_id, time) → {promise}

延长会议时间

Parameters:

NameTypeDescription
conf_idstring会议id
timenumber延长的时间,单位:分钟

Returns:

返回一个promise

Type

promise


<async> endConf(conf_id, endSubConf) → {promise}

结束即时会议

Parameters:

NameTypeDescription
conf_idstring会议conf_id
endSubConfnumber是否结束级联会议,不传默认为0, 0-否, 1-是.

Returns:

返回一个promise

Type

promise


<async> getChairman(conf_id) → {promise}

获取主席

Parameters:

NameTypeDescription
conf_idstring会议id

Returns:

返回一个promise, data.mt_id:主席id

Type

promise


<async> getCurrentDevice(device_type) → {promise}

获取当前使用的设备id

Parameters:

NameTypeDescription
device_typenumber设备类型 0:麦克风,1:扬声器,2:摄像头

Returns:

返回一个promise, data为id

Type

promise


<async> getDeviceList(device_type) → {promise}

获取设备列表

Parameters:

NameTypeDescription
device_typenumber设备类型 0:麦克风, 1:扬声器, 2:摄像头

Returns:

返回一个promise,data为设备列表

Type

promise


<async> getKrtcSdkToken(user_id) → {promise}

获取KrtcSdk Token

Parameters:

NameTypeDescription
user_idstring用户id

Returns:

返回一个promise,data.KrtcSdkToken为token值

Type

promise


<async> getMeetingInfo(meeting_id) → {promise}

获得会议信息

Parameters:

NameTypeDescription
meeting_idstring会议meeting_id,非conf_id

Returns:

返回一个promise, data为会议信息

Type

promise


<async> getMeetings(start, count, order, start_time, end_time, state) → {promise}

获得全部会议列表

Parameters:

NameTypeDescription
startnumber默认为0,即从符合条件的数据中的第几行取数据,0为第一行数据
countnumber默认为10,即在包含start在内的后count条数据,如果参数为0表示获取所有
ordernumber保留,默认为0
start_timestring开始时间,格式为ISO8601:2000标准(例: "2016-11-11T15:30:00+08:00"),不填表示从服务器当前时间开始
end_timestring结束时间,格式为ISO8601:2000标准(例: "2016-11-11T19:30:00+08:00"),不填表示从开始时间以后的所有
statenumber会议状态:1:预约,2:开始,3:结束,6:待审批,7:审批不通过, 不传返回所有

Returns:

返回一个promise, data.total:会议数量,data.meetings:会议列表

Type

promise


<async> getMts(conf_id) → {promise}

获取会议终端列表

Parameters:

NameTypeDescription
conf_idstring会议conf_id

Returns:

返回一个promise, data.mts:会议终端列表

Type

promise


<async> getOngoingConfInfo(conf_id) → {promise}

获取即时会议信息

Parameters:

NameTypeDescription
conf_idstring会议id

Returns:

返回一个promise,data为会议信息

Type

promise


<async> getOngoingConfs(own_conf, start, count, matches) → {promise}

获得即时会议列表

Parameters:

NameTypeDescription
own_confnumber是否仅获取与自己相关的会议(自己为创建者或会议成员),默认为0. 0-否;1-是;
startnumber获取的视频会议列表的起始会议位置, 0表示第一个会议, 默认为0
countnumber获取的视频会议的个数, 即包括start在内的后count个会议, 0代表获取所有会议, 默认为10
matchesstring根据会议号码/会议发起人(姓名)/会议名称过滤会议

Returns:

返回一个promise, data.total:会议数量,data.confs:会议列表

Type

promise


<async> getShareLink(meeting_id) → {promise}

获取会议分享链接

Parameters:

NameTypeDescription
meeting_idstring

Returns:

返回一个promise,data.conf_link:分享链接

Type

promise


<async> getSpeaker(conf_id) → {promise}

获取发言人

Parameters:

NameTypeDescription
conf_idstring会议conf_id

Returns:

返回一个promise, data.mt_id:终端id, data.force_broadcast:是否强制广播

Type

promise


<async> getVirtualMeetingRoomInfo(virtual_room_id) → {promise}

获取虚拟会议室详情

Parameters:

NameTypeDescription
virtual_room_idstring虚拟会议室ID

Returns:

返回一个promise, data:会议室详情

Type

promise


<async> getVirtualMeetingRoomList(count, order, start) → {promise}

获取虚拟会议室列表

Parameters:

NameTypeDescription
countnumber获取的虚拟会议数,默认为10
ordernumber根据虚拟会议的时间排序,默认为0
startnumber虚拟会议的开始行,默认为0

Returns:

返回一个promise, data.virtual_meeting_rooms:虚拟会议室数组

Type

promise


<async> init(krtcSdkLogParam, krtcSdkInitParam) → {promise}

krtcsdk初始化

Parameters:

NameTypeDescription
krtcSdkLogParamobject

日志参数

Properties
NameTypeDescription
enableLogboolean

是否开启

logPathstring

路径

callbackfunction

日志回调

krtcSdkInitParamobject

音视频初始化参数

Properties
NameTypeDescription
customVideoCaptureboolean

启用或关闭自定义视频采集

customVideoRenderboolean

启用或关闭自定义视频渲染

customAudioCaptureboolean

启用或关闭自定义音频采集

customAudioPlayoutboolean

启用或关闭自定义音频输出

customVideoEncodeboolean

启用或关闭自定义视频编码

customVideoDecodeboolean

启用或关闭自定义视频解码

Returns:

返回一个promise

Type

promise


<async> joinConf(params) → {promise}

加入会议

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
conf_idstring

会议id

bitratenumber

入会码率

Returns:

返回一个promise

Type

promise


<async> leaveConf() → {promise}

离开会议

Returns:

返回一个promise

Type

promise


<async> login(params) → {promise}

krtcsdk登录

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
serverAddrstring

服务器地址

idstring

用户id

tokenstring

krtcsdk token

nickNamestring

用户昵称

Returns:

返回一个promise

Type

promise


<async> loginEx(params) → {promise}

krtcsdk新登录接口

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
serverAddrstring

服务器地址: ipv4, ipv6, domain name

userCodestring

来自第三方的用户号,short code from thirdparty websit

userIDstring

用户id,匿名登录时填nullptr即可,第三方token认证不支持匿名登录

tokenstring

token

nickNamestring

用户别名(utf-8)

schemenumber

1: 使用标准digest认证登录; 2: 使用第三方网站token登录

kickRegistnumber

1: 允许重登陆; 0: 不允许重登陆

Returns:

返回一个promise

Type

promise


<async> logout(params) → {promise}

krtcsdk登出

Parameters:

NameTypeDescription
paramsobject参数对象:空

Returns:

返回一个promise

Type

promise


<async> modifyLocalLayoutStyle(params) → {promise}

改变本地流视频显示区域

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

param.render_param.widthnumber

宽度百分比的分子数字,例如:width = 50, 表示宽度占屏幕宽度的50%

param.render_param.heightnumber

高度百分比的分子数字,例如:height = 50, 表示高度占屏幕高度的50%

param.render_param.xnumber

以屏幕左上角为起始点(0,0),画面左上角横坐标数值相对于屏幕宽度百分比的分子数字x,
例如:x = 50,表示画面左上角横坐标数值占屏幕宽度的50%

param.render_param.ynumber

以屏幕左上角为起始点(0,0),画面左上角纵坐标数值相对于屏幕宽度百分比的分子数字y,
例如:y = 50, 表示画面左上角纵坐标数值占屏幕高度的50%

param.render_param.z_ordernumber

画面显示层次: 0 - low, 1 - mid, 2 - top

Returns:

返回一个promise

Type

promise


<async> mtCameraControl(conf_id, mt_id, state) → {promise}

终端摄像头控制(开关参会人视频)

Parameters:

NameTypeDescription
conf_idstring会议id
mt_idstring终端id
statenumber是否打开,0-打开;1-关闭;

Returns:

返回一个promise

Type

promise


<async> muteConf(conf_id, mute, force_mute) → {promise}

会场哑音

Parameters:

NameTypeDescription
conf_idstring会议id
mutenumber哑音状态,0-停止静音;1-静音;
force_mutenumber全场哑音下是否禁止终端取消自身哑音 默认为0, 0-否;1-是;

Returns:

返回一个promise

Type

promise


<async> muteMt(conf_id, mt_id, mute) → {promise}

终端哑音(开关参会人麦克风)

Parameters:

NameTypeDescription
conf_idstring会议id
mt_idstring终端id
mutenumber是否哑音,0-停止哑音;1-哑音;

Returns:

返回一个promise

Type

promise


<async> selectDual(params) → {promise}

选看指定终端双流

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
user_idstring

指定对象id;

displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

Returns:

返回一个promise

Type

promise



<async> selectDualEx(params) → {promise}

选看指定终端双流单窗口

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
user_idstring

指定对象id;

displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

param.render_param.widthnumber

宽度百分比的分子数字,例如:width = 50, 表示宽度占屏幕宽度的50%

param.render_param.heightnumber

高度百分比的分子数字,例如:height = 50, 表示高度占屏幕高度的50%

param.render_param.xnumber

以屏幕左上角为起始点(0,0),画面左上角横坐标数值相对于屏幕宽度百分比的分子数字x,
例如:x = 50, 表示画面左上角横坐标数值占屏幕宽度的50%

param.render_param.ynumber

以屏幕左上角为起始点(0,0),画面左上角纵坐标数值相对于屏幕宽度百分比的分子数字y,
例如:y = 50, 表示画面左上角纵坐标数值占屏幕高度的50%

param.render_param.z_ordernumber

画面显示层次: 0 - low, 1 - mid, 2 - top

#### Returns:

返回一个promise

Type

promise



<async> selectMix(params) → {promise}

选看混音器

Parameters:

NameTypeDescription
paramsobject参数对象:空

Returns:

返回一个promise

Type

promise


<async> selectMt(params) → {promise}

选看指定终端

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
user_idstring

指定对象id;

layer_indexnumber

分辨率层索引号:0,1,2分别是低,中,高

displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

Returns:

返回一个promise

Type

promise


<async> selectMtEx(params) → {promise}

选看指定终端单窗口

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
user_idstring

指定对象id

layer_indexnumber

分辨率层索引号:0,1,2分别是低,中,高

displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

param.render_param.widthnumber

宽度百分比的分子数字,例如:width = 50, 表示宽度占屏幕宽度的50%

param.render_param.heightnumber

高度百分比的分子数字,例如:height = 50, 表示高度占屏幕高度的50%

param.render_param.xnumber

以屏幕左上角为起始点(0,0),画面左上角横坐标数值相对于屏幕宽度百分比的分子数字x,
例如:x = 50, 表示画面左上角横坐标数值占屏幕宽度的50%

param.render_param.ynumber

以屏幕左上角为起始点(0,0),画面左上角纵坐标数值相对于屏幕宽度百分比的分子数字y,
例如:y = 50, 表示画面左上角纵坐标数值占屏幕高度的50%

param.render_param.z_ordernumber

画面显示层次: 0 - low, 1 - mid, 2 - top

params.logostring

台标字符

Returns:

返回一个promise

Type

promise


<async> selectVmpVideo(params) → {promise}

选看画面合成器

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

Returns:

返回一个promise

Type

promise


<async> setCurrentDevice(device_type, devcice_id) → {promise}

设置当前设备

Parameters:

NameTypeDescription
device_typenumber设备类型 0:麦克风, 1:扬声器, 2:摄像头
devcice_idstring设备id

Returns:

返回一个promise

Type

promise


<async> setLocalStaticImage(params) → {promise}

设置静态图像

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
filepathstring

静态图像文件路径(必须是RGBA文件格式, 建议为1280*720像素图片)

logostring

文字图标

widthuint32

静态图像宽度

heightuint32

静态图像高度

xuint32

静态图像横坐标

yuint32

静态图像纵坐标

winIdint32

窗口buffer

Returns:

返回一个promise

Type

promise


<async> setMicVolume(level) → {promise}

调整麦克风音量

Parameters:

NameTypeDescription
levelnumber

音量等级 0-255

Returns:

返回一个promise

Type

promise


<async> setSpeakerVolume(level) → {promise}

调整扬声器音量

Parameters:

NameTypeDescription
levelnumber

音量等级 0-255

Returns:

返回一个promise

Type

promise


<async> setStaticImage(params) → {promise}

设置静态图像

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
filepathstring

静态图像文件路径(必须是RGBA文件格式, 建议为1280*720像素图片)

widthuint32

静态图像宽度

heightuint32

静态图像高度

Returns:

返回一个promise

Type

promise


<async> silenceConf(conf_id, silence) → {promise}

会场静音

Parameters:

NameTypeDescription
conf_idstring会议id
silencenumber静音状态,0-停止静音;1-静音;

Returns:

返回一个promise

Type

promise


<async> specChairman(conf_id, mt_id) → {promise}

指定主席

Parameters:

NameTypeDescription
conf_idstring会议id
mt_idstring设置主席的终端号,取消主席填空 最大字符长度:48个字节

Returns:

返回一个promise

Type

promise


<async> specSpeaker(conf_id, force_broadcast, mt_id) → {promise}

指定发言人

Parameters:

NameTypeDescription
conf_idstring会议conf_id
force_broadcastnumber是否设置发言人强制广播,仅SFU会议有效,默认为0。 0-否;1-是;
mt_idstring设置发言人的终端号,取消发言人填空 最大字符长度:48个字节

Returns:

返回一个promise

Type

promise


<async> startAudio(params) → {promise}

开始发送音频

Parameters:

NameTypeDescription
paramsobject参数对象: 空

Returns:

返回一个promise

Type

promise


<async> startCameraTest(params) → {promise}

开启摄像头测试

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
deviceIdstring

设备id

displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

mirrorboolean

镜像模式 true:镜像, false:不镜像

Returns:

返回一个promise,返回一个promise, data为返回值。 0:成功, -1:参数错误, -2:开始摄像头设备失败

Type

promise


<async> startDualVideo(params) → {promise}

开启双流(开启桌面共享)

Parameters:

NameTypeDescription
paramsobject

双流参数

Properties
NameTypeDescription
maxBitratenumber

最大码率

minBitratenumber

最小码率

Returns:

返回一个promise

Type

promise


<async> startLocalPreview(params) → {promise}

开启本地视频回显

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

Returns:

返回一个promise

Type

promise


<async> startLocalPreview(@param) → {promise}

开启本地视频回显单窗口

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

param.render_param.widthnumber

宽度百分比的分子数字,例如:width = 50, 表示宽度占屏幕宽度的50%

param.render_param.heightnumber

高度百分比的分子数字,例如:height = 50, 表示高度占屏幕高度的50%

param.render_param.xnumber

以屏幕左上角为起始点(0,0),画面左上角横坐标数值相对于屏幕宽度百分比的分子数字x,例如:x = 50, 表示画面左上角横坐标数值占屏幕宽度的50%

param.render_param.ynumber

以屏幕左上角为起始点(0,0),画面左上角纵坐标数值相对于屏幕宽度百分比的分子数字y,例如:y = 50, 表示画面左上角纵坐标数值占屏幕高度的50%

params.logostring

台标字符

Returns:

返回一个promise

Type

promise


<async> startMainVideo(@param) → {promise}

开始发送主视频

Parameters:

NameTypeDescription
@paramobjectparams - 参数对象
params.layer_countnumber同一条主流最多允许同时发送三层分辨率,双流仅允许发一层
params.max_resolutionnumber最高层分辨[320x180:0, 640x360:1, 1280x720:2, 480x270:3, 960x540:4, 1920x1080:5],中低层分辨率为 maxResolution/2,maxResolution/4
params.max_fpsnumber最大帧率
params.bitratearray每层流的码率(bps),索引0 1 2 分别代表 低 中 高

Returns:

返回一个promise

Type

promise


<async> startMicDeviceTest(devcice_id, callback) → {promise}

开始麦克风测试并获取麦克风音量

Parameters:

NameTypeDescription
devcice_idstring设备id
callbackonLocalAudioLevelCallback

回调函数

Returns:

返回一个promise

Type

promise


<async> startRecorders(conf_id, record_params) → {promise}

开启录像

Parameters:

NameTypeDescription
conf_idstring

会议id

record_paramsobject

录像参数

Properties
NameTypeDescription
video_namestring

录像保存的文件名称

recorder_typenumber

录像类型,1-会议录像;2-终端录像

publish_modestring

发布模式,0-不发布;1-发布

watermarkstring

是否添加水印.0-不添加水印;0-不添加水印

anonymousstring

是否支持免登陆观看直播,0-不支持;1-支持

recorder_modestring

录像模式,1-录像;2-直播;3-录像+直播

main_streamstring

是否录主格式码流

dual_streamstring

是否录双流

vrs_idstring

vrs的id信息,用于指定录像的vrs

membersarray

开启录像 仅当开启终端录像需要填写,只支持同时开启一个终端录像,格式:["mt_id":1 , "mt_id":2]

Returns:

返回一个promise, data.rec_id为录像机id

Type

promise


<async> startSpeakerDeviceTest(devcice_id, callback) → {promise}

开始扬声器测试

Parameters:

NameTypeDescription
device_idstring设备id
callbackonAudioPlayoutPowerCallback回调函数

Returns:

返回一个promise, data是返回值, 0:成功 -1:参数错误 -2:开始扬声器设备失败

Type

promise


<async> stopCamera() → {promise}

关闭摄像头

Returns:

返回一个promise

Type

promise


<async> stopCameraTest() → {promise}

停止摄像头测试

Returns:

返回一个promise

Type

promise


<async> stopDualVideo() → {promise}

停止双流(关闭桌面共享)

Returns:

返回一个promise

Type

promise


<async> stopLocalPreview(params) → {promise}

停止本地视频回显

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
displayWindowIdBuffer

显示窗口句柄, linux下仅支持xwindow id

Returns:

返回一个promise

Type

promise


<async> stopLocalStream(params) → {promise}

停止本地码流

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
stream_typenumber

码流类型, 0:主流视频; 1: 辅流视频; 2: 音频; 3: 画面合成码流; 4: 混音流

Returns:

返回一个promiseStream

Type

promise


<async> stopMicDeviceTest() → {promise}

停止麦克风测试

Returns:

返回一个promise

Type

promise


<async> stopRecorders(conf_id, rec_id, recorder_mode) → {promise}

停止录像

Parameters:

NameTypeDescription
conf_idstring会议conf_id
rec_idstring录像机id
recorder_modenumber录像模式

Returns:

返回一个promise

Type

promise


<async> stopSpeakerDeviceTest() → {promise}

停止扬声器测试

Returns:

返回一个promise

Type

promise


<async> unSelectStream(params) → {promise}

停止选看码流

Parameters:

NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
user_idstring

用户id

stream_typenumber

码流类型, 0:主流视频; 1: 辅流视频; 2: 音频; 3: 画面合成码流; 4: 混音流

Returns:

返回一个promiseStream

Type

promise


<async> updateBookedConf(createParams, conf_id) → {promise}

更新预约会议

Parameters:

NameTypeDescription
createParamsobject创会参数,具体数据参见 "科达视讯平台会管API"
conf_idstring会议conf_id

Returns:

返回一个promise,data.conf_id:会议conf_id,data.meeting_id:会议meeting_id

Type

promise


<async> updateVirtualMeetingRoom(virtual_room_id, createParams) → {promise}

修改虚拟会议室

Parameters:

NameTypeDescription
virtual_room_idstring虚拟会议室ID
createParamsCreateVirtualMeetingRoomParam虚拟会议室参数

Returns:

返回一个promise

Type

promise


<async> validConfName(conf_name, start_time, end_time, meeting_id) → {promise}

会议名称校验

Parameters:

NameTypeDescription
conf_namestring会议名称
start_timestring开始日期,格式为 2020-07-24T15:30:00+08:00,不填表示当前时间
end_timestring结束时间,格式为 2020-07-24T15:30:00+08:00, 不填表示永久会议
meeting_idnumber会议id,更新会议时必填

Returns:

返回一个promise, data.result:校验结果,1表示成功,无重名会议;0表示失败,有重名会议

Type

promise


<async> voiceActivation(conf_id, state, number) → {promise}

开启/关闭语音激励

Parameters:

NameTypeDescription
conf_idstring会议id
statenumber语音激励 0-关闭;1-开启;
numbernumber语音激励敏感度(s),最小值3s

Returns:

返回一个promise

Type

promise