NEMeetingKit V4.9.0
载入中...
搜索中...
未找到
实例方法 | 属性 | 所有成员列表
NEMeetingOptions类 参考

#include <NEMeetingOptions.h>

类 NEMeetingOptions 继承关系图:
NEJoinMeetingOptions NEStartMeetingOptions

实例方法

(BOOL showMeetingTime) - DEPRECATED_MSG_ATTRIBUTE
 

属性

BOOL noMuteAllVideo
 
BOOL noMuteAllAudio
 
BOOL noVideo
 
BOOL noAudio
 
NEMeetingElapsedTimeDisplayType meetingElapsedTimeDisplayType
 
BOOL showNameInVideo
 
BOOL enableSpeakerSpotlight
 
BOOL noMinimize
 
BOOL noInvite
 
BOOL noSip
 
BOOL noChat
 
BOOL noSwitchCamera
 
BOOL enableFrontCameraMirror
 
BOOL noSwitchAudioMode
 
BOOL noGallery
 
BOOL noWhiteBoard
 
BOOL noRename
 
BOOL noLive
 
BOOL showMeetingRemainingTip
 
BOOL showScreenShareUserVideo
 
BOOL enableAudioShare
 
BOOL showWhiteboardShareUserVideo
 
BOOL enableTransparentWhiteboard
 
BOOL showFloatingMicrophone
 
BOOL showMemberTag
 
BOOL detectMutedMic
 
BOOL unpubAudioOnMute
 
NEMeetingWindowMode defaultWindowMode
 
NEMeetingIdDisplayOption meetingIdDisplayOption
 
NSArray< NEMeetingMenuItem * > * fullToolbarMenuItems
 
NSArray< NEMeetingMenuItem * > * fullMoreMenuItems
 
NSArray< NEMeetingMenuItem * > * memberActionMenuItems
 
NSInteger joinTimeout
 
NEAudioProfile * audioProfile
 
NEMeetingChatroomConfig * chatroomConfig
 
BOOL showCloudRecordMenuItem
 
BOOL showCloudRecordingUI
 
BOOL noNotifyCenter
 
BOOL noWebApps
 
BOOL noCaptions
 
BOOL noTranscription
 
BOOL autoEnableCaptionsOnJoin
 
NEChatMessageNotificationType chatMessageNotificationType
 
int pluginNotifyDuration
 
BOOL enablePictureInPicture
 
BOOL showNotYetJoinedMembers
 
BOOL enableDirectMemberMediaControlByHost
 

详细描述

提供创建和加入会议时必要的基本配置信息和选项开关，通过这些配置和选项可控制入会时的行为，如音视频的开启状态等

成员函数文档

◆ DEPRECATED_MSG_ATTRIBUTE

- (BOOL showMeetingTime) DEPRECATED_MSG_ATTRIBUTE ("deprecated in 4.9.) 0
(use meetingElapsedTimeDisplayType instead")  

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

弃用
该属性已弃用，请使用meetingElapsedTimeDisplayType

属性说明

◆ audioProfile

- (NEAudioProfile*) audioProfile
readwritenonatomicstrong

语音相关参数

◆ autoEnableCaptionsOnJoin

- (BOOL) autoEnableCaptionsOnJoin
readwritenonatomicassign

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

◆ chatMessageNotificationType

- (NEChatMessageNotificationType) chatMessageNotificationType
readwritenonatomicassign

配置新聊天消息提醒类型

◆ chatroomConfig

- (NEMeetingChatroomConfig*) chatroomConfig
readwritenonatomicstrong

聊天室配置

◆ defaultWindowMode

- (NEMeetingWindowMode) defaultWindowMode
readwritenonatomicassign

会议UI的首次展示模式，默认NEMeetingWindowModeGallery

◆ detectMutedMic

- (BOOL) detectMutedMic
readwritenonatomicassign

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

◆ enableAudioShare

- (BOOL) enableAudioShare
readwritenonatomicassign

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

◆ enableDirectMemberMediaControlByHost

- (BOOL) enableDirectMemberMediaControlByHost
readwritenonatomicassign

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

◆ enableFrontCameraMirror

- (BOOL) enableFrontCameraMirror
readwritenonatomicassign

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

◆ enablePictureInPicture

- (BOOL) enablePictureInPicture
readwritenonatomicassign

配置会中退后台是否自动小窗，默认自动小窗

◆ enableSpeakerSpotlight

- (BOOL) enableSpeakerSpotlight
readwritenonatomicassign

配置是否开启语音激励

◆ enableTransparentWhiteboard

- (BOOL) enableTransparentWhiteboard
readwritenonatomicassign

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

◆ fullMoreMenuItems

- (NSArray<NEMeetingMenuItem *>*) fullMoreMenuItems
readwritenonatomicstrong

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

注意：部分SDK内置菜单只支持在Toolbar菜单列表中显示，不能放入"更多"菜单列表中。

◆ fullToolbarMenuItems

- (NSArray<NEMeetingMenuItem *>*) fullToolbarMenuItems
readwritenonatomicstrong

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

注意：部分SDK内置菜单只支持在Toolbar菜单列表中显示，不能放入"更多"菜单列表中。

◆ joinTimeout

- (NSInteger) joinTimeout
readwritenonatomicassign

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

◆ meetingElapsedTimeDisplayType

- (NEMeetingElapsedTimeDisplayType) meetingElapsedTimeDisplayType
readwritenonatomicassign

配置会议界面中时间显示类型

◆ meetingIdDisplayOption

- (NEMeetingIdDisplayOption) meetingIdDisplayOption
readwritenonatomicassign

会中"会议号"显示规则

◆ memberActionMenuItems

- (NSArray<NEMeetingMenuItem *>*) memberActionMenuItems
readwritenonatomicstrong

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

◆ noAudio

- (BOOL) noAudio
readwritenonatomicassign

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

◆ noCaptions

- (BOOL) noCaptions
readwritenonatomicassign

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

◆ noChat

- (BOOL) noChat
readwritenonatomicassign

配置会议中是否显示"聊天"按钮

◆ noGallery

- (BOOL) noGallery
readwritenonatomicassign

配置会议中是否显示画廊模式

◆ noInvite

- (BOOL) noInvite
readwritenonatomicassign

配置会议中是否显示"邀请"按钮

◆ noLive

- (BOOL) noLive
readwritenonatomicassign

配置会议中是否显示"直播"按钮

◆ noMinimize

- (BOOL) noMinimize
readwritenonatomicassign

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

◆ noMuteAllAudio

- (BOOL) noMuteAllAudio
readwritenonatomicassign

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

◆ noMuteAllVideo

- (BOOL) noMuteAllVideo
readwritenonatomicassign

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

◆ noNotifyCenter

- (BOOL) noNotifyCenter
readwritenonatomicassign

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

◆ noRename

- (BOOL) noRename
readwritenonatomicassign

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

◆ noSip

- (BOOL) noSip
readwritenonatomicassign

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

◆ noSwitchAudioMode

- (BOOL) noSwitchAudioMode
readwritenonatomicassign

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

◆ noSwitchCamera

- (BOOL) noSwitchCamera
readwritenonatomicassign

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

◆ noTranscription

- (BOOL) noTranscription
readwritenonatomicassign

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

◆ noVideo

- (BOOL) noVideo
readwritenonatomicassign

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

◆ noWebApps

- (BOOL) noWebApps
readwritenonatomicassign

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

◆ noWhiteBoard

- (BOOL) noWhiteBoard
readwritenonatomicassign

加入房间，指定是否显示白板按钮，默认为NO,即显示白板按钮

◆ pluginNotifyDuration

- (int) pluginNotifyDuration
readwritenonatomicassign

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

◆ showCloudRecordingUI

- (BOOL) showCloudRecordingUI
readwritenonatomicassign

配置会议内是否展示云录制过程中的UI提示

◆ showCloudRecordMenuItem

- (BOOL) showCloudRecordMenuItem
readwritenonatomicassign

配置会议内是否展示云录制菜单按钮, SDKConfig支持云录制时有效

◆ showFloatingMicrophone

- (BOOL) showFloatingMicrophone
readwritenonatomicassign

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

◆ showMeetingRemainingTip

- (BOOL) showMeetingRemainingTip
readwritenonatomicassign

配置是会议剩余时间，默认为NO，单位/秒

◆ showMemberTag

- (BOOL) showMemberTag
readwritenonatomicassign

配置是否在会议中显示用户角色tag，默认为NO

◆ showNameInVideo

- (BOOL) showNameInVideo
readwritenonatomicassign

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

◆ showNotYetJoinedMembers

- (BOOL) showNotYetJoinedMembers
readwritenonatomicassign

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

◆ showScreenShareUserVideo

- (BOOL) showScreenShareUserVideo
readwritenonatomicassign

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

◆ showWhiteboardShareUserVideo

- (BOOL) showWhiteboardShareUserVideo
readwritenonatomicassign

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

◆ unpubAudioOnMute

- (BOOL) unpubAudioOnMute
readwritenonatomicassign

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

该类的文档由以下文件生成:
制作者 doxygen 1.12.0