类 NEMeetingOptions
java.lang.Object
com.netease.yunxin.kit.meeting.sdk.NEMeetingOptions
提供创建和加入会议时必要的基本配置信息和选项开关,通过这些配置和选项可控制入会时的行为,如音视频的开启状态等
-
字段概要
修饰符和类型字段说明语音相关参数NEAudioProfile
boolean
配置入会后是否自动开启“字幕”,默认不开启。配置新聊天消息提醒类型会议聊天室配置。配置默认会议模式NEWindowMode
boolean
是否开启麦克风静音检测,默认开启。boolean
开启/关闭音频共享功能。boolean
配置主持人和联席主持人是否可以直接开关参会者的音视频,不需要参会者同意,默认需要参会者同意。配置会议中是否开启前置摄像头视频镜像,默认开启boolean
配置成员离开会议是否需要弹窗确认boolean
配置会中退后台是否自动小窗,默认自动小窗(该配置对鸿蒙系统设备不生效)配置是否开启语音激励配置会议中白板共享时是否打开白板透明。配置会议中小画面的窗口大小,默认为(92.0, 162.0)配置会议内"更多"菜单列表中的菜单项。配置会议内"Toolbar"菜单列表中的菜单项。int
超时时间,单位毫秒(ms),默认为 45000ms。配置会议界面中时间显示类型会中"会议号"显示规则,默认为NEMeetingIdDisplayOption.DISPLAY_ALL
配置会议内"成员列表菜单操作项"菜单列表中的菜单操作项。boolean
配置入会时是否关闭本端音频,默认为true,即关闭音频,但在会议中可重新打开boolean
配置会中是否展示“字幕”菜单,默认展示。boolean
配置会议中是否显示"聊天"按钮boolean
配置会议中是否包含画廊模式boolean
配置会议中是否显示"邀请"按钮boolean
配置是否在会议界面中显示"直播"入口boolean
配置会议中是否允许最小化会议页面。boolean
配置会议中成员列表是否不显示"全体禁音/解除全体静音",默认为false,即显示boolean
配置会议中成员列表是否不显示"全体关闭/打开视频",默认为true,即不显示boolean
配置会议中是否展示通知中心菜单,默认展示。boolean
是否允许SDK请求电话权限,默认允许。boolean
配置会议中是否显示"改名"菜单boolean
配置会议中是否显示"sip"功能菜单boolean
配置会议中是否显示"切换音频模式"按钮boolean
配置会议中是否显示"切换摄像头"按钮boolean
配置会中是否展示“转写”菜单,默认展示。boolean
配置入会时是否关闭本端视频,默认为true,即关闭视频,但在会议中可重新打开boolean
配置会议中是否展示 web 小应用,如签到应用。boolean
配置会议中是否显示"共享白板"按钮int
配置会中插件通知弹窗持续时间,单位毫秒(ms),默认5000ms;value=0时,不显示通知弹窗;value小于0时,弹窗不自动消失。boolean
会议中是否展示云录制中UIboolean
菜单按钮是否显示"云录制"boolean
配置表情回应交互入口是否显示boolean
配置会议中是否显示麦克风浮窗,默认为显示boolean
配置举手交互入口是否显示boolean
会议中是否展示本地录制中UIboolean
配置会议中是否显示"会议信息"查看入口boolean
配置会议中是否开启剩余时间提醒已过时。boolean
配置会议内是否显示NEMeetingParams.tag
。配置是否始终在视频画面上显示名字,默认显示boolean
配置是否在会议界面中显示未加入成员,默认展示。boolean
配置会议中主页是否显示屏幕共享者的摄像头画面,当前正在共享的内容画面不受影响。boolean
配置会议中主页是否显示白板共享者的摄像头画面。boolean
本地静音时,是否关闭静音包发送。 -
构造器概要
-
方法概要
-
字段详细资料
-
noMuteAllVideo
public boolean noMuteAllVideo配置会议中成员列表是否不显示"全体关闭/打开视频",默认为true,即不显示 -
noMuteAllAudio
public boolean noMuteAllAudio配置会议中成员列表是否不显示"全体禁音/解除全体静音",默认为false,即显示 -
noVideo
public boolean noVideo配置入会时是否关闭本端视频,默认为true,即关闭视频,但在会议中可重新打开 -
noAudio
public boolean noAudio配置入会时是否关闭本端音频,默认为true,即关闭音频,但在会议中可重新打开 -
showMeetingTime
已过时。配置是否在会议界面中显示会议时长 @Deprecated 请使用meetingElapsedTimeDisplayType
-
meetingElapsedTimeDisplayType
配置会议界面中时间显示类型 -
showNameInVideo
配置是否始终在视频画面上显示名字,默认显示 -
enableSpeakerSpotlight
配置是否开启语音激励 -
noMinimize
public boolean noMinimize配置会议中是否允许最小化会议页面。最小化会议页面后,应用可以导航到其他页面, 并在某一时刻重新打开会议页面,最小化过程中会议正常进行,不受影响。 -
noInvite
public boolean noInvite配置会议中是否显示"邀请"按钮 -
noSip
public boolean noSip配置会议中是否显示"sip"功能菜单 -
noChat
public boolean noChat配置会议中是否显示"聊天"按钮 -
noSwitchCamera
public boolean noSwitchCamera配置会议中是否显示"切换摄像头"按钮 -
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配置会议中是否开启剩余时间提醒 -
enableTransparentWhiteboard
配置会议中白板共享时是否打开白板透明。 -
showFloatingMicrophone
public boolean showFloatingMicrophone配置会议中是否显示麦克风浮窗,默认为显示 -
showMemberTag
public boolean showMemberTag配置会议内是否显示NEMeetingParams.tag
。 -
detectMutedMic
public boolean detectMutedMic是否开启麦克风静音检测,默认开启。 开启该功能后,SDK在检测到麦克风有音频输入,但此时处于静音打开的状态时,会提示用户关闭静音。 -
unpubAudioOnMute
public boolean unpubAudioOnMute本地静音时,是否关闭静音包发送。默认为true,即关闭静音包。 -
defaultWindowMode
配置默认会议模式NEWindowMode
-
meetingIdDisplayOption
会中"会议号"显示规则,默认为NEMeetingIdDisplayOption.DISPLAY_ALL
-
fullToolbarMenuItems
配置会议内"Toolbar"菜单列表中的菜单项。通过提供一个完整的菜单列表,其中可包含SDK内置菜单和自定义注入菜单,SDK会根据该列表排序依次显示对应菜单项,并在自定义菜单点击时触发对应回调。该配置仅会议前设置生效,会议过程中修改列表不会触发更新。如果不配置该列表,默认为NEMenuItems.getBuiltinToolbarMenuItemList()
注意:部分SDK内置菜单只支持在Toolbar菜单列表中显示,不能放入"更多"菜单列表中
-
fullMoreMenuItems
配置会议内"更多"菜单列表中的菜单项。通过提供一个完整的菜单列表,其中可包含SDK内置菜单和自定义注入菜单,SDK会根据该列表排序依次显示对应菜单项,并在自定义菜单点击时触发对应回调。该配置仅会议前设置生效,会议过程中修改列表不会触发更新。如果不配置该列表,默认为NEMenuItems.getBuiltinMoreMenuItemList()
注意:部分SDK内置菜单只支持在"更多"菜单列表中显示
-
memberActionMenuItems
配置会议内"成员列表菜单操作项"菜单列表中的菜单操作项。通过提供一个完整的菜单列表,其中可包含SDK内置菜单操作项和自定义注入菜单操作项,SDK会根据该列表排序依次显示对应菜单操作项,并在自定义菜单点击时触发对应回调。该配置仅会议前设置生效,会议过程中修改列表不会触发更新。如果不配置该列表,默认为NEActionMenuItems.getBuiltinActionMenuItemList()
-
joinTimeout
public int joinTimeout超时时间,单位毫秒(ms),默认为 45000ms。若超过该时间还未成功加入会议, 则NEMeetingStatusListener.Event
中的arg
字段会被设置为NEMeetingCode.MEETING_DISCONNECTING_JOIN_TIMEOUT
-
audioProfile
语音相关参数NEAudioProfile
-
chatroomConfig
会议聊天室配置。 -
showCloudRecordMenuItem
public boolean showCloudRecordMenuItem菜单按钮是否显示"云录制" -
showCloudRecordingUI
public boolean showCloudRecordingUI会议中是否展示云录制中UI -
showLocalRecordingUI
public boolean showLocalRecordingUI会议中是否展示本地录制中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
配置新聊天消息提醒类型 -
pluginNotifyDuration
public int pluginNotifyDuration配置会中插件通知弹窗持续时间,单位毫秒(ms),默认5000ms;value=0时,不显示通知弹窗;value小于0时,弹窗不自动消失。 -
enablePictureInPicture
public boolean enablePictureInPicture配置会中退后台是否自动小窗,默认自动小窗(该配置对鸿蒙系统设备不生效) -
showNotYetJoinedMembers
public boolean showNotYetJoinedMembers配置是否在会议界面中显示未加入成员,默认展示。 -
enableDirectMemberMediaControlByHost
public boolean enableDirectMemberMediaControlByHost配置主持人和联席主持人是否可以直接开关参会者的音视频,不需要参会者同意,默认需要参会者同意。 -
enableLeaveTheMeetingRequiresConfirmation
public boolean enableLeaveTheMeetingRequiresConfirmation配置成员离开会议是否需要弹窗确认 -
showHandsUp
public boolean showHandsUp配置举手交互入口是否显示 -
showEmojiResponse
public boolean showEmojiResponse配置表情回应交互入口是否显示 -
floatingWindowSize
配置会议中小画面的窗口大小,默认为(92.0, 162.0) -
showMeetingInfo
public boolean showMeetingInfo配置会议中是否显示"会议信息"查看入口
-
-
构造器详细资料
-
NEMeetingOptions
public NEMeetingOptions()
-