Package com.opentok

Class SipProperties

java.lang.Object

com.opentok.SipProperties

public class SipProperties
extends Object

Defines values for the properties parameter of the OpenTok.dial(String, String, SipProperties) method.

See Also:

• OpenTok.dial(String, String, SipProperties)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SipProperties.Builder	Use this class to create a SipProperties object.

Method Summary

Modifier and Type	Method	Description
String	from()	Returns the from value.
String	headersJsonStartingWithXDash()	Returns the SIP headers as JSON.
boolean	observeForceMute()	Returns the observeForceMute value (true or false).
String	password()	Returns the password.
boolean	secure()	Returns the secure value (true or false).
String	sipUri()	Returns the SIP URI.
String[]	streams()	Returns the subscribed stream IDs.
String	userName()	Returns the user name.
boolean	video()	Return the video value (true or false).

Methods inherited from class java.lang.Object

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

Method Details

sipUri

public String sipUri()

Returns the SIP URI.

from

public String from()

Returns the from value.

userName

public String userName()

Returns the user name.

password

public String password()

Returns the password.

headersJsonStartingWithXDash

public String headersJsonStartingWithXDash()

Returns the SIP headers as JSON.

secure

public boolean secure()

Returns the secure value (true or false).

video

public boolean video()

Return the video value (true or false).

observeForceMute

public boolean observeForceMute()

Returns the observeForceMute value (true or false).

streams

public String[] streams()

Returns the subscribed stream IDs.

Returns:

The selected stream IDs as an array.