Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Connection

Hierarchy

  • Connection

Index

Properties

clientData

clientData: string

Data associated to the connection on the client-side. This value is set with second parameter of method Session.connect in OpenVidu Browser

connectionId

connectionId: string

Identifier of the connection. You can call Session.forceDisconnect passing this property as parameter

createdAt

createdAt: number

Timestamp when this connection was established, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)

location

location: string

PRO Geo location of the connection, with the following format: "CITY, COUNTRY" ("unknown" if it wasn't possible to locate it)

platform

platform: string

A complete description of the platform used by the participant to connect to the session

publishers

publishers: Publisher[] = []

Array of Publisher objects this particular Connection is publishing to the Session (each Publisher object has one Stream, uniquely identified by its streamId). You can call Session.forceUnpublish passing any of this values as parameter

role

Role of the connection

serverData

serverData: string

Data associated to the connection on the server-side. This value is set with property TokenOptions.data when calling Session.generateToken

subscribers

subscribers: string[] = []

Array of streams (their streamId properties) this particular Connection is subscribed to. Each one always corresponds to one Publisher of some other Connection: each string of this array must be equal to one Publisher.streamId of other Connection

token

token: string

Token associated to the connection

Generated using TypeDoc