Interface NEMeetingService

interface NEMeetingService {
    addMeetingStatusListener(listener: NEMeetingStatusListener): void;
    anonymousJoinMeeting(
        param: NEJoinMeetingParams,
        opts?: NEMeetingOptions,
    ): Promise<NEResult<void>>;
    getCurrentMeetingInfo(): Promise<NEResult<NEMeetingInfo>>;
    getMeetingStatus(): Promise<NEResult<NEMeetingStatus>>;
    joinMeeting(
        param: NEJoinMeetingParams,
        opts?: NEMeetingOptions,
    ): Promise<NEResult<void>>;
    leaveCurrentMeeting(closeIfHost: boolean): Promise<NEResult<void>>;
    removeMeetingStatusListener(listener?: NEMeetingStatusListener): void;
    setOnInjectedMenuItemClickListener(
        listener: NEMeetingOnInjectedMenuItemClickListener,
    ): void;
    startMeeting(
        param: NEStartMeetingParams,
        opts?: NEStartMeetingOptions,
    ): Promise<NEResult<void>>;
    updateInjectedMenuItem(
        item: NEMeetingMenuItem | NESingleStateMenuItem | NECheckableMenuItem,
    ): Promise<NEResult<void>>;
}

Methods

addMeetingStatusListener anonymousJoinMeeting getCurrentMeetingInfo getMeetingStatus joinMeeting leaveCurrentMeeting removeMeetingStatusListener setOnInjectedMenuItemClickListener startMeeting updateInjectedMenuItem

Methods

addMeetingStatusListener

  • addMeetingStatusListener(listener: NEMeetingStatusListener): void

  • 添加会议状态监听实例，用于接收会议状态变更通知

    Parameters

    • listener: NEMeetingStatusListener

      要添加的监听实例

    Returns void

anonymousJoinMeeting

  • anonymousJoinMeeting(
        param: NEJoinMeetingParams,
        opts?: NEMeetingOptions,
    ): Promise<NEResult<void>>

  • 匿名加入一个当前正在进行中的会议 加入会议成功后，SDK会拉起会议页面，调用方不用做其他操作

    Parameters

    Returns Promise<NEResult<void>>

getCurrentMeetingInfo

  • getCurrentMeetingInfo(): Promise<NEResult<NEMeetingInfo>>

  • 获取当前会议详情。如果当前无正在进行中的会议，则返回undefined

    Returns Promise<NEResult<NEMeetingInfo>>

getMeetingStatus

  • getMeetingStatus(): Promise<NEResult<NEMeetingStatus>>

  • 获取当前的会议状态，会议状态的定义参考

    Returns Promise<NEResult<NEMeetingStatus>>

    会议状态

joinMeeting

  • joinMeeting(
        param: NEJoinMeetingParams,
        opts?: NEMeetingOptions,
    ): Promise<NEResult<void>>

  • 加入一个当前正在进行中的会议，已登录或未登录均可加入会议。 加入会议成功后，SDK会拉起会议页面，调用方不用做其他操作

    Parameters

    Returns Promise<NEResult<void>>

leaveCurrentMeeting

  • leaveCurrentMeeting(closeIfHost: boolean): Promise<NEResult<void>>

  • 离开当前进行中的会议，并通过参数控制是否同时结束当前会议；

    只有主持人才能结束会议，其他用户设置结束会议无效；

    如果退出当前会议后，会议中再无其他成员，则该会议也会结束；

    Parameters

    • closeIfHost: boolean

      true：结束会议；false：不结束会议；

    Returns Promise<NEResult<void>>

removeMeetingStatusListener

  • removeMeetingStatusListener(listener?: NEMeetingStatusListener): void

  • 移除对应的会议状态的监听实例

    Parameters

    • Optionallistener: NEMeetingStatusListener

      要移除的监听实例

    Returns void

setOnInjectedMenuItemClickListener

startMeeting

  • startMeeting(
        param: NEStartMeetingParams,
        opts?: NEStartMeetingOptions,
    ): Promise<NEResult<void>>

  • 开始一个新的会议，只有完成SDK的登录鉴权操作才允许创建会议。

    Parameters

    Returns Promise<NEResult<void>>

updateInjectedMenuItem

Settings

Member Visibility

On This Page

Methods