TVIConnectOptions Class Reference

Inherits from	NSObject
Declared in	TVIConnectOptions.h

Overview

TVIConnectOptions represents a custom configuration to use when connecting to a Room.

This configuration overrides what was provided in TVIClilentOptions.

CallKit specific additions.

Other Methods

`iceOptions`

A custom ICE configuration used to connect to a Room.

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

Discussion

You can set this to nil if you’ve already provided IceOptions with TVIClientOptions.

Declared In

TVIConnectOptions.h

`localMedia`

The LocalMedia used to connect to a Room.

@property (nonatomic, strong, readonly, nullable) TVILocalMedia *localMedia

Discussion

If you set this property to nil then a default instance of TVILocalMedia with no audio or video tracks will be provided instead.

Declared In

TVIConnectOptions.h

`name`

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

@property (nonatomic, copy, readonly, nullable) NSString *name

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

`+ options`

Creates the default TVIConnectOptions.

+ (nonnull instancetype)options

Return Value

An instance of TVIConnectOptions.

Declared In

TVIConnectOptions.h

`+ optionsWithBlock:`

Creates an instance of TVIConnectOptions using a builder block.

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

Parameters

`block`	The builder block which will be used to configure the `TVIConnectOptions` instance.

Return Value

An instance of TVIConnectOptions.

Declared In

TVIConnectOptions.h

CallKit Methods

`uuid`

The CallKit identifier for the Room.

@property (nonatomic, strong, readonly, nullable) NSUUID *uuid

Discussion

This property allows you to provide your CallKit UUID as part of TVIConnectOptions. This is offered as a convenience if you wish to use TVIRoom for CallKit book keeping. The UUID set here will be reflected on any TVIRoom instance created with these options.

Declared In

TVIConnectOptions.h