io.openvidu.java.client

Class KurentoOptions

java.lang.Object

io.openvidu.java.client.KurentoOptions

public class KurentoOptions
extends Object

See TokenOptions.getKurentoOptions()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KurentoOptions.Builder Builder for KurentoOptions

Constructor Summary

Constructors

Constructor and Description
KurentoOptions(Integer videoMaxRecvBandwidth, Integer videoMinRecvBandwidth, Integer videoMaxSendBandwidth, Integer videoMinSendBandwidth, String[] allowedFilters)

Method Summary

Modifier and Type	Method and Description
String[]	getAllowedFilters() Defines the names of the filters the user owning the token will be able to apply.
Integer	getVideoMaxRecvBandwidth() Defines the maximum number of Kbps that the client owning the token will be able to receive from Kurento Media Server.
Integer	getVideoMaxSendBandwidth() Defines the maximum number of Kbps that the client owning the token will be able to send to Kurento Media Server.
Integer	getVideoMinRecvBandwidth() Defines the minimum number of Kbps that the client owning the token will try to receive from Kurento Media Server.
Integer	getVideoMinSendBandwidth() Defines the minimum number of Kbps that the client owning the token will try to send to Kurento Media Server.

Methods inherited from class java.lang.Object

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

Constructor Detail

KurentoOptions

public KurentoOptions(Integer videoMaxRecvBandwidth,
                      Integer videoMinRecvBandwidth,
                      Integer videoMaxSendBandwidth,
                      Integer videoMinSendBandwidth,
                      String[] allowedFilters)

Method Detail

getVideoMaxRecvBandwidth

public Integer getVideoMaxRecvBandwidth()

Defines the maximum number of Kbps that the client owning the token 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 user owning the token.
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

getVideoMinRecvBandwidth

public Integer getVideoMinRecvBandwidth()

Defines the minimum number of Kbps that the client owning the token 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 user owning the token.

getVideoMaxSendBandwidth

public Integer getVideoMaxSendBandwidth()

Defines the maximum number of Kbps that the client owning the token 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 user owning the token.
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

getVideoMinSendBandwidth

public Integer getVideoMinSendBandwidth()

Defines the minimum number of Kbps that the client owning the token 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 user owning the token.

getAllowedFilters

public String[] getAllowedFilters()

Defines the names of the filters the user owning the token will be able to apply. See Voice and video filters