Home > @verseengine/verse-three > StartOptions
see: start()
Signature:
export interface StartOptions | Property | Modifiers | Type | Description |
|---|---|---|---|
| gui2dSlots? | string | Node | (Optional) Custom child elements for 2D UI see: https://github.com/VerseEngine/verse-three-ui#custom-buttons | |
| isCrossOriginBGM? | boolean | (Optional) true if the BGM is loaded from a different domain. For crossorigin's source, there is no way to adjust volume in iOS Safari. (GainNode is not available in Mac Safari, but can be changed with Audio.volume) | |
| maxAvatarFileSize? | number | (Optional) Maximum size of avatar file. Default is 1024 * 1024 * 32 (32MB). | |
| maxNumberOfParallelFileTransfers? | number | (Optional) Maximum number of parallel file transfers. Default is 1 (send = 1 and receive = 1). | |
| maxNumberOfPeople? | number | (Optional) Maximum number of people to display. Default is 10. | |
| presetAvatars? | PresetAvatar[] | (Optional) Preset avatars selectable in GUI. | |
| setBgmVolume? | (volume: number) => void | (Optional) BGM volume setting function. If not specified, the BGM volume setting UI is not displayed. | |
| voiceMediaTrackSettings? | any | (Optional) Setting up a microphone for voice chat. |