TWCIceOptions Class Reference

Inherits from NSObject
Declared in TWCIceOptions.h

Overview

TWCIceOptions specifies custom media connectivity configurations.

Media connections are established using the ICE (Interactive Connectivity Establishment) protocol. These options allow you to customize how data flows to and from participants, and which protocols to use. You may also provide your own ICE servers, overriding the defaults. https://www.twilio.com/stun-turn

  iceServers

An array of TWCIceServer objects to be used during connection establishment.

@property (nonatomic, copy, nonnull, readonly) NSArray<TWCIceServer*> *iceServers

Discussion

An array of TWCIceServer objects to be used during connection establishment.

Declared In

TWCIceOptions.h

  iceTransportPolicy

The transport policy to use. Defaults to TWCIceTransportPolicyAll.

@property (nonatomic, assign, readonly) TWCIceTransportPolicy iceTransportPolicy

Discussion

The transport policy to use. Defaults to TWCIceTransportPolicyAll.

Declared In

TWCIceOptions.h

– initWithTransportPolicy:

Creates a TWCIceOptions instance with a custom transport policy.

- (_Null_unspecified instancetype)initWithTransportPolicy:(TWCIceTransportPolicy)transportPolicy

Parameters

transportPolicy

The TWCIceTransportPolicy to use.

Return Value

An initialized object if the policy was valid, otherwise nil.

Discussion

Creates a TWCIceOptions instance with a custom transport policy.

Declared In

TWCIceOptions.h

– initWithTransportPolicy:servers:

Creates a TWCIceOptions instance with a custom transport policy, and servers.

- (_Null_unspecified instancetype)initWithTransportPolicy:(TWCIceTransportPolicy)transportPolicy servers:(nonnull NSArray<TWCIceServer*> *)servers

Parameters

transportPolicy

The TWCIceTransportPolicy to use.

servers

An array of STUN and TURN servers in the form of TWCIceServer objects.

Return Value

An initialized object if the policy was valid, otherwise nil.

Discussion

Creates a TWCIceOptions instance with a custom transport policy, and servers.

If you provide no servers then Twilio’s Network Traversal Service will be used.

Declared In

TWCIceOptions.h