Class default

constructor

• new default(appID: string, token: string, options: IConnectionOptions): default

  Creates a new JitsiConnection instance.

  Parameters

  • appID: string

    Identification for the provider of Jitsi Meet video conferencing services.
  • token: string

    The JWT token used to authenticate with the server (optional).
  • options: IConnectionOptions

    Object with properties / settings related to connection with the server.

  Returns default

Readonlyoptions

addEventListener

• addEventListener(
      event: JitsiConnectionEvents,
      listener: (...args: any[]) => void,
  ): void

  Subscribes the passed listener to the event.

  Parameters

  • event: JitsiConnectionEvents

    The connection event.
  • listener: (...args: any[]) => void

    The function that will receive the event

  Returns void

addFeature

• addFeature(feature: string, submit?: boolean): void

  Adds new feature to the list of supported features for the local participant.

  Parameters

  • feature: string

    The name of the feature.
  • submit: boolean = false

    If true - the new list of features will be immediately submitted to the others.

  Returns void

attach

• attach(options: IAttachOptions): void

  Attach to existing connection. Can be used for optimizations. For example: if the connection is created on the server we can attach to it and start using it.

  Parameters

  • options: IAttachOptions

    Connecting options - rid, sid and jid.

  Returns void

connect

• connect(options?: IConnectOptions): void

  Connect the client with the server.

  Parameters

  • options: IConnectOptions = {}

    Connecting options (for example authentications parameters).

    • Optionalid?: string

    • Optionalname?: string

    • Optionalpassword?: string

  Returns void

disconnect

• disconnect(...args: [string?]): Promise<void>

  Disconnect the client from the server.

  Parameters

  • ...args: [string?]

    Optional arguments to be passed to XMPP.disconnect

  Returns Promise<void>

  Promise that resolves when the disconnect process is finished or rejects with an error.

getConnectionTimes

• getConnectionTimes(): Record<string, any>

  Returns measured connectionTimes.

  Returns Record<string, any>

  Object containing connection timing information

getJid

• getJid(): string

  Returns the jid of the participant associated with the XMPP connection.

  Returns string

  The jid of the participant.

getLogs

• getLogs(): Record<string, any>

  Get object with internal logs.

  Returns Record<string, any>

  Object containing connection logs and metadata

initJitsiConference

• initJitsiConference(name: string, options: Record<string, any>): default

  Creates and joins new conference.

  Parameters

  • name: string

    The name of the conference; if null - a generated name will be provided from the api
  • options: Record<string, any>

    Object with properties / settings related to the conference that will be created.

  Returns default

  The new conference object.

removeEventListener

• removeEventListener(
      event: JitsiConnectionEvents,
      listener: (...args: any[]) => void,
  ): void

  Unsubscribes the passed handler.

  Parameters

  • event: JitsiConnectionEvents

    The connection event.
  • listener: (...args: any[]) => void

    The function that will receive the event

  Returns void

removeFeature

• removeFeature(feature: string, submit?: boolean): void

  Removes a feature from the list of supported features for the local participant

  Parameters

  • feature: string

    The name of the feature.
  • submit: boolean = false

    If true - the new list of features will be immediately submitted to the others.

  Returns void

setToken

• setToken(token: string): void

  This method allows renewal of the tokens if they are expiring.

  Parameters

  • token: string

    The new token.

  Returns void