@ylink-sdk/meeting 0.1.5 → 0.1.9

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 ylink
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2021 ylink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,3 +1,3 @@
-# @ylink-sdk/meeting
-
-通过@ylink-sdk/meeting，开发者可以快速实现加入yealink会议并进行相关会议会控操作
+# @ylink-sdk/meeting
+
+通过@ylink-sdk/meeting，开发者可以快速实现加入yealink会议并进行相关会议会控操作

package/dist/index.d.ts

@@ -1,156 +1,161 @@
-import { Ctrl } from './types/ctrl';
-import { ENDPOINT_TYPE, EVENT, CONNECTION_STATE, ROLE, ME_CHANGE, MEETING_CHANGE } from './types/enums';
-import { Data, ResultInfo, JobStatus, UserState } from './types/data';
-export declare type Handler<T = Record<any, any>> = (event: T[keyof T]) => void;
-export interface ParamsJoin {
-    meetingNum: string;
-    pwd?: string;
-    displayName: string;
-    endpointType: ENDPOINT_TYPE;
-    inviteTransID?: string;
-    groupIDs?: Array<string>;
-    account?: string;
-    userAgent?: string;
-    groupName?: string;
-    url?: string;
-}
-export interface MeetingConfig {
-    /**
-     * 服务器地址
-     * @example
-     * https://meetings.ylyun.com/control
-     */
-    baseURL: string;
-}
-/**
- * 亿联会议会控
- */
-export default class Meeting {
-    /**
-     * 终端类型
-     */
-    static ENDPOINT_TYPE: typeof ENDPOINT_TYPE;
-    /**
-     * 通知事件
-     */
-    static EVENT: typeof EVENT;
-    /**
-     * 会议连接状态
-     */
-    static CONNECTION_STATE: typeof CONNECTION_STATE;
-    /**
-     * 角色
-     */
-    static ROLE: typeof ROLE;
-    /**
-     * 自身信息变更
-     */
-    static ME_CHANGE: typeof ME_CHANGE;
-    /**
-     * 会议信息变更
-     */
-    static MEETING_CHANGE: typeof MEETING_CHANGE;
-    /**
-     * 初始化
-     * @example
-     * ```typescript
-     * const meeting = new Meeting(config);
-     * ```
-     */
-    constructor(config: MeetingConfig);
-    /**
-     * 获取会议会控交互功能
-     * @since 1.0.0
-     * @example
-     * ```typescript
-     * meeting.ctrl.audio({ sendOn: true, userID: 1 }); // 开启用户音频
-     * ```
-     */
-    get ctrl(): Ctrl;
-    /**
-     * 获取当前会议会控实时数据
-     * @since 1.0.0
-     * @returns 会议会控数据
-     * @example
-     * ```typescript
-     * meeting.data.me // 获取自身信息
-     * meeting.data.meetingInfo // 获取会议信息
-     * ```
-     */
-    get data(): Data;
-    /**
-     * 获取当前会议连接状态
-     * @since 1.0.0
-     */
-    get connectionState(): CONNECTION_STATE;
-    /**
-     * 事件监听
-     * @since 1.0.0
-     * @param type 事件
-     * @param handler 事件消息处理
-     * @example
-     * ```typescript
-     * meeting.on('me-change', payload => {});
-     * ```
-     */
-    on(type: EVENT, handler: Handler): void;
-    /**
-     * 移除事件监听
-     * @param type 事件
-     * @param handler 事件消息处理
-     * @example
-     * ```typescript
-     * meeting.off('me-change'); // 将移除me-change所有的handler
-     * const handler = payload => {};
-     * meeting.off('me-change', handler); // 移除me-change对应的handler
-     * ```
-     */
-    off(type: EVENT, handler?: Handler): void;
-    /**
-     * 获取配置的服务器地址
-     * @since 1.0.0
-     */
-    getBaseURL(): string;
-    /**
-     * 设置服务器地址
-     * @param url 服务器地址
-     * @since 1.0.0
-     */
-    setBaseURL(url: string): void;
-    /**
-     * 获取轮询和保活状态
-     * @since 1.0.0
-     * @example
-     * ```typescript
-     * const jobStatus = meeting.getJobStatus();
-     * console.log(jobStatus.polling, jobStatus.keepalive);
-     * ```
-     */
-    getJobStatus(): Record<string, JobStatus>;
-    /**
-     * 加入会议
-     * @since 1.0.0
-     */
-    join(params: ParamsJoin): Promise<void>;
-    /**
-     * 上报用户媒体信息，正常用于EVENT: UPDATE_USER_STATE事件触发时进行上报，当params未传时，将采用下面默认参数，有传值时，将进行覆盖
-     *
-     * |类型|deviceOn|sendOn|recvOn|
-     * |-|-|-|-|
-     * |audio|true|true|false|
-     * |video|true|true|false|
-     * |share|true|false|false|
-     * @since 1.0.0
-     */
-    updateUserState(params?: UserState): Promise<void>;
-    /**
-     * 离开会议，params传值为空时，默认传递ResultInfo：bizCode为901359
-     * @since 1.0.0
-     */
-    leave(params?: ResultInfo): Promise<boolean>;
-    /**
-     * 结束会议（需主持人权限）
-     * @since 1.0.0
-     */
-    end(): Promise<boolean>;
-}
+import { Ctrl } from './types/ctrl';
+import { ENDPOINT_TYPE, EVENT, CONNECTION_STATE, ROLE, ME_CHANGE, MEETING_CHANGE } from './types/enums';
+import { Data, ResultInfo, JobStatus, UserState } from './types/data';
+export declare type Handler<T = Record<any, any>> = (event: T[keyof T]) => void;
+export interface ParamsJoin {
+    meetingNum: string;
+    pwd?: string;
+    displayName: string;
+    endpointType: ENDPOINT_TYPE;
+    inviteTransID?: string;
+    groupIDs?: Array<string>;
+    account?: string;
+    userAgent?: string;
+    groupName?: string;
+    url?: string;
+    mobileCode?: string;
+    mobile?: string;
+    regEmail?: string;
+    accEmail?: string;
+    tk?: string;
+}
+export interface MeetingConfig {
+    /**
+     * 服务器地址
+     * @example
+     * https://meetings.ylyun.com/control
+     */
+    baseURL: string;
+}
+/**
+ * 亿联会议会控
+ */
+export default class Meeting {
+    /**
+     * 终端类型
+     */
+    static ENDPOINT_TYPE: typeof ENDPOINT_TYPE;
+    /**
+     * 通知事件
+     */
+    static EVENT: typeof EVENT;
+    /**
+     * 会议连接状态
+     */
+    static CONNECTION_STATE: typeof CONNECTION_STATE;
+    /**
+     * 角色
+     */
+    static ROLE: typeof ROLE;
+    /**
+     * 自身信息变更
+     */
+    static ME_CHANGE: typeof ME_CHANGE;
+    /**
+     * 会议信息变更
+     */
+    static MEETING_CHANGE: typeof MEETING_CHANGE;
+    /**
+     * 初始化
+     * @example
+     * ```typescript
+     * const meeting = new Meeting(config);
+     * ```
+     */
+    constructor(config: MeetingConfig);
+    /**
+     * 获取会议会控交互功能
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * meeting.ctrl.audio({ sendOn: true, userID: 1 }); // 开启用户音频
+     * ```
+     */
+    get ctrl(): Ctrl;
+    /**
+     * 获取当前会议会控实时数据
+     * @since 1.0.0
+     * @returns 会议会控数据
+     * @example
+     * ```typescript
+     * meeting.data.me // 获取自身信息
+     * meeting.data.meetingInfo // 获取会议信息
+     * ```
+     */
+    get data(): Data;
+    /**
+     * 获取当前会议连接状态
+     * @since 1.0.0
+     */
+    get connectionState(): CONNECTION_STATE;
+    /**
+     * 事件监听
+     * @since 1.0.0
+     * @param type 事件
+     * @param handler 事件消息处理
+     * @example
+     * ```typescript
+     * meeting.on('me-change', payload => {});
+     * ```
+     */
+    on(type: EVENT, handler: Handler): void;
+    /**
+     * 移除事件监听
+     * @param type 事件
+     * @param handler 事件消息处理
+     * @example
+     * ```typescript
+     * meeting.off('me-change'); // 将移除me-change所有的handler
+     * const handler = payload => {};
+     * meeting.off('me-change', handler); // 移除me-change对应的handler
+     * ```
+     */
+    off(type: EVENT, handler?: Handler): void;
+    /**
+     * 获取配置的服务器地址
+     * @since 1.0.0
+     */
+    getBaseURL(): string;
+    /**
+     * 设置服务器地址
+     * @param url 服务器地址
+     * @since 1.0.0
+     */
+    setBaseURL(url: string): void;
+    /**
+     * 获取轮询和保活状态
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * const jobStatus = meeting.getJobStatus();
+     * console.log(jobStatus.polling, jobStatus.keepalive);
+     * ```
+     */
+    getJobStatus(): Record<string, JobStatus>;
+    /**
+     * 加入会议
+     * @since 1.0.0
+     */
+    join(params: ParamsJoin): Promise<void>;
+    /**
+     * 上报用户媒体信息，正常用于EVENT: UPDATE_USER_STATE事件触发时进行上报，当params未传时，将采用下面默认参数，有传值时，将进行覆盖
+     *
+     * |类型|deviceOn|sendOn|recvOn|
+     * |-|-|-|-|
+     * |audio|true|true|false|
+     * |video|true|true|false|
+     * |share|true|false|false|
+     * @since 1.0.0
+     */
+    updateUserState(params?: UserState): Promise<void>;
+    /**
+     * 离开会议，params传值为空时，默认传递ResultInfo：bizCode为901359
+     * @since 1.0.0
+     */
+    leave(params?: ResultInfo): Promise<boolean>;
+    /**
+     * 结束会议（需主持人权限）
+     * @since 1.0.0
+     */
+    end(): Promise<boolean>;
+}