logo
当前页

Config


ZegoUIKitPrebuiltLiveAudioRoomConfig

初始化相关配置类。

属性类型描述
roleZegoLiveAudioRoomRole定义用户在语聊房中的角色。默认值是 ZegoLiveAudioRoomRole.AUDIENCE。
takeSeatIndexWhenJoiningint加入时的麦位位置,仅当用户的角色为房主和发言人时有效。默认值是-1表示没有指定的麦位位置。
closeSeatsWhenJoinboolean加入语聊房时是否关闭所有麦位。仅当role为房主时生效。默认值是true。
hostSeatIndexesList<Integer>只有房主可以入座的位置。默认没有设置。
turnOnMicrophoneWhenJoiningboolean加入语聊房时是否自动打开麦克风。默认值为false。
useSpeakerWhenJoiningboolean加入语聊房时是否使用扬声器。默认值为true。
userAvatarUrlString用户头像的URL。只支持http或者https协议的链接。
userInRoomAttributesMap<String, String>用户在房间内的属性,可根据业务需求控制UI元素展示或者逻辑判断。请参考自定义用户属性
bottomMenuBarConfigZegoBottomMenuBarConfig底部菜单栏的配置。请参考自定义底部菜单栏按钮
confirmDialogInfoZegoDialogInfo如果confirmDialogInfo不为空,当房主停止语聊房或点击退出按钮或按下返回键时,则会显示确认对话框。confirmDialogInfo内属性已经弃用,请使用ZegoTranslationText.leaveRoomConfirmDialogInfo来修改对话框文本 。
translationTextZegoTranslationText请参考切换语言自定义 UI 文案
layoutConfigZegoLiveAudioRoomLayoutConfig语聊房布局配置。请参考自定义麦位
seatConfigZegoLiveAudioRoomSeatConfig麦位配置,包括背景图标等。
inRoomMessageViewConfigZegoInRoomMessageViewConfig语聊房内消息视图的配置。
removedFromRoomListenerZegoMeRemovedFromRoomListener用户被从房间移除时触发。

ZegoBottomMenuBarConfig

底部菜单栏配置相关类

属性类型描述
hostButtonsList<ZegoMenuBarButtonName>房主的菜单栏按钮列表。
speakerButtonsList<ZegoMenuBarButtonName>发言人的菜单栏按钮列表。
audienceButtonsList<ZegoMenuBarButtonName>观众的菜单栏按钮列表。
menuBarButtonsMaxCountint菜单栏按钮的最大数量。默认值为5。
showInRoomMessageButtonboolean是否在底部菜单栏中显示房间内消息按钮。默认值为true。
memberListConfigZegoMemberListConfig成员列表的配置。

ZegoLiveAudioRoomLayoutConfig

麦位布局配置相关类

属性类型描述
rowConfigsList<ZegoLiveAudioRoomLayoutRowConfig>行配置列表,指定麦位布局的每行如何排列以及元素如何对齐。默认值包含两个 ZegoLiveAudioRoomLayoutRowConfig 对象的列表,每个对象配置为4个元素,对齐方式为 SPACE_AROUND。
rowSpecingint每行麦位之间的间距。默认值为0。

ZegoLiveAudioRoomLayoutRowConfig

麦位布局每行配置相关类

属性类型描述
seatSpacingint麦位之间的距离
alignmentZegoLiveAudioRoomLayoutAlignment麦位之间的对齐方式。
countint每行的列数。

ZegoLiveAudioRoomSeatConfig

麦位配置相关类

属性类型描述
showSoundWaveInAudioModeboolean是否显示声浪。
foregroundViewProviderZegoLiveAudioRoomSeatForegroundViewProvider前景视图提供器,用于自定义座位的前景视图。
backgroundColor@ColorInt int麦位的背景颜色。
backgroundImageDrawable麦位的背景图。
openIconDrawable麦位未锁定时的图标。
closeIconDrawable麦位锁定时的图标。
seatClickedListenerZegoSeatClickedListener麦位被点击时触发。

ZegoInRoomMessageViewConfig

消息视图配置相关类

属性类型描述
visibleboolean消息视图是否可见。
inRoomMessageItemViewProviderZegoInRoomMessageItemViewProvider消息项视图提供器,用于自定义房间内消息项的视图。

Previous

Event