Class WonderlandClient

constructor

• new WonderlandClient(userOptions?): WonderlandClient

• Constructor

  Parameters

  • userOptions: Partial<WonderlandClientOptions> = {}

  Returns WonderlandClient

audio

audioAdded

Optional audioAddingPromise

Optional audioNode

candidates

Optional context

dataConnected

Optional datachannel

debug

discord

eventQueue

Optional gainNode

Optional getAudioContextPromise

host

id

Optional incomingRemoteGainNode

Optional incomingRemoteStreams

Optional inputDeviceId

isIOS

makingOffer

Optional outputDeviceId

path

Optional peerConnection

Optional pingInterval

port

receivedData

Optional remoteStream

secure

skipServerStart

webRTCSupported

Optional ws

Optional wsData

_debugLog

• _debugLog(...args): void

• Parameters

  • Rest ...args: unknown[]

  Returns void

addLocalAudioTracks

• addLocalAudioTracks(): Promise<void>

• Returns Promise<void>

addStreamToAudioContext

• addStreamToAudioContext(stream): Promise<void>

• Parameters

  • stream: MediaStream

  Returns Promise<void>

bindOnWindowCloseEvent

• bindOnWindowCloseEvent(): void

• Returns void

cleanupConnection

• cleanupConnection(): void

• Returns void

clear

• clear(): void

• Clear current list of received data events.

  Returns void

connectAndJoinRoom

• connectAndJoinRoom(data?): Promise<number[]>

• Connect to the server. First sends a request to start the server, then connects to it

  Creates a new WebSocket connection to the server and joins the room.

  Parameters

  • data: {} = {}

    {object} Custom data to send with the join request

  Returns Promise<number[]>

  Promise that resolves when the connection has been successfully opened.

createDataChannel

• createDataChannel(): Promise<void>

• Returns Promise<void>

createInputOutputControls

• createInputOutputControls(): void

• Returns void

createNewPromise

• createNewPromise(): Promise<AudioContext>

• Returns Promise<AudioContext>

createPeerConnection

• createPeerConnection(): void

• Returns void

createSignalling

• createSignalling(data): Promise<number[]>

• Parameters

  • data: any

  Returns Promise<number[]>

createWSDataConnection

• createWSDataConnection(): Promise<void>

• Returns Promise<void>

getUrl

• getUrl(withData?): string

• Parameters

  • withData: boolean = false

  Returns string

gotRemoteMediaStream

• gotRemoteMediaStream(event): void

• Parameters

  • event: RTCTrackEvent

  Returns void

onXRSessionStart

• onXRSessionStart(): void

• Returns void

randomId

• randomId(length): string

• Parameters

  • length: number

  Returns string

receive

• receive(): any[]

• Retrieve the list of received data

  Call () after processing the data events.

  Returns any[]

  Received data events

recreateMicrophoneTrack

• recreateMicrophoneTrack(deviceId?): void

• Parameters

  • Optional deviceId: string

  Returns void

send

• send(data): void

• Send some data to the server via the datachannel connection.

  This may be a string, a Blob, an ArrayBuffer, a TypedArray or a DataView object.

  Parameters

  • data: string | ArrayBuffer | ArrayBufferView | Blob

    {Blob|TypedArray|ArrayBuffer|string} Data to send

  Returns void

sendStartServerSignal

• sendStartServerSignal(): Promise<boolean>

• Returns Promise<boolean>

sendViaWs

• sendViaWs(options): void

• Send data to server via the websocket connection

  Parameters

  • options: WsMessageCustom

  Returns void

sendViaWsInternal

• sendViaWsInternal(__namedParameters): void

• Parameters

  • __namedParameters: {
        custom?: any;
        data?: any;
        name: WSMessageName;
    }

    • Optional custom?: any

    • Optional data?: any

    • name: WSMessageName

  Returns void

startNegotiation

• startNegotiation(): Promise<void>

• Returns Promise<void>

waitForAudioContext

• waitForAudioContext(): Promise<undefined | AudioContext>

• Get the audio context from browser Will only resolve once the audio context is available

  Returns Promise<undefined | AudioContext>