TVIConnectOptionsBuilder Class Reference

Inherits from NSObject
Declared in TVIConnectOptions.h

Overview

TVIConnectOptionsBuilder is a builder class for TVIConnectOptions.

  audioTracks

A collection of local audio tracks which will be shared in the Room.

@property (nonatomic, copy, nonnull) NSArray<TVILocalAudioTrack*> *audioTracks

Declared In

TVIConnectOptions.h

  delegateQueue

The queue where the Room and associated classes will invoke delegate methods.

@property (nonatomic, strong, nullable) dispatch_queue_t delegateQueue

Discussion

All delegate methods except for TVIVideoViewDelegate and TVICameraCaptureDelegate are performed on this queue. Any TVIRoom instance which is created with these options will maintain a strong reference to the queue until it is destroyed. The default value of nil indicates that the main dispatch queue will be used.

Declared In

TVIConnectOptions.h

  iceOptions

A custom ICE configuration used to connect to a Room.

@property (nonatomic, strong, nullable) TVIIceOptions *iceOptions

Declared In

TVIConnectOptions.h

  insightsEnabled

Enables or disables Insights statistics collection.

@property (nonatomic, assign, getter=areInsightsEnabled) BOOL insightsEnabled

Discussion

The default value is YES. Insights reports metrics about the Media that your Participant sends and receives in a Room.

Declared In

TVIConnectOptions.h

  reconnectAfterReturningToForeground

A BOOL which determines if the SDK will attempt to reconnect after returning to the foreground.

@property (nonatomic, assign, getter=shouldReconnectAfterReturningToForeground) BOOL reconnectAfterReturningToForeground

Discussion

When the Room is in TVIRoomStateConnected state, the SDK attempts to reconnect if the app comes to foreground within a short period of time. If the app does not come to foreground within a short time, SDK triggers disconnect. If the Room is in TVIRoomStateConnecting state before the app goes to background, the SDK will trigger disconnect. By default, this behavior is enabled when CallKit is not used. Set this connect options to NO to disable it.

Declared In

TVIConnectOptions.h

  roomName

The name of the Room which you want to connect to.

@property (nonatomic, copy, nullable) NSString *roomName

Discussion

You can provide the name of new or existing Room. The default value of nil indicates that a new Room will be created.

Declared In

TVIConnectOptions.h

  videoTracks

A collection of local video tracks which will be shared in the Room.

@property (nonatomic, copy, nonnull) NSArray<TVILocalVideoTrack*> *videoTracks

Declared In

TVIConnectOptions.h

– init

You should not initialize TVIConnectOptionsBuilder directly, use a TVIConnectOptionsBuilderBlock instead.

- (null_unspecified instancetype)init

Declared In

TVIConnectOptions.h