TVIIceOptions Class Reference

Inherits from	NSObject
Declared in	TVIIceOptions.h

Overview

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

`servers`

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

@property (nonatomic, copy, nonnull, readonly) NSArray<TVIIceServer*> *servers

Declared In

TVIIceOptions.h

`transportPolicy`

The transport policy to use. Defaults to TVIIceTransportPolicyAll.

@property (nonatomic, assign, readonly) TVIIceTransportPolicy transportPolicy

Declared In

TVIIceOptions.h

`abortOnIceServersTimeout`

Whether to abort if ICE servers time out.

@property (nonatomic, assign, readonly) BOOL abortOnIceServersTimeout

Discussion

If fetching ICE servers times out (due to a restrictive network or a slow network proxy), then, by default, the Video SDK will fallback to using hard-coded STUN servers and continue connecting to the Room. Setting this property to true will instead abort with error 53500, “Unable to acquire configuration”. Defaults to ‘NO’.

Declared In

TVIIceOptions.h

`iceServersTimeout`

The timeout to wait (before aborting) when acquiring ICE servers. Defaults to 3 seconds.

@property (nonatomic, assign, readonly) NSTimeInterval iceServersTimeout

Declared In

TVIIceOptions.h

`+ options`

Creates a default TVIIceOptions instance.

+ (_Null_unspecified instancetype)options

Return Value

An instance of TVIIceOptions.

Declared In

TVIIceOptions.h

`+ optionsWithBlock:`

Creates a TVIIceOptions instance using a builder block that you specify.

+ (nonnull instancetype)optionsWithBlock:(nonnull TVIIceOptionsBuilderBlock)block

Parameters

`block`	A `TVIIceOptionsBuilderBlock` which sets specific options on the builder.

Return Value

A TVIIceOptions instance created using options set in the builder block.

Declared In

TVIIceOptions.h