Package io.openvidu.java.client

Class IceServerProperties.Builder

java.lang.Object

io.openvidu.java.client.IceServerProperties.Builder

Enclosing class:

IceServerProperties

public static class IceServerProperties.Builder
extends Object

Builder for IceServerProperties

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IceServerProperties	build()	Builder for RecordingProperties
IceServerProperties.Builder	clone()
IceServerProperties.Builder	credential(String credential)	Set a credential for the ICE Server you want to use.
IceServerProperties.Builder	ignoreEmptyUrl(boolean ignore)
IceServerProperties.Builder	staticAuthSecret(String staticAuthSecret)	Secret for TURN authentication based on: https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00 https://www.ietf.org/proceedings/87/slides/slides-87-behave-10.pdf This will generate credentials valid for 24 hours which is the recommended value.
IceServerProperties.Builder	url(String url)	Set the url for the ICE Server you want to use.
IceServerProperties.Builder	username(String userName)	Set a username for the ICE Server you want to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

url

public IceServerProperties.Builder url(String url)

Set the url for the ICE Server you want to use. It should follow a valid format:

• https://datatracker.ietf.org/doc/html/rfc7065#section-3.1
• https://datatracker.ietf.org/doc/html/rfc7064#section-3.1

username

public IceServerProperties.Builder username(String userName)

Set a username for the ICE Server you want to use. This parameter should be defined only for TURN, not for STUN ICE Servers.

credential

public IceServerProperties.Builder credential(String credential)

Set a credential for the ICE Server you want to use. This parameter should be defined only for TURN, not for STUN ICE Servers.

staticAuthSecret

public IceServerProperties.Builder staticAuthSecret(String staticAuthSecret)

Secret for TURN authentication based on:

• https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00
• https://www.ietf.org/proceedings/87/slides/slides-87-behave-10.pdf

This will generate credentials valid for 24 hours which is the recommended value. You need to setup in your TURN service this same secret value which uses HMAC SHA1 as encryption algorithm. A TURN implementation which by default uses this is COTURN with static-auth-secret parameter.

ignoreEmptyUrl

public IceServerProperties.Builder ignoreEmptyUrl(boolean ignore)

clone

public IceServerProperties.Builder clone()

build

public IceServerProperties build()
                          throws IllegalArgumentException

Builder for RecordingProperties

Throws:

IllegalArgumentException - if the defined properties does not follows common STUN/TURN RFCs:

• https://datatracker.ietf.org/doc/html/rfc7065#section-3.1
• https://datatracker.ietf.org/doc/html/rfc7064#section-3.1