Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RealtimeState

RealtimeState stores all realtime persistent state.

Hierarchy

  • RealtimeState

Index

Constructors

Properties

Constructors

constructor

Properties

attendeeIdChangesCallbacks

attendeeIdChangesCallbacks: ((attendeeId: string, present: boolean, externalUserId: string, dropped: boolean, posInFrame: RealtimeAttendeePositionInFrame) => void)[] = []

Callbacks to listen for attendee id changes

attendeeIdToExternalUserId

attendeeIdToExternalUserId: {} = {}

Stores attendee id to external user id mappings

Type declaration

  • [attendeeId: string]: string

canUnmute

canUnmute: boolean = true

Stores whether the user can transition from muted to unmuted

fatalErrorCallbacks

fatalErrorCallbacks: ((error: Error) => void)[] = []

Callbacks to listen for fatal errors

localAttendeeId

localAttendeeId: string = null

Stores the attendee id of the current user

localExternalUserId

localExternalUserId: string = null

Stores the external user id of the current user

localSignalStrengthChangeCallbacks

localSignalStrengthChangeCallbacks: ((signalStrength: number) => void)[] = []

Callbacks to listen for changes to local signal strength

muteAndUnmuteLocalAudioCallbacks

muteAndUnmuteLocalAudioCallbacks: ((muted: boolean) => void)[] = []

Callbacks to listen for local audio mutes and unmutes

muted

muted: boolean = false

Stores whether the user is presently muted

receiveDataMessageCallbacks

receiveDataMessageCallbacks: Map<string, ((dataMessage: DataMessage) => void)[]> = ...

Callbacks to listen for receiving message from data channel based on given topic

sendDataMessageCallbacks

sendDataMessageCallbacks: ((topic: string, data: any, lifetimeMs?: number) => void)[] = []

Callbacks to trigger when sending message

setCanUnmuteLocalAudioCallbacks

setCanUnmuteLocalAudioCallbacks: ((canUnmute: boolean) => void)[] = []

Callbacks to listen for changes to can-unmute local audio state

volumeIndicatorCallbacks

volumeIndicatorCallbacks: {} = {}

Stores per-attendee id callbacks called when volume indicators change

Type declaration

volumeIndicatorState

volumeIndicatorState: {} = {}

Stores per-attendee id volume indicator state

Type declaration

Generated using TypeDoc