Interface NESettingsService

interface NESettingsService {
    enableAudioAINS: (enable: boolean) => Promise<NEResult<void>>;
    enableShowMyMeetingElapseTime: (enable: boolean) => Promise<NEResult<void>>;
    enableShowMyMeetingParticipationTime: (
        enable: boolean,
    ) => Promise<NEResult<void>>;
    enableShowNotYetJoinedMembers: (enable: boolean) => Promise<NEResult<void>>;
    enableSpeakerSpotlight: (enable: boolean) => Promise<NEResult<void>>;
    enableTurnOnMyAudioWhenJoinMeeting: (
        enable: boolean,
    ) => Promise<NEResult<void>>;
    enableTurnOnMyVideoWhenJoinMeeting: (
        enable: boolean,
    ) => Promise<NEResult<void>>;
    enableUnmuteAudioByPressSpaceBar: (
        enable: boolean,
    ) => Promise<NEResult<void>>;
    enableVirtualBackground: (enable: boolean) => Promise<NEResult<void>>;
    getAppNotifySessionId: () => Promise<NEResult<string>>;
    getBeautyFaceValue: () => Promise<NEResult<number>>;
    getChatMessageNotificationType: () => Promise<
        NEResult<NEChatMessageNotificationType>,
    >;
    getChatroomDefaultFileSavePath: () => Promise<NEResult<string>>;
    isAudioAINSEnabled: () => Promise<NEResult<boolean>>;
    isAvatarUpdateSupported: () => Promise<NEResult<boolean>>;
    isBeautyFaceSupported: () => Promise<NEResult<boolean>>;
    isCaptionsSupported: () => Promise<NEResult<boolean>>;
    isFrontCameraMirrorEnabled: () => Promise<NEResult<boolean>>;
    isGuestJoinSupported: () => Promise<NEResult<boolean>>;
    isMeetingChatSupported: () => Promise<NEResult<boolean>>;
    isMeetingCloudRecordSupported: () => Promise<NEResult<boolean>>;
    isMeetingLiveOfficialPushSupported: () => Promise<NEResult<boolean>>;
    isMeetingLiveSupported: () => Promise<NEResult<boolean>>;
    isMeetingLiveThirdPartyPushSupported: () => Promise<NEResult<boolean>>;
    isMeetingWhiteboardSupported: () => Promise<NEResult<boolean>>;
    isNicknameUpdateSupported: () => Promise<NEResult<boolean>>;
    isShowMyMeetingElapseTimeEnabled: () => Promise<NEResult<boolean>>;
    isShowMyMeetingParticipationTimeEnabled: () => Promise<NEResult<boolean>>;
    isSpeakerSpotlightEnabled: () => Promise<NEResult<boolean>>;
    isTranscriptionSupported: () => Promise<NEResult<boolean>>;
    isTransparentWhiteboardEnabled: () => Promise<NEResult<boolean>>;
    isTurnOnMyAudioWhenJoinMeetingEnabled: () => Promise<NEResult<boolean>>;
    isTurnOnMyVideoWhenJoinMeetingEnabled: () => Promise<NEResult<boolean>>;
    isUnmuteAudioByPressSpaceBarEnabled: () => Promise<NEResult<boolean>>;
    isVirtualBackgroundEnabled: () => Promise<NEResult<boolean>>;
    isVirtualBackgroundSupported: () => Promise<NEResult<boolean>>;
    isWaitingRoomSupported: () => Promise<NEResult<boolean>>;
    setBeautyFaceValue: (value: number) => Promise<NEResult<void>>;
    setBuiltinVirtualBackgroundList: (
        pathList: string[],
    ) => Promise<NEResult<void>>;
    setChatMessageNotificationType: (
        type: NEChatMessageNotificationType,
    ) => Promise<NEResult<void>>;
    setChatroomDefaultFileSavePath: (
        filePath: string,
    ) => Promise<NEResult<void>>;
    setGalleryModeMaxMemberCount: (count: 9 | 16) => Promise<NEResult<void>>;
    enableCameraMirror(enable: boolean): Promise<NEResult<void>>;
    enableCaptionBilingual(enable: boolean): Promise<NEResult<number>>;
    enableFrontCameraMirror(enable: boolean): Promise<NEResult<void>>;
    enableHideMyVideo(enable: boolean): Promise<NEResult<void>>;
    enableHideVideoOffAttendees(enable: boolean): Promise<NEResult<void>>;
    enableLeaveTheMeetingRequiresConfirmation(
        enable: boolean,
    ): Promise<NEResult<void>>;
    enableShowNameInVideo(enable: boolean): Promise<NEResult<void>>;
    enableSideBySideMode(enable: boolean): Promise<NEResult<void>>;
    enableTranscriptionBilingual(enable: boolean): Promise<NEResult<number>>;
    enableTransparentWhiteboard(enable: boolean): Promise<NEResult<void>>;
    getASRTranslationLanguage(): Promise<
        NEResult<NEMeetingASRTranslationLanguage>,
    >;
    getBuiltinVirtualBackgroundList(): Promise<NEResult<string[]>>;
    getCloudRecordConfig(): Promise<NEResult<NECloudRecordConfig>>;
    getCurrentVirtualBackground(): Promise<NEResult<string>>;
    getExternalVirtualBackgroundList(): Promise<NEResult<string[]>>;
    getInterpretationConfig(): Promise<NEResult<NEInterpretationConfig>>;
    getLiveMaxThirdPartyCount(): Promise<NEResult<number>>;
    getLocalRecordConfig(): Promise<NEResult<NELocalRecordConfig>>;
    getScheduledMemberConfig(): Promise<NEResult<ScheduledMemberConfig>>;
    isCallOutRoomSystemDeviceSupported(): Promise<NEResult<boolean>>;
    isCameraMirrorEnabled(): Promise<NEResult<boolean>>;
    isCaptionBilingualEnabled(): Promise<NEResult<boolean>>;
    isHideMyVideoEnabled(): Promise<NEResult<boolean>>;
    isHideVideoOffAttendeesEnabled(): Promise<NEResult<boolean>>;
    isLeaveTheMeetingRequiresConfirmationEnabled(): Promise<NEResult<boolean>>;
    isShowNameInVideoEnabled(): Promise<NEResult<boolean>>;
    isShowNotYetJoinedMembersEnabled(): Promise<NEResult<boolean>>;
    isSideBySideModeEnabled(): Promise<NEResult<boolean>>;
    isTranscriptionBilingualEnabled(): Promise<NEResult<boolean>>;
    openSettingsWindow(type?: string): Promise<NEResult<void>>;
    setASRTranslationLanguage(
        language: NEMeetingASRTranslationLanguage,
    ): Promise<NEResult<number>>;
    setCloudRecordConfig(config: NECloudRecordConfig): Promise<NEResult<void>>;
    setCurrentVirtualBackground(path: string): Promise<NEResult<void>>;
    setExternalVirtualBackgroundList(
        pathList: string[],
    ): Promise<NEResult<void>>;
    setLocalRecordConfig(config: NELocalRecordConfig): Promise<NEResult<void>>;
}

Properties

Methods

Properties

enableAudioAINS: (enable: boolean) => Promise<NEResult<void>>

开启或关闭音频智能降噪

enableShowMyMeetingElapseTime: (enable: boolean) => Promise<NEResult<void>>

设置是否显示会议时长

Type declaration

    • (enable: boolean): Promise<NEResult<void>>
    • Parameters

      • enable: boolean

        true-开启,false-关闭

      Returns Promise<NEResult<void>>

enableShowMyMeetingParticipationTime: (
    enable: boolean,
) => Promise<NEResult<void>>

设置是否显示参会时长

Type declaration

    • (enable: boolean): Promise<NEResult<void>>
    • Parameters

      • enable: boolean

        true-开启,false-关闭

      Returns Promise<NEResult<void>>

enableShowNotYetJoinedMembers: (enable: boolean) => Promise<NEResult<void>>

设置是否隐藏未入会成员

Type declaration

    • (enable: boolean): Promise<NEResult<void>>
    • Parameters

      • enable: boolean

        true-开启,false-关闭

      Returns Promise<NEResult<void>>

enableSpeakerSpotlight: (enable: boolean) => Promise<NEResult<void>>

设置是否打开语音激励

Type declaration

    • (enable: boolean): Promise<NEResult<void>>
    • Parameters

      • enable: boolean

        true-开启,false-关闭

      Returns Promise<NEResult<void>>

enableTurnOnMyAudioWhenJoinMeeting: (enable: boolean) => Promise<NEResult<void>>

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

enable true-入会时打开音频,false-入会时关闭音频

enableTurnOnMyVideoWhenJoinMeeting: (enable: boolean) => Promise<NEResult<void>>

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

Type declaration

    • (enable: boolean): Promise<NEResult<void>>
    • Parameters

      • enable: boolean

        true: 开启本地视频 false: 关闭本地视频

      Returns Promise<NEResult<void>>

enableUnmuteAudioByPressSpaceBar: (enable: boolean) => Promise<NEResult<void>>

设置是否支持静音时长按空格暂时开启麦克风

Type declaration

    • (enable: boolean): Promise<NEResult<void>>
    • Parameters

      • enable: boolean

        是否开启

      Returns Promise<NEResult<void>>

enableVirtualBackground: (enable: boolean) => Promise<NEResult<void>>

虚拟背景是否显示

getAppNotifySessionId: () => Promise<NEResult<string>>

查询应用session会话Id

getBeautyFaceValue: () => Promise<NEResult<number>>

设置美颜服务开关状态

getChatMessageNotificationType: () => Promise<
    NEResult<NEChatMessageNotificationType>,
>

查询聊天新消息提醒类型

getChatroomDefaultFileSavePath: () => Promise<NEResult<string>>

查询应用聊天室文件下载默认保存路径

isAudioAINSEnabled: () => Promise<NEResult<boolean>>

查询音频智能降噪开启状态

isAvatarUpdateSupported: () => Promise<NEResult<boolean>>

查询是否拥有上传头像权限

isBeautyFaceSupported: () => Promise<NEResult<boolean>>

查询美颜服务开关状态,关闭在隐藏会中美颜按钮

isCaptionsSupported: () => Promise<NEResult<boolean>>

查询是否支持字幕

isFrontCameraMirrorEnabled: () => Promise<NEResult<boolean>>

查询是否开启共享时开启摄像头

isGuestJoinSupported: () => Promise<NEResult<boolean>>

是否支持访客入会

isMeetingChatSupported: () => Promise<NEResult<boolean>>

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

isMeetingCloudRecordSupported: () => Promise<NEResult<boolean>>

查询云端录制服务开关状态

isMeetingLiveOfficialPushSupported: () => Promise<NEResult<boolean>>

查询直播官方推流是否支持

isMeetingLiveSupported: () => Promise<NEResult<boolean>>

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

isMeetingLiveThirdPartyPushSupported: () => Promise<NEResult<boolean>>

查询直播第三方推流是否支持

isMeetingWhiteboardSupported: () => Promise<NEResult<boolean>>

查询白板功能是否开启

isNicknameUpdateSupported: () => Promise<NEResult<boolean>>

查询是否拥有修改昵称权限

isShowMyMeetingElapseTimeEnabled: () => Promise<NEResult<boolean>>

查询显示会议时长功能开启状态

isShowMyMeetingParticipationTimeEnabled: () => Promise<NEResult<boolean>>

查询显示参会时长功能开启状态

isSpeakerSpotlightEnabled: () => Promise<NEResult<boolean>>

查询是否打开语音激励

isTranscriptionSupported: () => Promise<NEResult<boolean>>

查询是否支持转写

isTransparentWhiteboardEnabled: () => Promise<NEResult<boolean>>

查询是否开启透明白板

isTurnOnMyAudioWhenJoinMeetingEnabled: () => Promise<NEResult<boolean>>
isTurnOnMyVideoWhenJoinMeetingEnabled: () => Promise<NEResult<boolean>>

查询入会时本地视频开关状态

isUnmuteAudioByPressSpaceBarEnabled: () => Promise<NEResult<boolean>>

查询是否支持静音时长按空格暂时开启麦克风

isVirtualBackgroundEnabled: () => Promise<NEResult<boolean>>

查询虚拟背景是否开启

isVirtualBackgroundSupported: () => Promise<NEResult<boolean>>

查询虚拟背景是否支持

isWaitingRoomSupported: () => Promise<NEResult<boolean>>

查询应用是否支持等候室

setBeautyFaceValue: (value: number) => Promise<NEResult<void>>

设置美颜参数

Type declaration

    • (value: number): Promise<NEResult<void>>
    • Parameters

      • value: number

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

      Returns Promise<NEResult<void>>

setBuiltinVirtualBackgroundList: (pathList: string[]) => Promise<NEResult<void>>

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

Type declaration

    • (pathList: string[]): Promise<NEResult<void>>
    • Parameters

      • pathList: string[]

        虚拟背景图片路径列表

      Returns Promise<NEResult<void>>

setChatMessageNotificationType: (
    type: NEChatMessageNotificationType,
) => Promise<NEResult<void>>

设置聊天新消息提醒类型

Type declaration

setChatroomDefaultFileSavePath: (filePath: string) => Promise<NEResult<void>>

设置应用聊天室默认文件下载保存路径

Type declaration

    • (filePath: string): Promise<NEResult<void>>
    • Parameters

      • filePath: string

        聊天室文件保存路径

      Returns Promise<NEResult<void>>

setGalleryModeMaxMemberCount: (count: 9 | 16) => Promise<NEResult<void>>

设置画廊模式下单屏显示最大画面数量

Type declaration

    • (count: 9 | 16): Promise<NEResult<void>>
    • Parameters

      • count: 9 | 16

        最大显示人数目前支持9人或者16人

      Returns Promise<NEResult<void>>

Methods

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

    Parameters

    • enable: boolean

      true-开启,false-关闭

    Returns Promise<NEResult<void>>

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

    Parameters

    • enable: boolean

      true-开启,false-关闭

    Returns Promise<NEResult<number>>

  • 设置是否打开前置摄像头镜像(仅H5支持)

    Parameters

    • enable: boolean

      true-开启,false-关闭

    Returns Promise<NEResult<void>>

  • 设置开启/关闭隐藏本人视图

    Parameters

    • enable: boolean

      是否显示

    Returns Promise<NEResult<void>>

  • 设置开启/关闭隐藏非视频参会者

    Parameters

    • enable: boolean

      是否显示

    Returns Promise<NEResult<void>>

  • 设置是否离开会议需要弹窗确认

    Parameters

    • enable: boolean

      是否显示

    Returns Promise<NEResult<void>>

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

    Parameters

    • enable: boolean

      是否显示

    Returns Promise<NEResult<void>>

  • 是否屏幕共享开启并排模式

    Parameters

    • enable: boolean

      是否开启

    Returns Promise<NEResult<void>>

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

    Parameters

    • enable: boolean

      true-开启,false-关闭

    Returns Promise<NEResult<number>>

  • 设置是否打开白板透明

    Parameters

    • enable: boolean

      true-开启,false-关闭

    Returns Promise<NEResult<void>>

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

    Returns Promise<NEResult<string[]>>

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

    Returns Promise<NEResult<string>>

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

    Returns Promise<NEResult<string[]>>

  • 获取第三方推流最大设置个数

    Returns Promise<NEResult<number>>

  • 查询应用是否支持会议设备邀请

    Returns Promise<NEResult<boolean>>

  • 查询摄像头镜像是否打开

    Returns Promise<NEResult<boolean>>

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

    Returns Promise<NEResult<boolean>>

  • 查询是否开启隐藏本人视图

    Returns Promise<NEResult<boolean>>

  • 查询是否开启隐藏非视频参会者

    Returns Promise<NEResult<boolean>>

  • 查询是否离开会议需要弹窗确认

    Returns Promise<NEResult<boolean>>

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

    Returns Promise<NEResult<boolean>>

  • 查询是否设置隐藏未入会成员

    Returns Promise<NEResult<boolean>>

  • 查询是否开启并排模式

    Returns Promise<NEResult<boolean>>

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

    Returns Promise<NEResult<boolean>>

  • 打开设置窗口

    Parameters

    • Optionaltype: string

    Returns Promise<NEResult<void>>

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

    Parameters

    • path: string

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

    Returns Promise<NEResult<void>>

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

    Parameters

    • pathList: string[]

      虚拟背景图片路径列表

    Returns Promise<NEResult<void>>