#include <NESettingsService.h>
类 NESettingsService 继承关系图:
详细描述
会议设置服务，可设置入会时、会议中的一些配置信息
如入会时的音视频开关选项，如果在入会时未指定NEMeetingOptions，则使用该设置服务提供的默认值
该设置服务使用设备本地存储，暂不支持跨设备漫游，且设置信息是按用户账号隔离的（不同账号在同一设备上有独立的配置）
注意：需要在用户登录成功后再调用本服务的相关方法，未登录时调用将不会生效
可通过 NEMeetingKit#getSettingsService() 获取对应的服务实例。
函数文档
◆ addSettingsChangedListener:
| - (void) addSettingsChangedListener: | (id< NESettingsChangedListener >) | listener |
添加设置变更监听器
- 参数
-
listener 监听器
◆ DEPRECATED_MSG_ATTRIBUTE [1/6]
| - ("deprecated in 4.6.0, use getBuiltinVirtualBackgroundList instead") DEPRECATED_MSG_ATTRIBUTE |
获取虚拟背景列表
- 弃用
- 该方法已废弃，请使用 getBuiltinVirtualBackgroundList
◆ DEPRECATED_MSG_ATTRIBUTE [2/6]
| - ("deprecated in 4.9.0, use getMeetingElapsedTimeDisplayType instead") DEPRECATED_MSG_ATTRIBUTE |
查询是否显示会议时长
- 弃用
- 该方法已废弃，请使用getMeetingElapsedTimeDisplayType
◆ DEPRECATED_MSG_ATTRIBUTE [3/6]
| - ("deprecated in 4.6.0, use isMeetingCloudRecordSupported instead") DEPRECATED_MSG_ATTRIBUTE |
◆ DEPRECATED_MSG_ATTRIBUTE [4/6]
| - ("deprecated in 4.6.0, use isMeetingWhiteboardSupported instead") DEPRECATED_MSG_ATTRIBUTE |
◆ DEPRECATED_MSG_ATTRIBUTE [5/6]
| - ("deprecated in 4.6.0, use isMeetingLiveSupported instead") DEPRECATED_MSG_ATTRIBUTE |
◆ DEPRECATED_MSG_ATTRIBUTE [6/6]
| - ("deprecated in 4.13.0, use getAudioAINSMode instead") DEPRECATED_MSG_ATTRIBUTE |
查询音频智能降噪是否打开
◆ enableAudioAINS:
| - (void) enableAudioAINS: | (BOOL) | enable |
设置是否打开音频智能降噪
- 参数
-
enable true-开启，false-关闭
◆ enableAudioAINSMode:
| - (void) enableAudioAINSMode: | (NEAudioAINSMode) | mode |
设置音频智能降噪模式
- 参数
-
mode 关闭/普通降噪模式/增强降噪模式。
◆ enableAutoSilentOnLock:
| - (void) enableAutoSilentOnLock: | (BOOL) | enable |
设置开启/关闭锁屏时自动静音,默认不开启 秒录场景下，锁屏时自动暂停转写，解锁时自动恢复转写。
- 参数
-
enable YES-开启，NO-关闭
◆ enableCaptionBilingual:callback:
| - (void) enableCaptionBilingual: | (BOOL) | enable | |
| callback: | (void(^)(NSInteger code, NSString *_Nullable message)) | callback |
开启会中字幕同时显示双语
- 参数
-
enable YES-开启，NO-关闭 callback 回调
◆ enableFrontCameraMirror:
| - (void) enableFrontCameraMirror: | (BOOL) | enable |
设置是否打开前置摄像头镜像
- 参数
-
enable true-开启，false-关闭
◆ enableShowMyMeetingElapseTime:
| - (void) enableShowMyMeetingElapseTime: | (BOOL) | enable |
◆ enableShowNameInVideo:
| - (void) enableShowNameInVideo: | (BOOL) | enable |
设置是否在视频中显示用户名
- 参数
-
enable 是否显示
◆ enableShowNotYetJoinedMembers:
| - (void) enableShowNotYetJoinedMembers: | (BOOL) | enable |
设置是否显示未入会成员
- 参数
-
enable YES-开启，NO-关闭
◆ enableSpeakerSpotlight:
| - (void) enableSpeakerSpotlight: | (BOOL) | enable |
设置是否打开语音激励
- 参数
-
enable true-开启，false-关闭
◆ enableTranscriptionBilingual:callback:
| - (void) enableTranscriptionBilingual: | (BOOL) | enable | |
| callback: | (void(^)(NSInteger code, NSString *_Nullable message)) | callback |
开启会中转写同时显示双语
- 参数
-
enable YES-开启，NO-关闭 callback 回调
◆ enableTransparentWhiteboard:
| - (void) enableTransparentWhiteboard: | (BOOL) | enable |
设置是否打开白板透明
- 参数
-
enable true-开启，false-关闭
◆ enableTurnOnMyAudioWhenJoinMeeting:
| - (void) enableTurnOnMyAudioWhenJoinMeeting: | (BOOL) | enable |
设置入会时是否打开本地音频
- 参数
-
enable YES-入会时打开音频，NO-入会时关闭音频
◆ enableTurnOnMyVideoWhenJoinMeeting:
| - (void) enableTurnOnMyVideoWhenJoinMeeting: | (BOOL) | enable |
设置入会时是否打开本地视频
- 参数
-
enable YES-入会时打开视频，NO-入会时关闭视频
◆ enableVirtualBackground:
| - (void) enableVirtualBackground: | (BOOL) | enable |
设置是否显示虚拟背景
- 参数
-
enable true-打开，false-关闭
◆ getAppNotifySessionId
| - (NSString *) getAppNotifySessionId |
查询应用session会话Id
◆ getASRTranslationLanguage
| - (NSString *_Nullable) getASRTranslationLanguage |
获取会中字幕/转写翻译语言
◆ getAudioAINSMode
| - (NEAudioAINSMode) getAudioAINSMode |
查询音频智能降噪模式
◆ getBeautyFaceValue
| - (int) getBeautyFaceValue |
获取当前美颜参数，关闭返回0
◆ getBuiltinVirtualBackgroundList
| - (NSArray< NSString * > *) getBuiltinVirtualBackgroundList |
获取内置虚拟背景图片路径列表
◆ getChatMessageNotificationType
| - (NEChatMessageNotificationType) getChatMessageNotificationType |
查询聊天新消息提醒类型
◆ getCloudRecordConfig
| - (NECloudRecordConfig *) getCloudRecordConfig |
查询云录制配置
◆ getCurrentVirtualBackground
| - (NSString *) getCurrentVirtualBackground |
获取最近选择的虚拟背景图片路径,背景虚化时返回"blur_background"
◆ getExternalVirtualBackgroundList
| - (NSArray< NSString * > *) getExternalVirtualBackgroundList |
获取外部虚拟背景图片路径列表
◆ getHistoryMeetingItem:
| - (void) getHistoryMeetingItem: | ("deprecated in 4.6.) | 0 | |
| (use NEPreMeetingService getLocalHistoryMeetingList:instead") | DEPRECATED_MSG_ATTRIBUTE |
获取历史会议列表。当前仅会返回最近一次的会议记录，不支持漫游保存。
- 参数
-
callback 回调
◆ getInterpretationConfig
| - (NEInterpretationConfig *) getInterpretationConfig |
查询应用同声传译配置
◆ getMeetingElapsedTimeDisplayType
| - (NEMeetingElapsedTimeDisplayType) getMeetingElapsedTimeDisplayType |
查询会议时长展示类型
◆ getScheduledMemberConfig
| - (NEScheduledMemberConfig *) getScheduledMemberConfig |
查询应用预约会议指定成员配置
◆ getThemeMode
| - (NEMeetingThemeType) getThemeMode |
获取会中主题模式
◆ isAutoSilentOnLockEnabled
| - (BOOL) isAutoSilentOnLockEnabled |
锁屏时是否自动静音
◆ isAvatarUpdateSupported
| - (BOOL) isAvatarUpdateSupported |
查询应用是否支持编辑头像
◆ isBeautyFaceSupported
| - (BOOL) isBeautyFaceSupported |
查询应用是否支持美颜
◆ isCallOutRoomSystemDeviceSupported
| - (BOOL) isCallOutRoomSystemDeviceSupported |
查询应用是否支持会议设备邀请
◆ isCaptionBilingualEnabled
| - (BOOL) isCaptionBilingualEnabled |
查询会中字幕同时显示双语是否开启
◆ isCaptionsSupported
| - (BOOL) isCaptionsSupported |
查询应用是否支持字幕功能
◆ isFrontCameraMirrorEnabled
| - (BOOL) isFrontCameraMirrorEnabled |
查询前置摄像头镜像是否打开
◆ isGuestJoinSupported
| - (BOOL) isGuestJoinSupported |
查询应用是否支持访客入会
◆ isMeetingChatSupported
| - (BOOL) isMeetingChatSupported |
查询应用是否支持聊天室服务
◆ isMeetingCloudRecordSupported
| - (BOOL) isMeetingCloudRecordSupported |
查询应用是否支持云端录制服务
◆ isMeetingLiveSupported
| - (BOOL) isMeetingLiveSupported |
查询应用是否支持会议直播
◆ isMeetingWhiteboardSupported
| - (BOOL) isMeetingWhiteboardSupported |
查询应用是否支持白板共享
◆ isNicknameUpdateSupported
| - (BOOL) isNicknameUpdateSupported |
查询应用是否支持编辑昵称
◆ 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 |
查询应用是否支持等候室
◆ removeSettingsChangedListener:
| - (void) removeSettingsChangedListener: | (id< NESettingsChangedListener >) | listener |
移除设置变更监听器
- 参数
-
listener 监听器
◆ setASRTranslationLanguage:callback:
| - (void) setASRTranslationLanguage: | (NSString *_Nullable) | 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 |
◆ setChatMessageNotificationType:
| - (void) setChatMessageNotificationType: | (NEChatMessageNotificationType) | type |
设置聊天新消息提醒类型
- 参数
-
type 聊天新消息提醒类型
◆ setCloudRecordConfig:
| - (void) setCloudRecordConfig: | (NECloudRecordConfig *) | config |
设置云录制配置
- 参数
-
config 云录制配置
◆ setCurrentVirtualBackground:
| - (void) setCurrentVirtualBackground: | (NSString *) | path |
设置最近选择的虚拟背景图片路径
- 参数
-
path 虚拟背景图片路径,为空代表不设置虚拟背景,背景虚化时请传入"blur_background"
◆ setExternalVirtualBackgroundList:
| - (void) setExternalVirtualBackgroundList: | (NSArray< NSString * > *) | pathList |
设置外部虚拟背景图片路径列表
- 参数
-
pathList 虚拟背景图片路径列表
◆ setMeetingElapsedTimeDisplayType:
| - (void) setMeetingElapsedTimeDisplayType: | (NEMeetingElapsedTimeDisplayType) | type |
设置会议时长展示类型
- 参数
-
type 会议时长展示类型
◆ setThemeMode:
| - (void) setThemeMode: | (NEMeetingThemeType) | mode |
设置会中主题模式
- 参数
-
mode 主题模式
◆ setTurnOnMyAudioWhenJoinMeeting:
| - (void) setTurnOnMyAudioWhenJoinMeeting: | ("deprecated in 4.6.) | 0 | |
| (use enableTurnOnMyAudioWhenJoinMeeting:instead") | DEPRECATED_MSG_ATTRIBUTE |
◆ setTurnOnMyVideoWhenJoinMeeting:
| - (void) setTurnOnMyVideoWhenJoinMeeting: | ("deprecated in 4.6.) | 0 | |
| (use enableTurnOnMyVideoWhenJoinMeeting:instead") | DEPRECATED_MSG_ATTRIBUTE |
该类的文档由以下文件生成:
- NEMeetingKit/ExportHeaders/NESettingsService.h
