Class Space

A Space is where participants meet. Participants can publish their own tracks and subscribe to other publishers.

A space emits SpaceEvent as a way to relay state updates.

Hierarchy

EventEmitter
- Space

Index

Constructors

Properties

broadcasting jwt localParticipant? sessionId?

Methods

join leave submitAcrScore

Constructors

constructor

new Space(jwt: string, options?: SpaceOptionsParams): Space
Space is used to interact with a Space created first using the Mux Spaces Server API. Once you have created a Space on the server, you can get started by using this class.
Parameters
- jwt: string
  A JSON Web Token (JWT) with a sub of the Mux Space ID and an aud value that is an array containing any of the following strings:
  - pub - publishing of streams.
  - sub - subscribing to streams.
- Optional options: SpaceOptionsParams
  
  An optional set of Space Options
Returns Space
Overrides EventEmitter.constructor
- Defined in src/space/Space.ts:82

Properties

broadcasting

broadcasting: boolean

A boolean indicating whether the Space is currently being broadcast.

`Protected` jwt

jwt: string

`Optional` localParticipant

localParticipant?: LocalParticipant

The local participant in the Space. This will be set after a successful join.

`Optional` sessionId

sessionId?: string

Methods

join

join(): Promise<LocalParticipant>
Join the Space.

Returns
A promise that resolves on a successful join.

Returns Promise<LocalParticipant>
- Defined in src/space/Space.ts:255

leave

leave(): void
Leave the Space.

Returns void
- Defined in src/space/Space.ts:118

submitAcrScore

submitAcrScore(score: AcrScore): Promise<void>
Submit an Absolute Category Rating (ACR) score for this user's session. This allows collection of user feedback regarding the general quality of experience of their Space's session
Parameters
- score: AcrScore
Returns Promise<void>
- Defined in src/space/Space.ts:139

Generated using TypeDoc