Package io.openvidu.java.client

Class ConnectionProperties

java.lang.Object

io.openvidu.java.client.ConnectionProperties

public class ConnectionProperties
extends Object

See Session.createConnection(ConnectionProperties)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConnectionProperties.Builder	Builder for ConnectionProperties
static class	ConnectionProperties.DefaultValues

Method Summary

Modifier and Type	Method	Description
Boolean	adaptativeBitrate()	Whether this Connection uses adaptative bitrate (and therefore adaptative quality) or not.
static ConnectionProperties.Builder	fromJson(Map<String,?> params)	Obtain a ConnectionProperties.Builder directly from a JSON object in the form of a Map
List<IceServerProperties>	getCustomIceServers()	Returns a list of custom ICE Servers configured for this connection.
String	getData()	Returns the secure (server-side) metadata assigned to this Connection.
KurentoOptions	getKurentoOptions()	Returns the KurentoOptions assigned to this Connection.
Integer	getNetworkCache()	Size of the buffer of the endpoint receiving the IP camera's stream, in milliseconds.
OpenViduRole	getRole()	Returns the role assigned to this Connection.
String	getRtspUri()	Returns the RTSP URI of this Connection.
ConnectionType	getType()	Returns the type of Connection.
Boolean	onlyPlayWithSubscribers()	Whether to enable the IP camera stream only when some user is subscribed to it.
Boolean	record()	PRO Whether the streams published by this Connection will be recorded or not.
com.google.gson.JsonObject	toJson(String sessionId)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getType

public ConnectionType getType()

Returns the type of Connection.

getData

public String getData()

Returns the secure (server-side) metadata assigned to this Connection.

record

public Boolean record()

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

getRole

public OpenViduRole getRole()

Returns the role assigned to this Connection.

Only for ConnectionType.WEBRTC

getKurentoOptions

public KurentoOptions getKurentoOptions()

Returns the KurentoOptions assigned to this Connection.

Only for ConnectionType.WEBRTC

getRtspUri

public String getRtspUri()

Returns the RTSP URI of this Connection.

Only for ConnectionType.IPCAM

adaptativeBitrate

public Boolean adaptativeBitrate()

Whether this Connection uses 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

onlyPlayWithSubscribers

public Boolean onlyPlayWithSubscribers()

Whether to enable the IP camera stream only when some user is subscribed to it. 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

getNetworkCache

public Integer getNetworkCache()

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

getCustomIceServers

public List<IceServerProperties> getCustomIceServers()

Returns a list of custom ICE Servers configured for this connection.

See ConnectionProperties.Builder.addCustomIceServer(IceServerProperties) for more information.

Only for ConnectionType.WEBRTC

toJson

public com.google.gson.JsonObject toJson(String sessionId)

fromJson

public static ConnectionProperties.Builder fromJson(Map<String,?> params)
                                             throws IllegalArgumentException

Obtain a ConnectionProperties.Builder directly from a JSON object in the form of a Map

Returns:

A ConnectionProperties.Builder

Throws:

IllegalArgumentException - If some parameter has a wrong type or an invalid value