程序包 com.netease.yunxin.kit.meeting.sdk

接口 NESettingsService

public interface NESettingsService
会议设置服务，可设置入会时、会议中的一些配置信息

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

该设置服务使用设备本地存储，暂不支持跨设备漫游，且设置信息是按用户账号隔离的（不同账号在同一设备上有独立的配置）

注意：需要在用户登录成功后再调用本服务的相关方法，未登录时调用将不会生效

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

  • 方法详细资料

    • enableShowMyMeetingElapseTime

      @Deprecated void enableShowMyMeetingElapseTime(boolean enable)
      已过时。
      设置是否显示会议时长
      参数:
      enable - true-开启，false-关闭 @Deprecated 请使用 setMeetingElapsedTimeDisplayType(NEMeetingElapsedTimeDisplayType)

    • isShowMyMeetingElapseTimeEnabled

      @Deprecated boolean isShowMyMeetingElapseTimeEnabled()
      已过时。
      查询是否显示会议时长 @Deprecated 请使用 getMeetingElapsedTimeDisplayType()

    • setMeetingElapsedTimeDisplayType

      void setMeetingElapsedTimeDisplayType(NEMeetingElapsedTimeDisplayType type)
      设置会议时长展示类型
      参数:
      type - 会议时长展示类型

    • getMeetingElapsedTimeDisplayType

      NEMeetingElapsedTimeDisplayType getMeetingElapsedTimeDisplayType()
      查询会议时长展示类型

    • enableTurnOnMyVideoWhenJoinMeeting

      void enableTurnOnMyVideoWhenJoinMeeting(boolean enable)
      设置入会时是否打开本地视频
      参数:
      enable - true-入会时打开视频，false-入会时关闭视频

    • isTurnOnMyVideoWhenJoinMeetingEnabled

      boolean isTurnOnMyVideoWhenJoinMeetingEnabled()
      查询入会时是否打开本地视频

    • enableTurnOnMyAudioWhenJoinMeeting

      void enableTurnOnMyAudioWhenJoinMeeting(boolean enable)
      设置入会时是否打开本地音频
      参数:
      enable - true-入会时打开音频，false-入会时关闭音频

    • isTurnOnMyAudioWhenJoinMeetingEnabled

      boolean isTurnOnMyAudioWhenJoinMeetingEnabled()
      查询入会时是否打开本地音频

    • isMeetingLiveSupported

      boolean isMeetingLiveSupported()
      查询应用是否支持会议直播

    • isMeetingWhiteboardSupported

      boolean isMeetingWhiteboardSupported()
      查询应用是否支持白板共享

    • isMeetingCloudRecordSupported

      boolean isMeetingCloudRecordSupported()
      查询应用是否支持云端录制服务

    • enableAudioAINS

      @Deprecated void enableAudioAINS(boolean enable)
      已过时。
      设置是否打开音频智能降噪
      参数:
      enable - true-开启，false-关闭

    • isAudioAINSEnabled

      @Deprecated boolean isAudioAINSEnabled()
      已过时。
      查询音频智能降噪是否打开

    • enableAudioAINSMode

      void enableAudioAINSMode(NEAudioAINSMode mode)
      设置音频智能降噪模式
      参数:
      mode - 关闭/普通降噪模式/增强降噪模式。

    • getAudioAINSMode

      NEAudioAINSMode getAudioAINSMode()
      查询音频智能降噪模式

    • enableVirtualBackground

      void enableVirtualBackground(boolean enable)
      设置是否显示虚拟背景
      参数:
      enable - true-打开，false-关闭

    • isVirtualBackgroundEnabled

      boolean isVirtualBackgroundEnabled()
      查询虚拟背景是否显示

    • setBuiltinVirtualBackgroundList

      void setBuiltinVirtualBackgroundList(List<String> pathList)
      设置内置虚拟背景图片路径列表
      参数:
      pathList - 虚拟背景图片路径列表

    • getBuiltinVirtualBackgroundList

      List<String> getBuiltinVirtualBackgroundList()
      获取内置虚拟背景图片路径列表

    • setExternalVirtualBackgroundList

      void setExternalVirtualBackgroundList(List<String> pathList)
      设置外部虚拟背景图片路径列表
      参数:
      pathList - 虚拟背景图片路径列表

    • getExternalVirtualBackgroundList

      List<String> getExternalVirtualBackgroundList()
      获取外部虚拟背景图片路径列表

    • setCurrentVirtualBackground

      void setCurrentVirtualBackground(String path)
      设置最近选择的虚拟背景图片路径
      参数:
      path - 虚拟背景图片路径,为空代表不设置虚拟背景

    • getCurrentVirtualBackground

      String getCurrentVirtualBackground()
      获取最近选择的虚拟背景图片路径

    • enableSpeakerSpotlight

      void enableSpeakerSpotlight(boolean enable)
      设置是否打开语音激励
      参数:
      enable - true-开启，false-关闭

    • isSpeakerSpotlightEnabled

      boolean isSpeakerSpotlightEnabled()
      查询是否打开语音激励

    • enableFrontCameraMirror

      void enableFrontCameraMirror(boolean enable)
      设置是否打开前置摄像头镜像
      参数:
      enable - true-开启，false-关闭

    • isFrontCameraMirrorEnabled

      boolean isFrontCameraMirrorEnabled()
      查询前置摄像头镜像是否打开

    • enableTransparentWhiteboard

      void enableTransparentWhiteboard(boolean enable)
      设置是否打开白板透明
      参数:
      enable - true-开启，false-关闭

    • isTransparentWhiteboardEnabled

      boolean isTransparentWhiteboardEnabled()
      查询白板透明是否打开

    • isBeautyFaceSupported

      boolean isBeautyFaceSupported()
      查询应用是否支持美颜

    • getBeautyFaceValue

      Integer getBeautyFaceValue()
      获取当前美颜参数，关闭返回0

    • setBeautyFaceValue

      void setBeautyFaceValue(int value)
      设置美颜参数
      参数:
      value - 传入美颜等级，参数规则为[0,10]整数

    • isWaitingRoomSupported

      boolean isWaitingRoomSupported()
      查询应用是否支持等候室

    • isVirtualBackgroundSupported

      boolean isVirtualBackgroundSupported()
      查询应用是否支持虚拟背景

    • isCallOutRoomSystemDeviceSupported

      boolean isCallOutRoomSystemDeviceSupported()
      查询应用是否支持会议设备呼叫

    • getInterpretationConfig

      NEInterpretationConfig getInterpretationConfig()
      查询应用同声传译配置

    • getScheduledMemberConfig

      NEScheduledMemberConfig getScheduledMemberConfig()
      查询应用预约会议指定成员配置

    • isNicknameUpdateSupported

      boolean isNicknameUpdateSupported()
      查询应用是否支持编辑昵称

    • isAvatarUpdateSupported

      boolean isAvatarUpdateSupported()
      查询应用是否支持编辑头像

    • isCaptionsSupported

      boolean isCaptionsSupported()
      查询应用是否支持字幕功能

    • isTranscriptionSupported

      boolean isTranscriptionSupported()
      查询应用是否支持转写功能

    • isGuestJoinSupported

      boolean isGuestJoinSupported()
      查询应用是否支持访客入会

    • isMeetingChatSupported

      boolean isMeetingChatSupported()
      查询应用是否支持聊天室服务

    • getAppNotifySessionId

      String getAppNotifySessionId()
      查询应用session会话Id

    • setCloudRecordConfig

      void setCloudRecordConfig(NECloudRecordConfig config)
      设置云录制配置

    • getCloudRecordConfig

      NECloudRecordConfig getCloudRecordConfig()
      查询云录制配置

    • enableShowNameInVideo

      void enableShowNameInVideo(boolean enable)
      设置是否在视频中显示用户名

    • isShowNameInVideoEnabled

      boolean isShowNameInVideoEnabled()
      查询是否在视频中显示用户名

    • setChatMessageNotificationType

      void setChatMessageNotificationType(NEChatMessageNotificationType type)
      设置聊天新消息提醒类型
      参数:
      type - 聊天新消息提醒类型

    • getChatMessageNotificationType

      NEChatMessageNotificationType getChatMessageNotificationType()
      查询聊天新消息提醒类型

    • enableShowNotYetJoinedMembers

      void enableShowNotYetJoinedMembers(boolean enable)
      设置是否显示未入会成员
      参数:
      enable - true-开启，false-关闭

    • isShowNotYetJoinedMembersEnabled

      boolean isShowNotYetJoinedMembersEnabled()
      查询是否显示未入会成员

    • setTurnOnMyVideoWhenJoinMeeting

      @Deprecated void setTurnOnMyVideoWhenJoinMeeting(boolean enable)
      已过时。
      设置入会时是否打开本地视频
      参数:
      enable - true-入会时打开视频，false-入会时关闭视频 @Deprecated 请使用 enableTurnOnMyVideoWhenJoinMeeting(boolean)

    • setTurnOnMyAudioWhenJoinMeeting

      @Deprecated void setTurnOnMyAudioWhenJoinMeeting(boolean enable)
      已过时。
      设置入会时是否打开本地音频
      参数:
      enable - true-入会时打开音频，false-入会时关闭音频 @Deprecated 请使用 enableTurnOnMyAudioWhenJoinMeeting(boolean)

    • isMeetingLiveEnabled

      @Deprecated boolean isMeetingLiveEnabled()
      已过时。
      查询应用是否支持会议直播 @Deprecated 请使用 isMeetingLiveSupported()

    • getHistoryMeetingItem

      @Deprecated void getHistoryMeetingItem(NECallback<List<NELocalHistoryMeeting>> callback)
      已过时。
      获取本地历史会议记录列表。当前仅会返回最近一次的会议记录，不支持漫游保存。已废弃 @Deprecated 请使用 NEPreMeetingService.getLocalHistoryMeetingList(NECallback)

    • isWhiteboardEnabled

      @Deprecated boolean isWhiteboardEnabled()
      已过时。
      查询应用是否支持白板共享 @Deprecated 请使用 isMeetingWhiteboardSupported()

    • isCloudRecordEnabled

      @Deprecated boolean isCloudRecordEnabled()
      已过时。
      查询应用是否支持云端录制服务 @Deprecated 请使用 isMeetingCloudRecordSupported()

    • setBuiltinVirtualBackgrounds

      @Deprecated void setBuiltinVirtualBackgrounds(List<NEMeetingVirtualBackground> virtualBackgrounds)
      已过时。
      设置内置虚拟背景图片路径列表
      参数:
      virtualBackgrounds - 虚拟背景列表 NEMeetingVirtualBackground @Deprecated 请使用 setBuiltinVirtualBackgroundList(List)

    • getBuiltinVirtualBackgrounds

      @Deprecated List<NEMeetingVirtualBackground> getBuiltinVirtualBackgrounds()
      已过时。
      获取内置虚拟背景图片路径列表 @Deprecated 请使用 getBuiltinVirtualBackgroundList()

    • setASRTranslationLanguage

      void setASRTranslationLanguage(String language, NECallback<Void> callback)
      设置会中字幕/转写翻译语言
      参数:
      language - 目标翻译语言
      callback - 回调

    • getASRTranslationLanguage

      String getASRTranslationLanguage()
      获取会中字幕/转写翻译语言
      返回:
      目标翻译语言

    • enableCaptionBilingual

      void enableCaptionBilingual(boolean enable, NECallback<Void> callback)
      开启会中字幕同时显示双语
      参数:
      enable - true-开启，false-关闭
      callback - 回调

    • isCaptionBilingualEnabled

      boolean isCaptionBilingualEnabled()
      查询会中字幕同时显示双语是否开启
      返回:
      true-开启，false-关闭

    • enableTranscriptionBilingual

      void enableTranscriptionBilingual(boolean enable, NECallback<Void> callback)
      开启会中转写同时显示双语
      参数:
      enable - true-开启，false-关闭
      callback - 回调

    • isTranscriptionBilingualEnabled

      boolean isTranscriptionBilingualEnabled()
      查询会中转写同时显示双语是否开启
      返回:
      true-开启，false-关闭

    • addSettingsChangedListener

      void addSettingsChangedListener(NESettingsChangedListener listener)
      添加设置变更监听器
      参数:
      listener - 监听器

    • removeSettingsChangedListener

      void removeSettingsChangedListener(NESettingsChangedListener listener)
      移除设置变更监听器
      参数:
      listener - 监听器

    • enableAutoSilentOnLock

      void enableAutoSilentOnLock(boolean enable)
      设置锁屏时是否自动静音,默认不开启。秒录场景下，锁屏时自动暂停转写，解锁时自动恢复转写。
      参数:
      enable - true-开启，false-关闭

    • isAutoSilentOnLockEnabled

      boolean isAutoSilentOnLockEnabled()
      锁屏时是否自动静音
      返回:
      true-开启，false-关闭

    • setThemeMode

      void setThemeMode(NEMeetingThemeType mode)
      设置会中主题模式
      参数:
      mode - 主题模式

    • getThemeMode

      NEMeetingThemeType getThemeMode()
      获取会中主题模式
      返回:
      主题模式