Class QwelpSenderSession

constructor

• new QwelpSenderSession(fixedCode?: string | undefined): QwelpSenderSession

  Parameters

  • fixedCode: string | undefined = undefined

  Returns QwelpSenderSession

customerPublicKey

StaticrunningSession

addEventListener

• addEventListener<K extends keyof QwelpSenderSessionEvents>(
      type: K,
      receiver: (event: QwelpSenderSessionEvents[K]) => void,
  ): boolean

  Adds a new event listener

  Type Parameters

  • K extends keyof QwelpSenderSessionEvents

  Parameters

  • type: K
  • receiver: (event: QwelpSenderSessionEvents[K]) => void

  Returns boolean

appendBackendMetaData

• appendBackendMetaData(data: MetaData): void

  Parameters

  • data: MetaData

  Returns void

deregisterModule

• deregisterModule(moduleName: SenderModuleName): SenderModule | undefined

  Parameters

  • moduleName: SenderModuleName

  Returns SenderModule | undefined

getBackendMetaData

• getBackendMetaData(): MetaData

  Returns MetaData

getBranding

• getBranding(): QwelpBranding

  Returns QwelpBranding

getChannel

• getChannel(): DataChannel

  Returns DataChannel

getRtc

• getRtc(): Rtc

  For modules that add their own channels or media tracks, see RtcTracks.

  Returns Rtc

getSignaller

• getSignaller(): Signaller

  For modules that report feature usage to the session statistics.

  Returns Signaller

getState

• getState(): SessionStateInfo

  Returns SessionStateInfo

getSupportCode

• getSupportCode(): string

  Returns string

getSupportDuration

• getSupportDuration(): number

  Returns number

hasCustomerKey

• hasCustomerKey(): boolean

  Returns boolean

registerModule

• registerModule(module: SenderModule): boolean

  Register a new sender Module. Checks that modules are not double added

  Parameters

  • module: SenderModule

  Returns boolean

  true if new added.

removeEventListener

• removeEventListener<K extends keyof QwelpSenderSessionEvents>(
      type: K,
      receiver: (event: QwelpSenderSessionEvents[K]) => void,
  ): boolean

  removes a event listener

  Type Parameters

  • K extends keyof QwelpSenderSessionEvents

  Parameters

  • type: K
  • receiver: (event: QwelpSenderSessionEvents[K]) => void

  Returns boolean

sendBackendMetaData

• sendBackendMetaData(): void

  Returns void

setBranding

• setBranding(branding: QwelpBranding): void

  Parameters

  • branding: QwelpBranding

  Returns void

setCustomerKey

• setCustomerKey(publicKey: string): void

  Parameters

  • publicKey: string

  Returns void

start

• start(isReconnect?: boolean): string

  Parameters

  • isReconnect: boolean = false

  Returns string

stop

• stop(): void

  Returns void

updateState

• updateState(state: SessionState, message: string): void

  Parameters

  • state: SessionState
  • message: string

  Returns void