Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConnectionProperties

Hierarchy

  • ConnectionProperties

Index

Properties

Optional adaptativeBitrate

adaptativeBitrate: boolean

Whether to use adaptative bitrate (and therefore adaptative quality) or not. For local network connections that do not require media transcoding this can be disabled to save CPU power. If you are not sure if transcoding might be necessary, setting this property to false may result in media connections not being established.

Only for ConnectionType.IPCAM

default

true

Optional data

data: string

Secure (server-side) data associated to this Connection. Every client will receive this data in property Connection.data. Object Connection can be retrieved by subscribing to event connectionCreated of Session object.

  • If you have provided no data in your clients when calling method Session.connect(TOKEN, DATA) (DATA not defined), then Connection.data will only have this ConnectionProperties.data property.
  • If you have provided some data when calling Session.connect(TOKEN, DATA) (DATA defined), then Connection.data will have the following structure: "CLIENT_DATA%/%SERVER_DATA", being CLIENT_DATA the second parameter passed in OpenVidu Browser in method Session.connect and SERVER_DATA this ConnectionProperties.data property.

Optional kurentoOptions

kurentoOptions: { allowedFilters?: string[]; videoMaxRecvBandwidth?: number; videoMaxSendBandwidth?: number; videoMinRecvBandwidth?: number; videoMinSendBandwidth?: number }

WARNING: experimental option. This interface may change in the near future

Some advanced properties setting the configuration that the WebRTC streams of the Connection will have in Kurento Media Server. You can adjust:

  • videoMaxRecvBandwidth: maximum number of Kbps that the Connection will be able to receive from Kurento Media Server. 0 means unconstrained. Giving a value to this property will override the global configuration set in OpenVidu Server configuration (parameter OPENVIDU_STREAMS_VIDEO_MAX_RECV_BANDWIDTH) for every incoming stream of the Connection. WARNING: the lower value set to this property limits every other bandwidth of the WebRTC pipeline this server-to-client stream belongs to. This includes the user publishing the stream and every other user subscribed to the stream
  • videoMinRecvBandwidth: minimum number of Kbps that the cConnection will try to receive from Kurento Media Server. 0 means unconstrained. Giving a value to this property will override the global configuration set in OpenVidu Server configuration (parameter OPENVIDU_STREAMS_VIDEO_MIN_RECV_BANDWIDTH) for every incoming stream of the Connection.
  • videoMaxSendBandwidth: maximum number of Kbps that the Connection will be able to send to Kurento Media Server. 0 means unconstrained. Giving a value to this property will override the global configuration set in OpenVidu Server configuration (parameter OPENVIDU_STREAMS_VIDEO_MAX_SEND_BANDWIDTH) for every outgoing stream of the Connection. WARNING: this value limits every other bandwidth of the WebRTC pipeline this client-to-server stream belongs to. This includes every other user subscribed to the stream
  • videoMinSendBandwidth: minimum number of Kbps that the Connection will try to send to Kurento Media Server. 0 means unconstrained. Giving a value to this property will override the global configuration set in OpenVidu Server configuration (parameter OPENVIDU_STREAMS_VIDEO_MIN_SEND_BANDWIDTH) for every outgoing stream of the Connection.
  • allowedFilters: names of the filters the Connection will be able to apply. See Voice and video filters

Only for ConnectionType.WEBRTC

Type declaration

  • Optional allowedFilters?: string[]
  • Optional videoMaxRecvBandwidth?: number
  • Optional videoMaxSendBandwidth?: number
  • Optional videoMinRecvBandwidth?: number
  • Optional videoMinSendBandwidth?: number

Optional networkCache

networkCache: number

Size of the buffer of the endpoint receiving the IP camera's stream, in milliseconds. The smaller it is, the less delay the signal will have, but more problematic will be in unstable networks. Use short buffers only if there is a quality connection between the IP camera and OpenVidu Server.

Only for ConnectionType.IPCAM

default

2000

Optional onlyPlayWithSubscribers

onlyPlayWithSubscribers: boolean

Whether to enable the IP camera stream only when some user is subscribed to it, or not. This allows you to reduce power consumption and network bandwidth in your server while nobody is asking to receive the camera's video. On the counterpart, first user subscribing to the IP camera stream will take a little longer to receive its video.

Only for ConnectionType.IPCAM

default

true

Optional record

record: boolean

This feature is part of OpenVidu Pro tier PRO

Whether to record the streams published by this Connection or not. This only affects INDIVIDUAL recording

default

true

Optional role

The role assigned to this Connection

Only for ConnectionType.WEBRTC

default

PUBLISHER

Optional rtspUri

rtspUri: string

RTSP URI of an IP camera. For example: rtsp://your.camera.ip:7777/path

Only for ConnectionType.IPCAM

Optional type

Type of Connection. The ConnectionType dictates what properties will have effect:

default

WEBRTC

Generated using TypeDoc