类 NEMeetingOptions

java.lang.Object
com.netease.yunxin.kit.meeting.sdk.NEMeetingOptions
直接已知子类:
NEJoinMeetingOptions, NEStartMeetingOptions

public class NEMeetingOptions extends Object
提供创建和加入会议时必要的基本配置信息和选项开关,通过这些配置和选项可控制入会时的行为,如音视频的开启状态等
另请参阅:
  • 字段详细资料

    • noMuteAllVideo

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

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

      public boolean noVideo
      配置入会时是否关闭本端视频,默认为true,即关闭视频,但在会议中可重新打开
    • noAudio

      public boolean noAudio
      配置入会时是否关闭本端音频,默认为true,即关闭音频,但在会议中可重新打开
    • showMeetingTime

      public Boolean showMeetingTime
      配置是否在会议界面中显示会议时长
    • showNameInVideo

      public Boolean showNameInVideo
      配置是否始终在视频画面上显示名字,默认显示
    • enableSpeakerSpotlight

      public Boolean enableSpeakerSpotlight
      配置是否开启语音激励
    • noMinimize

      public boolean noMinimize
      配置会议中是否允许最小化会议页面。最小化会议页面后,应用可以导航到其他页面, 并在某一时刻重新打开会议页面,最小化过程中会议正常进行,不受影响。
    • noInvite

      public boolean noInvite
      配置会议中是否显示"邀请"按钮
    • noSip

      public boolean noSip
      配置会议中是否显示"sip"功能菜单
    • noChat

      public boolean noChat
      配置会议中是否显示"聊天"按钮
    • noSwitchCamera

      public boolean noSwitchCamera
      配置会议中是否显示"切换摄像头"按钮
    • enableFrontCameraMirror

      public Boolean enableFrontCameraMirror
      配置会议中是否开启前置摄像头视频镜像,默认开启
    • noSwitchAudioMode

      public boolean noSwitchAudioMode
      配置会议中是否显示"切换音频模式"按钮
    • noGallery

      public boolean noGallery
      配置会议中是否包含画廊模式
    • noWhiteBoard

      public boolean noWhiteBoard
      配置会议中是否显示"共享白板"按钮
    • noRename

      public boolean noRename
      配置会议中是否显示"改名"菜单
    • noLive

      public boolean noLive
      配置是否在会议界面中显示"直播"入口
    • showMeetingRemainingTip

      public boolean showMeetingRemainingTip
      配置会议中是否开启剩余时间提醒
    • showScreenShareUserVideo

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

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

      public boolean showWhiteboardShareUserVideo
      配置会议中主页是否显示白板共享者的摄像头画面。 如果设置为开启,白板共享者的摄像头画面会以小窗口的方法覆盖在白板画面上显示。
    • enableTransparentWhiteboard

      public Boolean enableTransparentWhiteboard
      配置会议中白板共享时是否打开白板透明。
    • showFloatingMicrophone

      public boolean showFloatingMicrophone
      配置会议中是否显示麦克风浮窗,默认为显示
    • showMemberTag

      public boolean showMemberTag
      配置会议内是否显示 NEMeetingParams.tag
    • detectMutedMic

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

      public boolean unpubAudioOnMute
      本地静音时,是否关闭静音包发送。默认为true,即关闭静音包。
    • defaultWindowMode

      public NEWindowMode defaultWindowMode
      配置默认会议模式NEWindowMode
    • meetingIdDisplayOption

      public NEMeetingIdDisplayOption meetingIdDisplayOption
      会中"会议号"显示规则,默认为 NEMeetingIdDisplayOption.DISPLAY_ALL
    • fullToolbarMenuItems

      public List<NEMeetingMenuItem> fullToolbarMenuItems
      配置会议内"Toolbar"菜单列表中的菜单项。通过提供一个完整的菜单列表,其中可包含SDK内置菜单和自定义注入菜单,SDK会根据该列表排序依次显示对应菜单项,并在自定义菜单点击时触发对应回调。该配置仅会议前设置生效,会议过程中修改列表不会触发更新。如果不配置该列表,默认为NEMenuItems.getBuiltinToolbarMenuItemList()

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

      另请参阅:
    • fullMoreMenuItems

      public List<NEMeetingMenuItem> fullMoreMenuItems
      配置会议内"更多"菜单列表中的菜单项。通过提供一个完整的菜单列表,其中可包含SDK内置菜单和自定义注入菜单,SDK会根据该列表排序依次显示对应菜单项,并在自定义菜单点击时触发对应回调。该配置仅会议前设置生效,会议过程中修改列表不会触发更新。如果不配置该列表,默认为NEMenuItems.getBuiltinMoreMenuItemList()

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

      另请参阅:
    • joinTimeout

      public int joinTimeout
      超时时间,单位毫秒(ms),默认为 45000ms。若超过该时间还未成功加入会议, 则NEMeetingStatusListener.Event 中的 arg 字段会被设置为 NEMeetingCode.MEETING_DISCONNECTING_JOIN_TIMEOUT
    • audioProfile

      public NEAudioProfile audioProfile
      语音相关参数 NEAudioProfile
    • chatroomConfig

      public NEMeetingChatroomConfig chatroomConfig
      会议聊天室配置。
    • showCloudRecordMenuItem

      public boolean showCloudRecordMenuItem
      菜单按钮是否显示"云录制"
    • showCloudRecordingUI

      public boolean showCloudRecordingUI
      会议中是否展示云录制中UI
    • noReadPhoneState

      public boolean noReadPhoneState
      是否允许SDK请求电话权限,默认允许。在获取电话权限后,SDK会监听系统电话状态,在接听来电或拨打电话时, 会自动断开会议内的音视频(不会退出会议),并在系统电话结束后,自动重新连接会议的音视频。
    • noNotifyCenter

      public boolean noNotifyCenter
      配置会议中是否展示通知中心菜单,默认展示。
    • noWebApps

      public boolean noWebApps
      配置会议中是否展示 web 小应用,如签到应用。 默认会拉取小应用列表并展示。
    • noCaptions

      public boolean noCaptions
      配置会中是否展示“字幕”菜单,默认展示。
    • autoEnableCaptionsOnJoin

      public boolean autoEnableCaptionsOnJoin
      配置入会后是否自动开启“字幕”,默认不开启。
    • noTranscription

      public boolean noTranscription
      配置会中是否展示“转写”菜单,默认展示。
    • chatMessageNotificationType

      public NEChatMessageNotificationType chatMessageNotificationType
      配置新聊天消息提醒类型
    • pluginNotifyDuration

      public int pluginNotifyDuration
      配置会中插件通知弹窗持续时间,单位毫秒(ms),默认5000ms;value=0时,不显示通知弹窗;value小于0时,弹窗不自动消失。
    • enablePictureInPicture

      public boolean enablePictureInPicture
      配置会中退后台是否自动小窗,默认自动小窗(该配置对鸿蒙系统设备不生效)
    • showNotYetJoinedMembers

      public boolean showNotYetJoinedMembers
      配置是否在会议界面中显示未加入成员,默认展示。
    • enableDirectMemberMediaControlByHost

      public boolean enableDirectMemberMediaControlByHost
      配置主持人和联席主持人是否可以直接开关参会者的音视频,不需要参会者同意,默认需要参会者同意。
  • 构造器详细资料

    • NEMeetingOptions

      public NEMeetingOptions()