SDK初始化,完成后,可开始登录和发起会议呼叫;
在初始化之前,您需要完成准备工作的内容,并开通应用获取appid;
完成后,可以在您的工程化项目中,安装并导入SDK库,并调用SDK创建一个XTClient。
import XYRTC from '@xylink/xy-mp-sdk';
/**
* Client配置参数
*
* @property { string } server - 非必填 服务地址, IP/域名 + 端口,如: wxrtc.xylink.com
* @property { string } appId - 非必填 SDK应用ID,通过小鱼易连企业管理平台创建
* @property { string } extId - 非必填 SDK企业ID,通过小鱼易连企业管理平台创建
* @property { string } layoutMode - 非必填 | AUTO | 布局模式,可选:AUTO | CUSTOM
* @property { string } logServer - 非必填 logServer服务地址,默认不需要配置
* @property { { offset?: number[]; } } container - 非必填 | {} | 配置layout container容器节点和偏移量
* @property { number[] } container.offset - 非必填 | [] | 配置[left, top, width, height]的偏移量,自动布局适用
* @property { boolean } report - 非必填 | false | 是否上报会议质量,默认不上报
* @property { boolean } screenOn - 非必填 | true | 是否常亮,默认常亮
* @property { number } logType - 非必填 | 0 | 日志类型, 默认微信日志
*/
interface ClientConfig {
server?: string;
appId?: string;
extId?: string;
layoutMode?: LayoutMode;
logServer?: string;
container?: {
offset?: number[];
};
screenOn?: boolean;
report?: boolean;
logType?: LogType;
}
/**
* 布局模式
*
* @enum
* @param AUTO auto 自动布局,布局内容由sdk内部实现
* @param CUSTOM custom 自定义布局,第三方根据自己业务实现
*/
export enum LayoutMode {
AUTO = 'auto',
CUSTOM = 'custom'
}
/**
* 日志类型
*
* @enum
* @param DEFAULT 0 - 微信日志
* @param CUSTOM 1 - 小鱼日志
*/
enum LogType {
DEFAULT,
CUSTOM
}
const XYClient = XYRTC.createClient(config?: ClientConfig);
import XYRTC from '@xylink/xy-mp-sdk';
const XYClient = XYRTC.createClient({
server: "wxrtc.xylink.com",
layoutMode: "auto",
appId: "xxx",
extId: "xxx"
});
// 获取到client模块后,可以执行后续的登陆和呼叫逻辑;