NEMeetingKit V4.9.0
载入中...
搜索中...
未找到
NEMeetingOptions类 参考

会议选项 更多...

#include <kit_define_meeting.h>

类 NEMeetingOptions 继承关系图:
NEObject NEJoinMeetingOptions NEStartMeetingOptions

Public 成员函数

 NEMeetingOptions (bool bNoVideo=true, bool bNoAudio=true, bool bNoChat=false, bool bNoInvite=false, bool bNoScreenShare=true, bool bNoView=true, bool bNoWhiteboard=false, bool bNoRename=false, bool bNoSip=true, bool bNoMuteAllVideo=true, bool bNoMuteAllAudio=false, bool bAudioAINSEnabled=true, bool bShowMemberTag=false, bool bShowMeetingRemainingTip=false, bool bDetectMutedMic=true, bool bUnpubAudioOnMute=true, NEMeetingWindowMode bEmViewMode=NORMAL_MODE, NEMeetingChatroomConfig bChatroomConfigIn=NEMeetingChatroomConfig(), bool bNoCaptions=false, bool bAutoEnableCaptionsOnJoin=false, bool bNoTranscription=false)
 构造函数
 
- Public 成员函数 继承自 NEObject
 NEObject ()=default
 构造函数
 
virtual ~NEObject ()=default
 析构函数
 

Public 属性

bool noVideo
 配置入会时是否关闭本端视频,默认为true,即关闭视频,但在会议中可重新打开
 
bool noAudio
 配置入会时是否关闭本端音频,默认为true,即关闭音频,但在会议中可重新打开
 
bool showMeetingTime
 配置是否在会议界面中显示会议时长,入会前设置,会议中无法设置
 
bool showNameInVideo
 配置是否始终在视频画面上显示名字,默认显示
 
bool enableSpeakerSpotlight
 配置是否开启语音激励
 
bool noMinimize
 配置会议中是否允许最小化会议页面。最小化会议页面后,应用可以导航到其他页面, 并在某一时刻重新打开会议页面,最小化过程中会议正常进行,不受影响。
 
bool noSwitchCamera
 配置会议中是否显示"切换摄像头"按钮
 
bool noSwitchAudioMode
 配置会议中是否显示"切换音频模式"按钮
 
bool noLive
 配置是否在会议界面中显示"直播"入口
 
bool showScreenShareUserVideo
 配置会议中主页是否显示屏幕共享者的摄像头画面,当前正在共享的内容画面不受影响。 如果设置为关闭,屏幕共享者的摄像头画面会被隐藏,不会遮挡共享内容画面。
 
bool enableAudioShare
 开启/关闭音频共享功能。 开启后,在发起屏幕共享时,会同时自动开启设备的音频共享; 关闭后,在发起屏幕共享时,不会自动打开音频共享,但可以通过UI手动开启音频共享。 该设置默认为关闭。
 
bool showWhiteboardShareUserVideo
 配置会议中主页是否显示白板共享者的摄像头画面。 如果设置为开启,白板共享者的摄像头画面会以小窗口的方法覆盖在白板画面上显示。
 
bool enableTransparentWhiteboard
 配置会议中白板共享时是否开启标注模式。
 
bool showFloatingMicrophone
 配置会议中是否显示麦克风浮窗,默认为显示
 
bool noChat
 配置会议中是否显示"聊天"按钮,比自定义菜单中的优先级高
 
bool noInvite
 配置会议中是否显示"邀请"按钮,比自定义菜单中的优先级高
 
bool noScreenShare
 配置会议中是否显示"屏幕共享"按钮,比自定义菜单中的优先级高,默认为true,即显示
 
bool noView
 配置会议中是否显示"视图"按钮,比自定义菜单中的优先级高,默认为true,即显示
 
bool noWhiteboard
 配置会议中是否显示"白板"按钮,比自定义菜单中的优先级高
 
bool noRename
 配置会议中是否显示"改名"菜单
 
bool noSip
 配置会议中是否显示"sip"按钮,默认为true,即不显示
 
bool noMuteAllVideo
 配置会议中成员列表是否显示"全体关闭/打开视频",默认为true,即不显示
 
bool noMuteAllAudio
 配置会议中成员列表是否显示"全体禁音/解除全体静音",默认为false,即显示
 
bool audioAINSEnabled
 配置会议中智能语音降噪开关,默认为true,即开启
 
bool showMemberTag
 配置会议中成员列表是否显示成员标签,默认为false,即不显示
 
bool showMeetingRemainingTip
 配置是否显示会议时长到期提示,默认为false,即不显示
 
bool detectMutedMic
 配置是否开启麦克风静音检测,默认开启。开启该功能后,SDK在检测到麦克风有音频输入,但此时处于静音打开的状态时,会提示用户关闭静音
 
bool unpubAudioOnMute
 配置本地静音时,是否关闭静音包发送。默认为true,即关闭静音包
 
NEMeetingWindowMode defaultWindowMode
 配置会议模式
 
NEShowMeetingIdOption meetingIdDisplayOption
 配置会议ID的展示形式
 
std::vector< NEMeetingMenuItemPtrfullToolbarMenuItems
 底部Toolbar菜单栏自定义菜单,最多显示7项,如果为空则显示默认的
 
std::vector< NEMeetingMenuItemPtrfullMoreMenuItems
 底部“更多”菜单栏自定义菜单,最多添加10项,代替injected_more_menu_items_,这两个不能同时使用
 
int joinTimeout = 45 * 1000
 入会超时时间,如果小于等于0,则使用默认值,默认为45秒,单位为毫秒
 
NEMeetingChatroomConfig chatroomConfig
 聊天室配置 NEMeetingChatroomConfig
 
int audioProfile
 语音相关参数 NEAudioProfile
 
bool showCloudRecordMenuItem = true
 菜单按钮是否显示"云录制"
 
bool showCloudRecordingUI = true
 会议中是否展示云录制中UI
 
bool enableAudioDeviceSwitch = true
 是否允许音频设备切换
 
bool noReadPhoneState = false
 是否允许SDK请求电话权限,默认允许。在获取电话权限后,SDK会监听系统电话状态,在接听来电或拨打电话时, 会自动断开会议内的音视频(不会退出会议),并在系统电话结束后,自动重新连接会议的音视频。
 
bool noNotifyCenter = false
 配置会议中是否展示通知中心菜单,默认展示
 
bool noWebApps = false
 配置会议中是否展示 web 小应用,如签到应用。 默认会拉取小应用列表并展示
 
bool noCaptions = false
 配置会中是否展示“字幕”菜单,默认展示。
 
bool autoEnableCaptionsOnJoin = false
 配置入会后是否自动开启“字幕”,默认不开启。
 
bool noTranscription = false
 配置会中是否展示“转写”菜单,默认展示。
 
int pluginNotifyDuration = 5000
 配置会中插件通知弹窗持续时间,单位毫秒(ms),默认5000ms;value=0时,不显示通知弹窗;value<0时,弹窗不自动消失。
 
bool showNotYetJoinedMembers = false
 配置是否在会议界面中显示未加入成员,默认展示。
 
NEChatMessageNotificationType chatMessageNotificationType
 配置新聊天消息提醒类型
 
bool enableDirectMemberMediaControlByHost = false
 配置主持人和联席主持人是否可以直接开关参会者的音视频,不需要参会者同意,默认需要参会者同意。
 

详细描述

会议选项

构造及析构函数说明

◆ NEMeetingOptions()

NEMeetingOptions::NEMeetingOptions ( bool bNoVideo = true,
bool bNoAudio = true,
bool bNoChat = false,
bool bNoInvite = false,
bool bNoScreenShare = true,
bool bNoView = true,
bool bNoWhiteboard = false,
bool bNoRename = false,
bool bNoSip = true,
bool bNoMuteAllVideo = true,
bool bNoMuteAllAudio = false,
bool bAudioAINSEnabled = true,
bool bShowMemberTag = false,
bool bShowMeetingRemainingTip = false,
bool bDetectMutedMic = true,
bool bUnpubAudioOnMute = true,
NEMeetingWindowMode bEmViewMode = NORMAL_MODE,
NEMeetingChatroomConfig bChatroomConfigIn = NEMeetingChatroomConfig(),
bool bNoCaptions = false,
bool bAutoEnableCaptionsOnJoin = false,
bool bNoTranscription = false )
inline

构造函数

参数
bNoVideo配置入会时是否关闭本端视频,默认为true,即关闭视频,但在会议中可重新打开
bNoAudio配置入会时是否关闭本端音频,默认为true,即关闭音频,但在会议中可重新打开
bNoChat配置会议中是否显示"聊天"按钮,比自定义菜单中的优先级高
bNoInvite配置会议中是否显示"邀请"按钮,比自定义菜单中的优先级高
bNoScreenShare配置会议中是否显示"屏幕共享"按钮,比自定义菜单中的优先级高
bNoView配置会议中是否显示"视图"按钮,比自定义菜单中的优先级高
bNoWhiteboard配置会议中是否显示"白板"按钮,比自定义菜单中的优先级高
bNoRename配置会议中是否显示"改名"菜单
bNoSip配置会议中是否显示"sip"按钮,默认为true,即不显示
bNoMuteAllVideo配置会议中成员列表是否显示"全体关闭/打开视频",默认为true,即不显示
bNoMuteAllAudio配置会议中成员列表是否显示"全体禁音/解除全体静音",默认为false,即显示
bAudioAINSEnabled配置会议中智能语音降噪开关,默认为true,即开启
bShowMemberTag配置会议中成员列表是否显示成员标签,默认为false,即不显示
bShowMeetingRemainingTip配置会议中是否显示会议结束倒计时提示,默认为false,即不显示
bDetectMutedMic配置是否开启麦克风静音检测,默认开启。开启该功能后,SDK在检测到麦克风有音频输入,但此时处于静音打开的状态时,会提示用户关闭静音
bUnpubAudioOnMute配置本地静音时,是否关闭静音包发送。默认为true,即关闭静音包
bEmViewMode配置会议模式
bChatroomConfigIn聊天室配置
bNoCaptions是否显示字幕
bAutoEnableCaptionsOnJoin是否自动开启字幕
bNoTranscription是否显示转录

类成员变量说明

◆ audioAINSEnabled

bool NEMeetingOptions::audioAINSEnabled

配置会议中智能语音降噪开关,默认为true,即开启

◆ audioProfile

int NEMeetingOptions::audioProfile

语音相关参数 NEAudioProfile

◆ autoEnableCaptionsOnJoin

bool NEMeetingOptions::autoEnableCaptionsOnJoin = false

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

◆ chatMessageNotificationType

NEChatMessageNotificationType NEMeetingOptions::chatMessageNotificationType

配置新聊天消息提醒类型

◆ chatroomConfig

NEMeetingChatroomConfig NEMeetingOptions::chatroomConfig

聊天室配置 NEMeetingChatroomConfig

◆ defaultWindowMode

NEMeetingWindowMode NEMeetingOptions::defaultWindowMode

配置会议模式

◆ detectMutedMic

bool NEMeetingOptions::detectMutedMic

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

◆ enableAudioDeviceSwitch

bool NEMeetingOptions::enableAudioDeviceSwitch = true

是否允许音频设备切换

◆ enableAudioShare

bool NEMeetingOptions::enableAudioShare

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

◆ enableDirectMemberMediaControlByHost

bool NEMeetingOptions::enableDirectMemberMediaControlByHost = false

配置主持人和联席主持人是否可以直接开关参会者的音视频,不需要参会者同意,默认需要参会者同意。

◆ enableSpeakerSpotlight

bool NEMeetingOptions::enableSpeakerSpotlight

配置是否开启语音激励

◆ enableTransparentWhiteboard

bool NEMeetingOptions::enableTransparentWhiteboard

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

◆ fullMoreMenuItems

std::vector<NEMeetingMenuItemPtr> NEMeetingOptions::fullMoreMenuItems

底部“更多”菜单栏自定义菜单,最多添加10项,代替injected_more_menu_items_,这两个不能同时使用

◆ fullToolbarMenuItems

std::vector<NEMeetingMenuItemPtr> NEMeetingOptions::fullToolbarMenuItems

底部Toolbar菜单栏自定义菜单,最多显示7项,如果为空则显示默认的

◆ joinTimeout

int NEMeetingOptions::joinTimeout = 45 * 1000

入会超时时间,如果小于等于0,则使用默认值,默认为45秒,单位为毫秒

◆ meetingIdDisplayOption

NEShowMeetingIdOption NEMeetingOptions::meetingIdDisplayOption

配置会议ID的展示形式

◆ noAudio

bool NEMeetingOptions::noAudio

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

◆ noCaptions

bool NEMeetingOptions::noCaptions = false

配置会中是否展示“字幕”菜单,默认展示。

◆ noChat

bool NEMeetingOptions::noChat

配置会议中是否显示"聊天"按钮,比自定义菜单中的优先级高

◆ noInvite

bool NEMeetingOptions::noInvite

配置会议中是否显示"邀请"按钮,比自定义菜单中的优先级高

◆ noLive

bool NEMeetingOptions::noLive

配置是否在会议界面中显示"直播"入口

◆ noMinimize

bool NEMeetingOptions::noMinimize

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

◆ noMuteAllAudio

bool NEMeetingOptions::noMuteAllAudio

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

◆ noMuteAllVideo

bool NEMeetingOptions::noMuteAllVideo

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

◆ noNotifyCenter

bool NEMeetingOptions::noNotifyCenter = false

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

◆ noReadPhoneState

bool NEMeetingOptions::noReadPhoneState = false

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

◆ noRename

bool NEMeetingOptions::noRename

配置会议中是否显示"改名"菜单

◆ noScreenShare

bool NEMeetingOptions::noScreenShare

配置会议中是否显示"屏幕共享"按钮,比自定义菜单中的优先级高,默认为true,即显示

◆ noSip

bool NEMeetingOptions::noSip

配置会议中是否显示"sip"按钮,默认为true,即不显示

◆ noSwitchAudioMode

bool NEMeetingOptions::noSwitchAudioMode

配置会议中是否显示"切换音频模式"按钮

◆ noSwitchCamera

bool NEMeetingOptions::noSwitchCamera

配置会议中是否显示"切换摄像头"按钮

◆ noTranscription

bool NEMeetingOptions::noTranscription = false

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

◆ noVideo

bool NEMeetingOptions::noVideo

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

◆ noView

bool NEMeetingOptions::noView

配置会议中是否显示"视图"按钮,比自定义菜单中的优先级高,默认为true,即显示

◆ noWebApps

bool NEMeetingOptions::noWebApps = false

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

◆ noWhiteboard

bool NEMeetingOptions::noWhiteboard

配置会议中是否显示"白板"按钮,比自定义菜单中的优先级高

◆ pluginNotifyDuration

int NEMeetingOptions::pluginNotifyDuration = 5000

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

◆ showCloudRecordingUI

bool NEMeetingOptions::showCloudRecordingUI = true

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

◆ showCloudRecordMenuItem

bool NEMeetingOptions::showCloudRecordMenuItem = true

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

◆ showFloatingMicrophone

bool NEMeetingOptions::showFloatingMicrophone

配置会议中是否显示麦克风浮窗,默认为显示

◆ showMeetingRemainingTip

bool NEMeetingOptions::showMeetingRemainingTip

配置是否显示会议时长到期提示,默认为false,即不显示

◆ showMeetingTime

bool NEMeetingOptions::showMeetingTime

配置是否在会议界面中显示会议时长,入会前设置,会议中无法设置

◆ showMemberTag

bool NEMeetingOptions::showMemberTag

配置会议中成员列表是否显示成员标签,默认为false,即不显示

◆ showNameInVideo

bool NEMeetingOptions::showNameInVideo

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

◆ showNotYetJoinedMembers

bool NEMeetingOptions::showNotYetJoinedMembers = false

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

◆ showScreenShareUserVideo

bool NEMeetingOptions::showScreenShareUserVideo

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

◆ showWhiteboardShareUserVideo

bool NEMeetingOptions::showWhiteboardShareUserVideo

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

◆ unpubAudioOnMute

bool NEMeetingOptions::unpubAudioOnMute

配置本地静音时,是否关闭静音包发送。默认为true,即关闭静音包


该类的文档由以下文件生成: