NEMeetingKit V4.8.0
载入中...
搜索中...
未找到
构造函数 | 所有成员列表
NESettingsService类 参考

#include <NESettingsService.h>

类 NESettingsService 继承关系图:

构造函数

(void) - enableShowMyMeetingElapseTime:
 
(BOOL) - isShowMyMeetingElapseTimeEnabled
 
(void) - enableTurnOnMyVideoWhenJoinMeeting:
 
(BOOL) - isTurnOnMyVideoWhenJoinMeetingEnabled
 
(void) - enableTurnOnMyAudioWhenJoinMeeting:
 
(BOOL) - isTurnOnMyAudioWhenJoinMeetingEnabled
 
(BOOL) - isMeetingLiveSupported
 
(BOOL) - isMeetingWhiteboardSupported
 
(BOOL) - isMeetingCloudRecordSupported
 
(void) - enableAudioAINS:
 
(BOOL) - isAudioAINSEnabled
 
(void) - enableVirtualBackground:
 
(BOOL) - isVirtualBackgroundEnabled
 
(void) - setBuiltinVirtualBackgroundList:
 
(NSArray< NSString * > *) - getBuiltinVirtualBackgroundList
 
(void) - setExternalVirtualBackgroundList:
 
(NSArray< NSString * > *) - getExternalVirtualBackgroundList
 
(void) - setCurrentVirtualBackground:
 
(NSString *) - getCurrentVirtualBackground
 
(void) - enableSpeakerSpotlight:
 
(BOOL) - isSpeakerSpotlightEnabled
 查询是否打开语音激励
 
(void) - enableFrontCameraMirror:
 设置是否打开前置摄像头镜像
 
(BOOL) - isFrontCameraMirrorEnabled
 
(void) - enableTransparentWhiteboard:
 设置是否打开白板透明
 
(BOOL) - isTransparentWhiteboardEnabled
 
(BOOL) - isBeautyFaceSupported
 查询应用是否支持美颜
 
(int) - getBeautyFaceValue
 获取当前美颜参数,关闭返回0
 
(void) - setBeautyFaceValue:
 设置美颜参数
 
(BOOL) - isWaitingRoomSupported
 查询应用是否支持等候室
 
(BOOL) - isVirtualBackgroundSupported
 查询应用是否支持虚拟背景
 
(NEInterpretationConfig *) - getInterpretationConfig
 
(NEScheduledMemberConfig *) - getScheduledMemberConfig
 
(BOOL) - isNicknameUpdateSupported
 
(BOOL) - isAvatarUpdateSupported
 
(BOOL) - isCaptionsSupported
 
(BOOL) - isTranscriptionSupported
 
(BOOL) - isGuestJoinSupported
 
(BOOL) - isMeetingChatSupported
 
(NSString *) - getAppNotifySessionId
 
(NECloudRecordConfig *) - getCloudRecordConfig
 
(void) - setCloudRecordConfig:
 
(NEChatMessageNotificationType- getChatMessageNotificationType
 
(void) - setChatMessageNotificationType:
 
(BOOL) - isShowNameInVideoEnabled
 
(void) - enableShowNameInVideo:
 
(void) - enableShowNotYetJoinedMembers:
 
(BOOL) - isShowNotYetJoinedMembersEnabled
 
(void) - setASRTranslationLanguage:callback:
 
(NEMeetingASRTranslationLanguage- getASRTranslationLanguage
 
(void) - enableCaptionBilingual:callback:
 
(BOOL) - isCaptionBilingualEnabled
 
(void) - enableTranscriptionBilingual:callback:
 
(BOOL) - isTranscriptionBilingualEnabled
 
(void) - addSettingsChangedListener:
 
(void) - removeSettingsChangedListener:
 
(void) - setTurnOnMyVideoWhenJoinMeeting:
 
(void) - setTurnOnMyAudioWhenJoinMeeting:
 
(BOOL) - isMeetingLiveEnabled
 
(void) - getHistoryMeetingItem:
 
(BOOL) - isWhiteboardEnabled
 
(BOOL) - isCloudRecordEnabled
 
(void) - setBuiltinVirtualBackgrounds:
 
(NSArray< NEMeetingVirtualBackground * > *) - getBuiltinVirtualBackgrounds
 

详细描述

会议设置服务,可设置入会时、会议中的一些配置信息

如入会时的音视频开关选项,如果在入会时未指定NEMeetingOptions,则使用该设置服务提供的默认值

该设置服务使用设备本地存储,暂不支持漫游

可通过 NEMeetingKit#getSettingsService() 获取对应的服务实例。

函数文档

◆ addSettingsChangedListener:

- (void) addSettingsChangedListener: (id< NESettingsChangedListener >) listener

添加设置变更监听器

参数
listener监听器

◆ enableAudioAINS:

- (void) enableAudioAINS: (BOOL) enable

设置是否打开音频智能降噪

参数
enabletrue-开启,false-关闭

◆ enableCaptionBilingual:callback:

- (void) enableCaptionBilingual: (BOOL) enable
callback: (void(^)(NSInteger code, NSString *_Nullable message)) callback 

开启会中字幕同时显示双语

参数
enableYES-开启,NO-关闭
callback回调

◆ enableFrontCameraMirror:

- (void) enableFrontCameraMirror: (BOOL) enable

设置是否打开前置摄像头镜像

参数
enabletrue-开启,false-关闭

◆ enableShowMyMeetingElapseTime:

- (void) enableShowMyMeetingElapseTime: (BOOL) enable

设置是否显示会议时长

参数
enableYES-开启,NO-关闭

◆ enableShowNameInVideo:

- (void) enableShowNameInVideo: (BOOL) enable

设置是否在视频中显示用户名

参数
enable是否显示

◆ enableShowNotYetJoinedMembers:

- (void) enableShowNotYetJoinedMembers: (BOOL) enable

设置是否显示未入会成员

参数
enableYES-开启,NO-关闭

◆ enableSpeakerSpotlight:

- (void) enableSpeakerSpotlight: (BOOL) enable

设置是否打开语音激励

参数
enabletrue-开启,false-关闭

◆ enableTranscriptionBilingual:callback:

- (void) enableTranscriptionBilingual: (BOOL) enable
callback: (void(^)(NSInteger code, NSString *_Nullable message)) callback 

开启会中转写同时显示双语

参数
enableYES-开启,NO-关闭
callback回调

◆ enableTransparentWhiteboard:

- (void) enableTransparentWhiteboard: (BOOL) enable

设置是否打开白板透明

参数
enabletrue-开启,false-关闭

◆ enableTurnOnMyAudioWhenJoinMeeting:

- (void) enableTurnOnMyAudioWhenJoinMeeting: (BOOL) enable

设置入会时是否打开本地音频

参数
enableYES-入会时打开音频,NO-入会时关闭音频

◆ enableTurnOnMyVideoWhenJoinMeeting:

- (void) enableTurnOnMyVideoWhenJoinMeeting: (BOOL) enable

设置入会时是否打开本地视频

参数
enableYES-入会时打开视频,NO-入会时关闭视频

◆ enableVirtualBackground:

- (void) enableVirtualBackground: (BOOL) enable

设置是否显示虚拟背景

参数
enabletrue-打开,false-关闭

◆ getAppNotifySessionId

- (NSString *) getAppNotifySessionId

查询应用session会话Id

◆ getASRTranslationLanguage

- (NEMeetingASRTranslationLanguage) getASRTranslationLanguage

获取会中字幕/转写翻译语言

◆ getBeautyFaceValue

- (int) getBeautyFaceValue

获取当前美颜参数,关闭返回0

◆ getBuiltinVirtualBackgroundList

- (NSArray< NSString * > *) getBuiltinVirtualBackgroundList

获取内置虚拟背景图片路径列表

◆ getBuiltinVirtualBackgrounds

- (NSArray< NEMeetingVirtualBackground * > *) getBuiltinVirtualBackgrounds

获取虚拟背景列表

弃用
该方法已废弃,请使用 getBuiltinVirtualBackgroundList

◆ getChatMessageNotificationType

- (NEChatMessageNotificationType) getChatMessageNotificationType

查询聊天新消息提醒类型

◆ getCloudRecordConfig

- (NECloudRecordConfig *) getCloudRecordConfig

查询云录制配置

◆ getCurrentVirtualBackground

- (NSString *) getCurrentVirtualBackground

获取最近选择的虚拟背景图片路径

◆ getExternalVirtualBackgroundList

- (NSArray< NSString * > *) getExternalVirtualBackgroundList

获取外部虚拟背景图片路径列表

◆ getHistoryMeetingItem:

- (void) getHistoryMeetingItem: (void(^)(NSInteger code, NSString *message, NSArray< NEHistoryMeetingItem * > *data)) callback

获取历史会议列表。当前仅会返回最近一次的会议记录,不支持漫游保存。

弃用
该方法已废弃,请使用 getLocalHistoryMeetingList: (NEPreMeetingService)
参数
callback回调

◆ getInterpretationConfig

- (NEInterpretationConfig *) getInterpretationConfig
 查询应用是否支持会议设备邀请
&zwj;/
  • (BOOL)isCallOutRoomSystemDeviceSupported;

/*! 查询应用同声传译配置

◆ getScheduledMemberConfig

- (NEScheduledMemberConfig *) getScheduledMemberConfig

查询应用预约会议指定成员配置

◆ isAudioAINSEnabled

- (BOOL) isAudioAINSEnabled

查询音频智能降噪是否打开

◆ isAvatarUpdateSupported

- (BOOL) isAvatarUpdateSupported

查询应用是否支持编辑头像

◆ isBeautyFaceSupported

- (BOOL) isBeautyFaceSupported

查询应用是否支持美颜

◆ isCaptionBilingualEnabled

- (BOOL) isCaptionBilingualEnabled

查询会中字幕同时显示双语是否开启

◆ isCaptionsSupported

- (BOOL) isCaptionsSupported

查询应用是否支持字幕功能

◆ isCloudRecordEnabled

- (BOOL) isCloudRecordEnabled

查询云端录制开关状态

弃用
该方法已废弃,请使用 isMeetingCloudRecordSupported
返回
true-打开,false-关闭

◆ isFrontCameraMirrorEnabled

- (BOOL) isFrontCameraMirrorEnabled

查询前置摄像头镜像是否打开

◆ isGuestJoinSupported

- (BOOL) isGuestJoinSupported

查询应用是否支持访客入会

◆ isMeetingChatSupported

- (BOOL) isMeetingChatSupported

查询应用是否支持聊天室服务

◆ isMeetingCloudRecordSupported

- (BOOL) isMeetingCloudRecordSupported

查询应用是否支持云端录制服务

◆ isMeetingLiveEnabled

- (BOOL) isMeetingLiveEnabled

查询会议是否拥有直播权限

弃用
该方法已废弃,请使用 isMeetingLiveSupported:
返回
YES-拥有直播权限,NO-无直播权限

◆ isMeetingLiveSupported

- (BOOL) isMeetingLiveSupported

查询应用是否支持会议直播

◆ isMeetingWhiteboardSupported

- (BOOL) isMeetingWhiteboardSupported

查询应用是否支持白板共享

◆ isNicknameUpdateSupported

- (BOOL) isNicknameUpdateSupported

查询应用是否支持编辑昵称

◆ isShowMyMeetingElapseTimeEnabled

- (BOOL) isShowMyMeetingElapseTimeEnabled

查询是否显示会议时长

◆ isShowNameInVideoEnabled

- (BOOL) isShowNameInVideoEnabled

查询是否在视频中显示用户名

◆ isShowNotYetJoinedMembersEnabled

- (BOOL) isShowNotYetJoinedMembersEnabled

查询是否显示未入会成员

◆ isSpeakerSpotlightEnabled

- (BOOL) isSpeakerSpotlightEnabled

查询是否打开语音激励

◆ isTranscriptionBilingualEnabled

- (BOOL) isTranscriptionBilingualEnabled

查询会中转写同时显示双语是否开启

◆ isTranscriptionSupported

- (BOOL) isTranscriptionSupported

查询应用是否支持转写功能

◆ isTransparentWhiteboardEnabled

- (BOOL) isTransparentWhiteboardEnabled

查询白板透明是否打开

◆ isTurnOnMyAudioWhenJoinMeetingEnabled

- (BOOL) isTurnOnMyAudioWhenJoinMeetingEnabled

查询入会时是否打开本地音频

◆ isTurnOnMyVideoWhenJoinMeetingEnabled

- (BOOL) isTurnOnMyVideoWhenJoinMeetingEnabled

查询入会时是否打开本地视频

◆ isVirtualBackgroundEnabled

- (BOOL) isVirtualBackgroundEnabled

查询虚拟背景是否显示

◆ isVirtualBackgroundSupported

- (BOOL) isVirtualBackgroundSupported

查询应用是否支持虚拟背景

◆ isWaitingRoomSupported

- (BOOL) isWaitingRoomSupported

查询应用是否支持等候室

◆ isWhiteboardEnabled

- (BOOL) isWhiteboardEnabled

查询白板开关状态

弃用
该方法已废弃,请使用 isMeetingWhiteboardSupported
返回
true-打开,false-关闭

◆ removeSettingsChangedListener:

- (void) removeSettingsChangedListener: (id< NESettingsChangedListener >) listener

移除设置变更监听器

参数
listener监听器

◆ setASRTranslationLanguage:callback:

- (void) setASRTranslationLanguage: (NEMeetingASRTranslationLanguage) language
callback: (void(^)(NSInteger code, NSString *_Nullable message)) callback 

设置会中字幕/转写翻译语言

参数
language目标翻译语言
callback回调

◆ setBeautyFaceValue:

- (void) setBeautyFaceValue: (int) value

设置美颜参数

参数
value传入美颜等级,参数规则为[0,10]整数

◆ setBuiltinVirtualBackgroundList:

- (void) setBuiltinVirtualBackgroundList: (NSArray< NSString * > *) pathList

设置内置虚拟背景图片路径列表

参数
pathList虚拟背景图片路径列表

◆ setBuiltinVirtualBackgrounds:

- (void) setBuiltinVirtualBackgrounds: (NSArray< NEMeetingVirtualBackground * > *) virtualBackgrounds

设置内置虚拟背景列表

弃用
该方法已废弃,请使用 setBuiltinVirtualBackgroundList:
参数
virtualBackgrounds虚拟背景图片路径列表

◆ setChatMessageNotificationType:

- (void) setChatMessageNotificationType: (NEChatMessageNotificationType) type

设置聊天新消息提醒类型

参数
type聊天新消息提醒类型

◆ setCloudRecordConfig:

- (void) setCloudRecordConfig: (NECloudRecordConfig *) config

设置云录制配置

参数
config云录制配置

◆ setCurrentVirtualBackground:

- (void) setCurrentVirtualBackground: (NSString *) path

设置最近选择的虚拟背景图片路径

参数
path虚拟背景图片路径,为空代表不设置虚拟背景

◆ setExternalVirtualBackgroundList:

- (void) setExternalVirtualBackgroundList: (NSArray< NSString * > *) pathList

设置外部虚拟背景图片路径列表

参数
pathList虚拟背景图片路径列表

◆ setTurnOnMyAudioWhenJoinMeeting:

- (void) setTurnOnMyAudioWhenJoinMeeting: (BOOL) enabled

设置入会时本地音频开关

弃用
该方法已废弃,请使用 enableTurnOnMyAudioWhenJoinMeeting:
参数
enabledYES-入会时打开音频,NO-入会时关闭音频

◆ setTurnOnMyVideoWhenJoinMeeting:

- (void) setTurnOnMyVideoWhenJoinMeeting: (BOOL) enabled

设置入会时本地视频开关

弃用
该方法已废弃,请使用 enableTurnOnMyVideoWhenJoinMeeting:
参数
enabledYES-入会时打开视频,NO-入会时关闭视频

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