Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Connection

Represents each one of the user's connection to the session (the local one and other user's connections). Therefore each Session and Stream object has an attribute of type Connection

Hierarchy

  • Connection

Index

Properties

connectionId

connectionId: string

Unique identifier of the connection

creationTime

creationTime: number

Time when this connection was created in OpenVidu Server (UTC milliseconds)

data

data: string

Data associated to this connection (and therefore to certain user). This is an important field: it allows you to broadcast all the information you want for each user (a username, for example)

record

record: boolean

Whether the streams published by this connection will be recorded or not. This only affects INDIVIDUAL recording PRO

Only defined for the local connection. In remote connections will be undefined

role

role: string

Role of the connection.

Only defined for the local connection. In remote connections will be undefined

Generated using TypeDoc