Interface NEMeetingKit

会议组件

Hierarchy

  • NEMeetingKit

Properties

NEMeetingInfo accountInfo addGlobalEventListener afterLeave create destroy downloadLog init join joinMemberInfo leaveMeeting login memberInfo moreBarList off on reuseIM setCustomList setDefaultRenderMode switchLanguage toolBarList uploadLog

Properties

NEMeetingInfo

NEMeetingInfo: {
    isHost: boolean;
    isLocked: boolean;
    meetingId: string;
    password?: string;
    shortMeetingId?: string;
    sipId?: string;
}

NEMeetingInfo 当前会议信息

Type declaration

  • isHost: boolean

    是否是主持人

  • isLocked: boolean

    是否锁定房间

  • meetingId: string

    会议号

  • Optional password?: string

    会议密码

  • Optional shortMeetingId?: string

    会议短号

  • Optional sipId?: string

    sipId

accountInfo

accountInfo: null | AccountInfo

个人账号信息

addGlobalEventListener

addGlobalEventListener: ((eventListener) => void)

Type declaration

    • (eventListener): void

    • 增加全局事件监听

      Parameters

      Returns void

afterLeave

afterLeave: ((callback) => void)

Type declaration

    • (callback): void

    • 离开房间回调方法

      Parameters

      • callback: (() => void)
          • (): void

          • Returns void

      Returns void

create

create: ((options, callback) => void)

Type declaration

    • (options, callback): void

    • 创建会议接口

      Parameters

      • options: JoinOptions

        相应配置参数

      • callback: (() => void)

        接口回调

          • (): void

          • Returns void

      Returns void

destroy

destroy: (() => void)

Type declaration

    • (): void

    • 销毁房间方法

      Returns void

downloadLog

downloadLog: ((logNames?, start?, end?) => void)

Type declaration

    • (logNames?, start?, end?): void

    • 下载日志接口

      Parameters

      • Optional logNames: LogName

        日志类型类型

      • Optional start: number

        日志开始时间

      • Optional end: number

        日志结束时间

      Returns void

init

init: ((width, height, config, callback) => void)

Type declaration

    • (width, height, config, callback): void

    • 初始化接口

      Parameters

      • width: number

        画布宽度

      • height: number

        画布高度

      • config: NEMeetingInitConfig

        配置项

      • callback: ((e) => void)

        初始化完成回调参数，如果成功则e为undefined

          • (e): void

          • Parameters

            • e: any

            Returns void

      Returns void

join

join: ((options, callback) => void)

Type declaration

    • (options, callback): void

    • 加入会议接口

      Parameters

      • options: JoinOptions

        相应配置参数

      • callback: (() => void)

        接口回调

          • (): void

          • Returns void

      Returns void

joinMemberInfo

joinMemberInfo: any

入会成员信息

leaveMeeting

leaveMeeting: ((finish, callback) => void)

Type declaration

    • (finish, callback): void

    • 离开会议

      Parameters

      • finish: boolean

        如果设置为true，且为管理员则直接结束会议，否则无效

      • callback: ((error?) => void)

        离开会议的回调函数，如果error为null，则表示离开或结束会议成功

          • (error?): void

          • Parameters

            • Optional error: any

            Returns void

      Returns void

login

login: ((options, callback) => void)

Type declaration

    • (options, callback): void

    • 登录接口

      Parameters

      • options: LoginOptions

        相应配置项

      • callback: (() => void)

        接口回调

          • (): void

          • Returns void

      Returns void

memberInfo

memberInfo: any

当前成员信息

moreBarList

moreBarList: MoreBarList

更多按钮配置

off

off: ((actionName, callback?) => void)

Type declaration

    • (actionName, callback?): void

    • 移除事件监听接口

      Parameters

      • actionName: string

        事件名

      • Optional callback: ((data) => void)

        事件回调

          • (data): void

          • Parameters

            • data: any

            Returns void

      Returns void

on

on: ((actionName, callback) => void)

Type declaration

    • (actionName, callback): void

    • 事件监听接口

      Parameters

      • actionName: EventName

        事件名

      • callback: ((data) => void)

        事件回调

          • (data): void

          • Parameters

            • data: any

            Returns void

      Returns void

reuseIM

reuseIM: ((IM) => any)

Type declaration

    • (IM): any

    • im 复用场景需要调用该方法，入参为IM，该方法会重新处理getInstance并返回一个包装过的IM，然后直接调用IM.getInstance方法

      Parameters

      • IM: any

      Returns any

setCustomList

setCustomList: ((options) => void)

Type declaration

    • (options): void

    • 动态更新自定义按钮

      Parameters

      Returns void

setDefaultRenderMode

setDefaultRenderMode: ((mode) => void)

Type declaration

    • (mode): void

    • 设置默认画面展示模式

      Parameters

      • mode: "small" | "big"

        big | small

      Returns void

switchLanguage

switchLanguage: ((language) => void)

Type declaration

toolBarList

toolBarList: ToolBarList

控制栏按钮配置

uploadLog

uploadLog: ((logNames?, start?, end?) => void)

Type declaration

    • (logNames?, start?, end?): void

    • 上传日志接口

      Parameters

      • Optional logNames: LogName

        日志类型名称

      • Optional start: number

        日志开始时间

      • Optional end: number

        日志结束时间

      Returns void

Settings

Member Visibility

Theme

On This Page