public static class SipProperties.Builder
extends java.lang.Object
SipProperties| Constructor and Description |
|---|
Builder() |
| Modifier and Type | Method and Description |
|---|---|
SipProperties |
build()
Builds the SipProperties object.
|
SipProperties.Builder |
from(java.lang.String from)
Call this method to set the SIP
from field (optional). |
SipProperties.Builder |
headersJsonStartingWithXDash(java.lang.String headersJsonStartingWithXDash)
Call this method to define custom headers to be added to the SIP INVITE
initiated from OpenTok to your SIP platform.
|
SipProperties.Builder |
observeForceMute(boolean observeForceMute)
Call this method and pass in
true to have the SIP end point observe
force mute moderation. |
SipProperties.Builder |
password(java.lang.String password)
Call this method to set the password for the SIP gateway provider (optional).
|
SipProperties.Builder |
secure(boolean secure)
Call this method and pass in
true to indicate that the media
must be transmitted encrypted. |
SipProperties.Builder |
sipUri(java.lang.String sipUri)
Call this method to set the SIP URI.
|
SipProperties.Builder |
streams(java.lang.String... streams)
The stream IDs of the participants' which will be subscribed by the SIP participant.
|
SipProperties.Builder |
userName(java.lang.String userName)
Call this method to set the username for the SIP gateway provider (optional).
|
SipProperties.Builder |
video(boolean video)
Call this method and pass in
true to enable video in the SIP call. |
public SipProperties.Builder sipUri(java.lang.String sipUri)
sipUri - (required) — The SIP URI to be used as destination of the SIP call
initiated from OpenTok to your SIP platform. If the SIP URI contains a
transport=tls header, the negotiation between OpenTok and the SIP endpoint will be
done securely. Note that this will only apply to the negotiation itself, and not to the
transmission of audio. If you also audio transmission to be encrypted, set the
secure property to truepublic SipProperties.Builder from(java.lang.String from)
from field (optional).from - The number or string that will be sent to the final SIP number as the caller.
It must be a string in the form of from@example.com, where from can be a string or
a number. If from is set to a number (for example, "14155550101@example.com"),
it will show up as the incoming number on PSTN phones.
If from is undefined or set to a string (for example, "joe@example.com"),
+00000000 will show up as the incoming number on PSTN phones.public SipProperties.Builder userName(java.lang.String userName)
userName - The username.public SipProperties.Builder password(java.lang.String password)
password - The password.public SipProperties.Builder headersJsonStartingWithXDash(java.lang.String headersJsonStartingWithXDash)
headersJsonStartingWithXDash - This JSON string defines custom headers
to be added to the SIP INVITE request initiated from OpenTok to your SIP platform.
Note: You no longer need to append the "X-" prefix to the beginning of custom headers. This restriction, which applied previously, has been removed.
public SipProperties.Builder secure(boolean secure)
true to indicate that the media
must be transmitted encrypted. Pass in false, the default, if encryption
is not required.secure - A Boolean flag that indicates whether the media must be transmitted
encrypted (true) or not (false, the default).public SipProperties.Builder video(boolean video)
true to enable video in the SIP call.
The default is false.video - Whether video should be enabled in the SIP call.public SipProperties.Builder observeForceMute(boolean observeForceMute)
true to have the SIP end point observe
force mute moderation.
The default is false.observeForceMute - Whether to observe force mute moderation.public SipProperties.Builder streams(java.lang.String... streams)
streams - Stream IDs to select.public SipProperties build()