Interface JoinOptions

加入会议参数配置

Hierarchy

  • JoinOptions

Properties

attendeeAudioOff? attendeeVideoOff? audio? chatroomConfig defaultWindowMode? enableSetDefaultFocus? enableSortByVoice? enableUnmuteBySpace encryptionConfig extraData? focusVideoProfile? meetingIdDisplayOptions? meetingNum memberTag? moreBarList muteBtnConfig? nickName noCloudRecord? noRename? noSip? password? roleBinds showFocusBtn showMaxCount? showMeetingRemainingTip showMemberTag? showSpeaker showSubject? toolBarList video? videoProfile?

Properties

Optional attendeeAudioOff

attendeeAudioOff?: number

成员入会后全体静音，且不允许自主打开，默认允许打开

Optional attendeeVideoOff

attendeeVideoOff?: number

成员入会后全体关闭视频，且不允许自主打开，默认允许打开

Optional audio

audio?: number

是否开启音频入会 1为开启 2为关闭

chatroomConfig

chatroomConfig: {
    enableFileMessage?: boolean;
    enableImageMessage?: boolean;
}

Type declaration

  • Optional enableFileMessage?: boolean

    聊天室是否开启文件上传

  • Optional enableImageMessage?: boolean

    聊天室是否开启图片上传

Optional defaultWindowMode

defaultWindowMode?: number

会时模式，1 常规（默认）， 2开启白板入会

Optional enableSetDefaultFocus

enableSetDefaultFocus?: boolean

是否设置主持人默认焦点 默认 false

Optional enableSortByVoice

enableSortByVoice?: boolean

是否开启根据声音大小排序 默认为true

enableUnmuteBySpace

enableUnmuteBySpace: boolean

是否能够通过长按空格解除静音

encryptionConfig

encryptionConfig: NEEncryptionConfig

媒体流国密加密配置

Optional extraData

extraData?: string

扩展字段，格式为json字符串，如果showMaxCount字段设置为true，且该字段传{maxCount: 100}，会议应进最大人数为100

Optional focusVideoProfile

focusVideoProfile?: {
    frameRate: VideoFrameRate;
    resolution: VideoResolution;
}

焦点成员分辨率及帧率设置

Type declaration

Optional meetingIdDisplayOptions

meetingIdDisplayOptions?: NEMeetingIdDisplayOptions

会议号展示 0 都展示 1 展示长号，2 展示短号 默认为 0

meetingNum

meetingNum: string

加入会议时，该字段必须是一个当前正在进行中的会议ID，不能为空 创建会议时，输入个人会议号(登录成功后可通过accountInfo.meetingNum属性获取)，该字段如果为空则为随机会议，

Optional memberTag

memberTag?: string

成员自定义标签

moreBarList

moreBarList: MoreBarList

Optional muteBtnConfig

muteBtnConfig?: {
    showMuteAllAudio: boolean;
    showMuteAllVideo: boolean;
    showUnMuteAllAudio: boolean;
    showUnMuteAllVideo: boolean;
}

成员列表底部按钮配置

Type declaration

  • showMuteAllAudio: boolean

    显示全体静音按钮

  • showMuteAllVideo: boolean

    显示全体关闭视频按钮

  • showUnMuteAllAudio: boolean

    显示全体解除静音按钮

  • showUnMuteAllVideo: boolean

    显示全体开启按钮

nickName

nickName: string

用户昵称

Optional noCloudRecord

noCloudRecord?: boolean

开启会议录制，false（默认） 录制 true 不录制

Optional noRename

noRename?: boolean

是否开启会中改名，默认为false（开启）

Optional noSip

noSip?: boolean

是否关闭sip true为不开启 false为开启，默认为不开启

Optional password

password?: string

入会密码 创建会议传入则创建有密码的会议

roleBinds

roleBinds: Record<string, Role>

入会角色绑定

showFocusBtn

showFocusBtn: boolean

是否显示设置焦点后画面右上角的按钮， 默认为true

Optional showMaxCount

showMaxCount?: boolean

是否显示会议应进最大人数,需配合extraData字段设置

showMeetingRemainingTip

showMeetingRemainingTip: boolean

是否显示会议剩余时间提醒

Optional showMemberTag

showMemberTag?: boolean

是否显示成员标签

showSpeaker

showSpeaker: boolean

是否显示说话者列表

Optional showSubject

showSubject?: boolean

是否显示会议主题

toolBarList

toolBarList: ToolBarList

Optional video

video?: number

是否开启视频入会 1为开启 2为关闭

Optional videoProfile

videoProfile?: {
    frameRate: VideoFrameRate;
    resolution: VideoResolution;
}

视频分辨率及帧率设置

Type declaration

Settings

Member Visibility

Theme

On This Page