Package 

Class ConnectOptions.Builder

    • Constructor Detail

      • ConnectOptions.Builder

        ConnectOptions.Builder(String accessToken)

    • Method Detail

      • enableIceGatheringOnAnyAddressPorts

        @NonNull() ConnectOptions.Builder enableIceGatheringOnAnyAddressPorts(boolean enable)

        Enable gathering of ICE candidates on "any address" ports. When this flag is set, portsnot bound to any specific network interface will be used, in addition to normal portsbound to the enumerated interfaces. This flag may need to be set to support certainnetwork configurations (e.g. some VPN implementations) where ports are not bound tospecific interfaces. Setting this flag means that additional candidates might need to begathered and evaluated, which could lead to slower ICE connection times for regularnetworks.

      • enableAutomaticSubscription

        @NonNull() ConnectOptions.Builder enableAutomaticSubscription(boolean enableAutomaticSubscription)

        Toggles automatic track subscription. If set to false, the LocalParticipant will receivenotifications of track publish events, but will not automatically subscribe to them. Ifset to true, the LocalParticipant will automatically subscribe to tracks as they arepublished. If unset, the default is true. Note: This feature is only available for GroupRooms. Toggling the flag in a P2P room does not modify subscription behavior.

      • enableNetworkQuality

        @NonNull() ConnectOptions.Builder enableNetworkQuality(boolean enableNetworkQuality)

        Enable or disable the Network Quality API.

        Set this to {@code true} to enable the Network Quality API when using Group Rooms.This option has no effect in Peer-to-Peer Rooms. The default value is {@code false}.

      • receiveTranscriptions

        @NonNull() ConnectOptions.Builder receiveTranscriptions(boolean receiveTranscription)

        Enable or disable receiving transcription of the room.

        Set this to {@code true} to receive transcriptions of the conversations in the room.This option has no effect in Peer-to-Peer Rooms. The default value is {@code false}.

      • preferAudioCodecs

        @NonNull() ConnectOptions.Builder preferAudioCodecs(@NonNull() List<AudioCodec> preferredAudioCodecs)

        Set preferred audio codecs. The list specifies which audio codecs would be preferred whennegotiating audio between participants. The preferences are applied in the order found inthe list starting with the most preferred audio codec to the least preferred audio codec.Audio codec preferences are not guaranteed to be satisfied because not all participantsare guaranteed to support all audio codecs. OpusCodec is the default audio codecif no preferences are set.

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

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

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

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

      • preferVideoCodecs

        @NonNull() ConnectOptions.Builder preferVideoCodecs(@NonNull() List<VideoCodec> preferredVideoCodecs)

        Set preferred video codecs. The list specifies which video codecs would be preferred whennegotiating video between participants. The preferences are applied in the order found inthe list starting with the most preferred video codec to the least preferred video codec.Video codec preferences are not guaranteed to be satisfied because not all participantsare guaranteed to support all video codecs. Vp8Codec is the default video codecif no preferences are set. Attempting to set preferred video codecs when video encodingmode is set to AUTO will throw an exception.

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

         ConnectOptions connectOptions = new ConnectOptions.Builder(token) .preferVideoCodecs(Collections.<VideoCodec>singletonList(new H264Codec())) .build();

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

         ConnectOptions connectOptions = new ConnectOptions.Builder(token) .preferVideoCodecs(Arrays.asList(new H264Codec(), new Vp8Codec(), new Vp9Codec())) .build();

      • region

        @NonNull() ConnectOptions.Builder region(@NonNull() String region)

        The region of the signaling Server the Client will use. By default, the Client willconnect to the nearest signaling Server determined by latencybased routing. Setting a value other than "gll" bypasses routing and guarantees thatsignaling traffic will be terminated in the region that you prefer. If you are connectingto a Group Room created with the "gll" Media Region (either

      • videoEncodingMode

        @NonNull() ConnectOptions.Builder videoEncodingMode(@Nullable() VideoEncodingMode videoEncodingMode)

        Set VideoEncodingMode. Setting it to AUTO will let the SDK select the codecs andmanage encodings automatically. It is null by default, which allows manually settingpreferred video codecs and/or max video bitrate. Attempting to set videoEncodingMode wheneither maxVideoBitrate (part of EncodingParameters) or preferVideoCodecs is set willthrow an exception.