com.twilio.voice

Class ConnectOptions.Builder

java.lang.Object

com.twilio.voice.CallOptions.Builder

com.twilio.voice.ConnectOptions.Builder

Enclosing class:

ConnectOptions

public static class ConnectOptions.Builder
extends CallOptions.Builder

Build new ConnectOptions.

All methods are optional.

Constructor Summary

Constructors

Constructor and Description
Builder(String accessToken) Use this Builder when making a Call

Method Summary

Modifier and Type	Method and Description
ConnectOptions	build() Builds ConnectOptions object.
ConnectOptions.Builder	enableDscp(boolean enable) Enable Differentiated Services Field Code Point (DSCP) with Expedited Forwarding (EF).
ConnectOptions.Builder	enableInsights(boolean enable) Specify reporting statistics to Insights.
ConnectOptions.Builder	iceOptions(IceOptions iceOptions) Custom ICE configuration used to connect to a Call.
ConnectOptions.Builder	params(Map<String,String> params) Set the parameters that are passed to the TwiML application specified by the access token.
ConnectOptions.Builder	preferAudioCodecs(List<AudioCodec> preferredAudioCodecs) Set preferred audio codecs.
ConnectOptions.Builder	region(String region) Sets the region (Twilio data center) for the SDK.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String accessToken)

Use this Builder when making a Call

The identity provided in the Access Token may only contain alpha-numeric and underscore characters. Other characters, including spaces, will result in undefined behavior.

Parameters:

accessToken - The accessToken that provides the identity and grants of the caller in a JSON Web Token(JWT) format.

Method Detail

params

public ConnectOptions.Builder params(Map<String,String> params)

Set the parameters that are passed to the TwiML application specified by the access token.

Parameters specified in this map will be provided as HTTP GET query params or as part of the HTTP POST body to the request url specified in your TwiML Application (https://www.twilio.com/console/voice/twiml/apps). These parameters can be used to configure the behavior of your call within the context of your TwiML Application. NOTE: The Voice SDK URI encodes the parameters before passing them to your TwiML Application.

iceOptions

public ConnectOptions.Builder iceOptions(IceOptions iceOptions)

Custom ICE configuration used to connect to a Call.

enableInsights

public ConnectOptions.Builder enableInsights(boolean enable)

Specify reporting statistics to Insights. Sending stats data to Insights is enabled by default.

enableDscp

public ConnectOptions.Builder enableDscp(boolean enable)

Enable Differentiated Services Field Code Point (DSCP) with Expedited Forwarding (EF).

Parameters:

enable - Enable DSCP. Defaults to true.

preferAudioCodecs

public ConnectOptions.Builder preferAudioCodecs(List<AudioCodec> preferredAudioCodecs)

Set preferred audio codecs. The list specifies which audio codecs would be preferred when negotiating audio with the backend service. The preferences are applied in the order found in the list starting with the most preferred audio codec to the least preferred audio codec. Audio codec preferences are not guaranteed to be satisfied because the backend service is not guaranteed to support all audio codecs.

The following snippet demonstrates how to prefer a single audio codec.

     ConnectOptions connectOptions = new ConnectOptions.Builder(token)
          .preferAudioCodecs(Collections.singletonList(new PcmuCodec()))
          .build();
 

The following snippet demonstrates how to specify the exact order of codec preferences.

     ConnectOptions connectOptions = new ConnectOptions.Builder(token)
          .preferAudioCodecs(Arrays.asList(new PcmuCodec(), new OpusCodec()))
          .build();
 

region

public ConnectOptions.Builder region(String region)

Sets the region (Twilio data center) for the SDK. The default region uses Global Low Latency routing, which establishes a connection with the closest region to the user. NOTE: Setting the region during a call will not apply until all ongoing calls have ended and a subsequent call is placed.

Parameters:

region - The region.

build

public ConnectOptions build()

Builds ConnectOptions object.