Class Session

This private class manages sound session rooms.

Hierarchy

Session

Implements

Connectable

Index

Constructors

Properties

context input output rooms

Accessors

Methods

clear connect connected get ready setup start stop

Constructors

constructor

new Session(context): Session
Parameters
- context: AudioContext
  
  This argument is in order to use Web Audio API.
Returns Session
- Defined in SoundModule/Session/index.ts:62

Properties

`Private` context

context: AudioContext

`Private` input

input: GainNode

`Private` output

output: GainNode

`Private` rooms

rooms: Room[] = []

Accessors

INPUT

get INPUT(): GainNode
Returns GainNode
Implementation of Connectable.INPUT
- Defined in SoundModule/Session/index.ts:192

OUTPUT

get OUTPUT(): GainNode
Returns GainNode
Implementation of Connectable.OUTPUT
- Defined in SoundModule/Session/index.ts:197

Methods

clear

clear(roomId): Session
This method closes connection to WebSocket server and destroys instance of WebSocket.
Parameters
- roomId: string
  
  This argument is string that identifies messaging room.
Returns Session
Return value is for method chain.
- Defined in SoundModule/Session/index.ts:137

connect

connect(roomId): Session
This method connects AudioNodes.
Parameters
- roomId: string
  
  This argument is string that identifies messaging room.
Returns Session
Return value is for method chain.
- Defined in SoundModule/Session/index.ts:154

connected

connected(roomId): boolean
This method determines whether there is connection to server.
Parameters
- roomId: string
  
  This argument is string that identifies messaging room.
Returns boolean
- Defined in SoundModule/Session/index.ts:172

get

get(roomId): null | Room
This method gets instance of Room that is designated Room ID.
Parameters
- roomId: string
  
  This argument is string that identifies room.
Returns null | Room
- Defined in SoundModule/Session/index.ts:187

ready

ready(params): Session
This method creates instance of WebSocket.
Parameters
- params: SessionConnectionParams
  
  This argument is in order to create instance of WebSocket.
Returns Session
Return value is for method chain.
- Defined in SoundModule/Session/index.ts:84

setup

setup(params): Session
This method creates instance of Room.
Parameters
- params: SessionSetupParams
  
  This argument is in order to create instance of Room.
Returns Session
Return value is for method chain.
- Defined in SoundModule/Session/index.ts:74

start

start(roomId): Session
This method sends sound data to server.
Parameters
- roomId: string
  
  This argument is string that identifies messaging room.
Returns Session
Return value is for method chain.
- Defined in SoundModule/Session/index.ts:101

stop

stop(roomId): Session
This method stops sending and receiving data.
Parameters
- roomId: string
  
  This argument is string that identifies messaging room.
Returns Session
Return value is for method chain.
- Defined in SoundModule/Session/index.ts:120

Generated using TypeDoc