Type alias NEMeetingOptions

NEMeetingOptions: {
    chatMessageNotificationType?: NEChatMessageNotificationType;
    defaultWindowMode?: NEWindowMode;
    detectMutedMic?: boolean;
    enableAudioShare?: boolean;
    enableDirectMemberMediaControlByHost?: boolean;
    enableFixedToolbar?: boolean;
    enableFrontCameraMirror?: boolean;
    enableLeaveTheMeetingRequiresConfirmation?: boolean;
    enableShowNotYetJoinedMembers?: boolean;
    enableSideBySideMode?: boolean;
    enableSpeakerSpotlight?: boolean;
    enableTransparentWhiteboard?: boolean;
    enableUnmuteBySpace?: boolean;
    enableVideoMirror?: boolean;
    fullMoreMenuItems?: (NEMeetingMenuItem | NESingleStateMenuItem | NECheckableMenuItem)[];
    fullToolbarMenuItems?: (NEMeetingMenuItem | NESingleStateMenuItem | NECheckableMenuItem)[];
    joinTimeout?: number;
    meetingIdDisplayOption?: NEMeetingIdDisplayOption;
    memberActionMenuItems?: (NEMeetingMenuItem | NESingleStateMenuItem | NECheckableMenuItem)[];
    noAudio?: boolean;
    noCaptions?: boolean;
    noChat?: boolean;
    noInvite?: boolean;
    noLive?: boolean;
    noMuteAllAudio?: boolean;
    noMuteAllVideo?: boolean;
    noNotifyCenter?: boolean;
    noRename?: boolean;
    noSip?: boolean;
    noSwitchAudioMode?: boolean;
    noSwitchCamera?: boolean;
    noTranscription?: boolean;
    noVideo?: boolean;
    noWebApps?: boolean;
    noWhiteBoard?: boolean;
    pluginNotifyDuration?: number;
    showCloudRecordMenuItem?: boolean;
    showCloudRecordingUI?: boolean;
    showDeviceTest?: boolean;
    showEmojiResponse?: boolean;
    showHandsUp?: boolean;
    showLocalRecordMenuItem?: boolean;
    showLocalRecordingUI?: boolean;
    showMeetingInfo?: boolean;
    showMeetingRemainingTip?: boolean;
    showMeetingTime?: boolean;
    showMemberTag?: boolean;
    showNameInVideo?: boolean;
    showParticipationTime?: boolean;
    showScreenShareUserVideo?: boolean;
    showWhiteboardShareUserVideo?: boolean;
}

Type declaration

  • Optional chatMessageNotificationType?: NEChatMessageNotificationType

    配置新聊天消息提醒类型

  • Optional defaultWindowMode?: NEWindowMode

    配置默认会议模式NEWindowMode

  • Optional detectMutedMic?: boolean

    是否开启麦克风静音检测，默认开启。 开启该功能后，SDK 在检测到麦克风有音频输入，但此时处于静音打开的状态时，会提示用户关闭静音。

  • Optional enableAudioShare?: boolean

    开启/关闭音频共享功能。 默认为true, 开启后，在发起屏幕共享时，会同时自动开启设备的音频共享； 关闭后，在发起屏幕共享时，不会自动打开音频共享，但可以通过UI手动开启音频共享。 该设置默认为关闭。

  • Optional enableDirectMemberMediaControlByHost?: boolean
  • Optional enableFixedToolbar?: boolean

    是否始终显示工具栏

  • Optional enableFrontCameraMirror?: boolean

    配置会议中是否开启前置摄像头视频镜像，默认开启

  • Optional enableLeaveTheMeetingRequiresConfirmation?: boolean

    配置成员离开会议是否需要弹窗确认

  • Optional enableShowNotYetJoinedMembers?: boolean

    配置是否开启隐藏未入会成员，默认为false

  • Optional enableSideBySideMode?: boolean

    是否开启共享并排模式

  • Optional enableSpeakerSpotlight?: boolean

    配置是否开启语音激励，默认为true

  • Optional enableTransparentWhiteboard?: boolean

    配置会议中白板共享时是否开启标注模式。 默认为false

  • Optional enableUnmuteBySpace?: boolean

    是否能够通过长按空格解除静音

  • Optional enableVideoMirror?: boolean

    是否开启本端镜像 默认为true 镜像

  • Optional fullMoreMenuItems?: (NEMeetingMenuItem | NESingleStateMenuItem | NECheckableMenuItem)[]

    配置会议内"更多"菜单列表中的菜单项。通过提供一个完整的菜单列表，其中可包含SDK内置菜单和自定义注入菜单，SDK会根据该列表排序依次显示对应菜单项，并在自定义菜单点击时触发对应回调。该配置仅会议前设置生效，会议过程中修改列表不会触发更新。

    注意：部分SDK内置菜单只支持在"更多"菜单列表中显示，且"更多"菜单列表最多允许配置同时显示10个菜单项，即max(VISIBLE_ALWAYS + VISIBLE_EXCLUDE_HOST, VISIBLE_ALWAYS + VISIBLE_TO_HOST_ONLY) ≤ 10

    See

    • NESingleStateMenuItem
    • NECheckableMenuItem @ see NEMeetingService#setOnInjectedMenuItemClickListener(NEMeetingOnInjectedMenuItemClickListener)
  • Optional fullToolbarMenuItems?: (NEMeetingMenuItem | NESingleStateMenuItem | NECheckableMenuItem)[]

    配置会议内"Toolbar"菜单列表中的菜单项。通过提供一个完整的菜单列表，其中可包含SDK内置菜单和自定义注入菜单，SDK会根据该列表排序依次显示对应菜单项，并在自定义菜单点击时触发对应回调。该配置仅会议前设置生效，会议过程中修改列表不会触发更新。

    注意：部分SDK内置菜单只支持在Toolbar菜单列表中显示，不能放入"更多"菜单列表中，且Toolbar菜单列表最多允许同时显示4个菜单项，即max(VISIBLE_ALWAYS + VISIBLE_EXCLUDE_HOST, VISIBLE_ALWAYS + VISIBLE_TO_HOST_ONLY) ≤ 4

    See

    • NESingleStateMenuItem
    • NECheckableMenuItem @ see NEMeetingService#setOnInjectedMenuItemClickListener(NEMeetingOnInjectedMenuItemClickListener)
  • Optional joinTimeout?: number

    超时时间，单位毫秒(ms)，默认为 45000ms。

  • Optional meetingIdDisplayOption?: NEMeetingIdDisplayOption

    会中"会议号"显示规则，默认为 NEMeetingIdDisplayOption#DISPLAY_ALL

  • Optional memberActionMenuItems?: (NEMeetingMenuItem | NESingleStateMenuItem | NECheckableMenuItem)[]
  • Optional noAudio?: boolean

    配置入会时是否关闭本端音频，默认为true，即关闭音频，但在会议中可重新打开

  • Optional noCaptions?: boolean

    配置会议中是否展示"字幕"菜单，默认展示。

  • Optional noChat?: boolean

    配置会议中是否显示"聊天"按钮，默认为false，即显示

  • Optional noInvite?: boolean

    配置会议中是否显示"邀请"按钮，默认为false，即显示

  • Optional noLive?: boolean

    配置是否在会议界面中显示"直播"入口, 默认false，即显示

  • Optional noMuteAllAudio?: boolean

    配置会议中成员列表是否不显示"全体禁音/解除全体静音"，默认为false，即显示

  • Optional noMuteAllVideo?: boolean

    配置会议中成员列表是否不显示"全体关闭/打开视频"，默认为true，即不显示

  • Optional noNotifyCenter?: boolean

    配置会议中是否展示通知中心菜单，默认展示。

  • Optional noRename?: boolean

    配置会议中是否显示"改名"菜单, 默认false，即显示

  • Optional noSip?: boolean

    配置会议中是否显示"sip"功能菜单，默认为false，即显示

  • Optional noSwitchAudioMode?: boolean

    配置会议中是否显示"切换音频模式"按钮，默认为false，即显示

  • Optional noSwitchCamera?: boolean

    配置会议中是否显示"切换摄像头"按钮，默认为false，即显示

  • Optional noTranscription?: boolean

    配置会中是否展示“转写”菜单，默认展示。

  • Optional noVideo?: boolean

    配置入会时是否关闭本端视频，默认为true，即关闭视频，但在会议中可重新打开

  • Optional noWebApps?: boolean

    配置会议中是否展示 web 小应用，如签到应用。 默认会拉取小应用列表并展示。

  • Optional noWhiteBoard?: boolean

    配置会议中是否显示"共享白板"按钮, 默认false，即显示

  • Optional pluginNotifyDuration?: number

    配置会中插件通知弹窗持续时间，单位毫秒(ms)，默认5000ms；value=0时，不显示通知弹窗；value<0时，弹窗不自动消失。

  • Optional showCloudRecordMenuItem?: boolean

    菜单按钮是否显示"云录制"

  • Optional showCloudRecordingUI?: boolean

    会议中是否展示云录制中UI

  • Optional showDeviceTest?: boolean

    入会之前是否进行设备检测，默认为false 主要用于h5端检测

  • Optional showEmojiResponse?: boolean

    是否开启表情响应

  • Optional showHandsUp?: boolean

    是否开启举手功能

  • Optional showLocalRecordMenuItem?: boolean

    菜单按钮是否显示"本地录制"

  • Optional showLocalRecordingUI?: boolean

    会议中是否展示本地录制中UI

  • Optional showMeetingInfo?: boolean

    配置会议中是否显示"会议信息"查看入口，默认显示

  • Optional showMeetingRemainingTip?: boolean

    配置会议中是否开启剩余时间提醒, 默认false

  • Optional showMeetingTime?: boolean

    配置是否在会议界面中显示会议时长，默认为false，入会前设置，会议中无法设置

  • Optional showMemberTag?: boolean

    配置会议内是否显示 NEMeetingParams#tag。

  • Optional showNameInVideo?: boolean

    配置是否始终在视频画面上显示名字，默认显示

  • Optional showParticipationTime?: boolean

    配置是否在会议界面中显示参会时长，默认为false

  • Optional showScreenShareUserVideo?: boolean

    配置会议中主页是否显示屏幕共享者的摄像头画面，默认为true，当前正在共享的内容画面不受影响。 如果设置为关闭，屏幕共享者的摄像头画面会被隐藏，不会遮挡共享内容画面。

  • Optional showWhiteboardShareUserVideo?: boolean

    配置会议中主页是否显示白板共享者的摄像头画面。 默认为false，如果设置为开启，白板共享者的摄像头画面会以小窗口的方法覆盖在白板画面上显示。

Settings

Member Visibility

Theme