智慧服务,成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 客户端SDK参考 > Web SDK > 接口参考 UIPlugin插件设置

入门使用

UIPlugin插件设置

更新时间:2019-11-20

接口名称

接口描述

resetNativeWndSize

设置UIPlugin插件窗口尺寸及联动时相对浏览器的偏移比例。

uiPluginSetButtonState

设置UI按钮的状态(开启或关闭)。

uiPluginShowSmallWindow

显示或隐藏本地小窗口。

uiPluginShowAnnotationTool

显示标注工具栏。

uiPluginSetWindowTitle

设置P2P呼叫窗口标题。

uiPluginSetWindowSizeAbsolutePos

设置窗口大小和绝对位置

uiPluginSetWindowSizeRelativePos

设置窗口大小和联动时偏移比例

uiPluginShowVideoWindow

显示/隐藏视频窗口

uiPluginShowShareSelectwnd

显示共享窗口选择

resetNativeWndSize

接口描述

设置UIPlugin插件窗口尺寸及联动时相对浏览器的偏移比例。

注意事项

推荐使用uiPluginSetWindowSizeRelativePos新接口实现该功能,该接口即将废弃。

方法定义

resetNativeWndSize(nativeWndParam: EC_NativeWindowParam): void
 

参数描述

参数

是否必须

类型

描述

nativeWndParam

EC_NativeWindowParam

UIPlugin插件窗口参数。

返回值

无。

代码示例

function setConfNativeWndMinimize() {
	var nativeWndParam = {
		width: 0, 
		height: 0,
	};
	client.resetNativeWndSize(nativeWndParam);	
}

function setConfNativeWndSmall() {
	var nativeWndParam = {
		width: 480, 
		height: 352,
	};
	client.resetNativeWndSize(nativeWndParam);	
}
 

uiPluginSetButtonState

接口描述

设置UI按钮的状态(开启或关闭)。

注意事项

无。

方法定义

uiPluginSetButtonState(button: number, isOff: number, callbacks: Function): void
 

参数描述

参数

是否必须

类型

描述

button

number

按钮。

  • 0 麦克风
  • 1 摄相头
  • 2 扬声器
  • 3 邀请成员
  • 4 显示成员列表

isOff

number

是否关闭。

  • 0 打开
  • 1 关闭

callbacks

Function

回调函数。成功返回结果,失败返回错误信息。

返回值

无。

代码示例

onPluginEvtClickAddMember:function(ret){
	var transfer2ConfParam = null;
	var memberList=prompt("Please enter the invitee number","")

	if(ret.info.videoType == 0){
		if(memberList!=undefined && memberList!=null && memberList!=""){
			var memberListArr = memberList.split(",");
			var memberListTemp = new Array();
			for (var i = 0; i < memberListArr.length; i++) {
				memberListTemp[i] = { number: memberListArr[i], name: "", smsPhone: "", email: "", autoInvite: 1, role: 0,extensions: "" };
			}
			transfer2ConfParam = { attendees: memberListTemp }	
		}else{
			transfer2ConfParam=null;
		}
		client.transfer2Conf(transfer2ConfParam);	
	}else{
		if(memberList!=undefined && memberList!=null && memberList!=""){
			var cloudecAttendeesArray = memberList.split(",");
			var cloudecAttendees = new Array();
			for (var i = 0; i < cloudecAttendeesArray.length; i++) {
				cloudecAttendees[i] = { number: cloudecAttendeesArray[i], name: cloudecAttendeesArray[i], role: 0 };
			}
	
			client.addAttendee(cloudecAttendees);
		}else{
			console.log("attendee number is empty");       
			return;
		}
	}
	client.uiPluginSetButtonState(3,1,(ret) => {});

}
 

uiPluginShowSmallWindow

接口描述

显示或隐藏本地小窗口。

注意事项

当视频窗口中的本地小窗口显示时,调用此接口会隐藏本地小窗口;当视频窗口中的本地小窗口隐藏时,调用此接口会显示本地小窗口。

方法定义

uiPluginShowSmallWindow(callbacks: Function): void
 

参数描述

参数

是否必须

类型

描述

callbacks

Function

回调函数。成功返回结果,失败返回错误信息。

返回值

无。

代码示例

function uiPluginShowSmallWindow() {
	client.uiPluginShowSmallWindow((data)=>{});	
}
 

uiPluginShowAnnotationTool

接口描述

显示标注工具栏。

注意事项

无。

方法定义

uiPluginShowAnnotationTool(callbacks: Function): void
 

参数描述

参数

是否必须

类型

描述

callbacks

Function

回调函数。成功返回结果,失败返回错误信息。

返回值

无。

代码示例

function uiPluginShowAnnotationTool() {
	client.uiPluginShowAnnotationTool((data)=>{});	
}
 

uiPluginSetWindowTitle

接口描述

设置P2P呼叫窗口标题。

注意事项

无。

方法定义

uiPluginSetWindowTitle(title : string, callbacks: Function): void
 

参数描述

参数

是否必须

类型

描述

title

string

窗口标题,最大511字节。

callbacks

Function

回调函数。成功返回结果,失败返回错误信息。

返回值

无。

代码示例

function uiPluginSetWindowTitle() {
	var uiWndTitle = document.getElementById("ui_window_title").value;
	client.uiPluginSetWindowTitle(uiWndTitle,(data)=>{});	
}
 

uiPluginSetWindowSizeAbsolutePos

接口描述

设置窗口大小和绝对位置。

注意事项

无。

方法定义

uiPluginSetWindowSizeAbsolutePos(wndSizeAbsPosParam: EC_WindowSizeAbsPosParam, callbacks: Function): void
 

参数描述

参数

是否必须

类型

描述

wndSizeAbsPosParam

EC_WindowSizeAbsPosParam

窗口大小和绝对位置信息。

callbacks

Function

回调函数。成功返回结果,失败返回错误信息。

返回值

无。

代码示例

function setConfNativeWndPosition() {
	var uiWndLeftTopX = document.getElementById("ui_window_left_top_x").value;
	var uiWndLeftTopY = document.getElementById("ui_window_left_top_y").value;
	var wndSizeAbsPosParam = {
		width : 0,
		height : 0,
		leftTopX : parseInt(uiWndLeftTopX),
		leftTopY : parseInt(uiWndLeftTopY),
	}
	client.uiPluginSetWindowSizeAbsolutePos(wndSizeAbsPosParam, (data)=>{});	
}
 

uiPluginSetWindowSizeRelativePos

接口描述

设置窗口大小和联动时偏移比例。

注意事项

无。

方法定义

uiPluginSetWindowSizeRelativePos(wndSizeRelPosParam: EC_WindowSizeRelPosParam, callbacks: Function): void
 

参数描述

参数

是否必须

类型

描述

wndSizeRelPosParam

EC_WindowSizeRelPosParam

窗口大小和联动时相对位置参数

callbacks

Function

回调函数。成功返回结果,失败返回错误信息。

返回值

无。

代码示例

function setConfNativeWndRelativePosition() {
	var wndSizeRelPosParam= {
        xOffsetRate:10,      
        yOffsetRate:10,      
        width:0,    
        height:0, 
	}
	client.uiPluginSetWindowSizeRelativePos(wndSizeRelPosParam, (data)=>{});
}
 

uiPluginShowVideoWindow

接口描述

显示/隐藏视频窗口。

注意事项

无。

方法定义

uiPluginShowVideoWindow(callbacks: Function): void
 

参数描述

参数

是否必须

类型

描述

callbacks

Function

回调函数。成功返回结果,失败返回错误信息。

返回值

无。

代码示例

function uiPluginShowVideoWindow() {
	client.uiPluginShowVideoWindow((data)=>{});	
}
 

uiPluginShowShareSelectwnd

接口描述

显示共享窗口选择。

注意事项

无。

方法定义

uiPluginShowShareSelectwnd(callbacks: Function): void
 

参数描述

参数

是否必须

类型

描述

callbacks

Function

回调函数。成功返回结果,失败返回错误信息。

返回值

无。

代码示例

function uiPluginShowShareSelectwnd() {
	client.uiPluginShowShareSelectwnd((data)=>{});	
}