TVOPreflightOptions Class Reference

Inherits from NSObject
Declared in TVOPreflightOptions.h

Overview

Represents options available when running a preflight test.

  accessToken

A JWT access token which will be used to run the preflight test.

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

Declared In

TVOPreflightOptions.h

  delegateQueue

The queue where the preflight test will invoke delegate methods.

@property (nonatomic, strong, readonly, nullable) dispatch_queue_t delegateQueue

Discussion

All delegate methods are performed on this queue. Any TVOPreflightTest 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

TVOPreflightOptions.h

  iceOptions

A custom ICE configuration used to run a preflight test.

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

Declared In

TVOPreflightOptions.h

  preferredAudioCodecs

The collection of preferred audio codecs.

@property (nonatomic, copy, readonly, nonnull) NSArray<TVOAudioCodec*> *preferredAudioCodecs

Discussion

The list specifies which audio codecs will be preferred when negotiating audio between participants. The preferences are applied in the order found in the 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 participants are guaranteed to support all audio codecs. TVOOpusCodec is the default audio codec if no preferences are set.

Declared In

TVOPreflightOptions.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Use the designated builder methods instead.

Declared In

TVOPreflightOptions.h

+ optionsWithAccessToken:

Creates an instance of TVOPreflightOptions using an access token.

+ (nonnull instancetype)optionsWithAccessToken:(nonnull NSString *)accessToken

Parameters

accessToken

A JWT access token which will be used to run the preflight test.

Return Value

An instance of TVOPreflightOptions.

Declared In

TVOPreflightOptions.h

+ optionsWithAccessToken:block:

Creates an instance of TVOPreflightOptions using an access token and a builder block.

+ (nonnull instancetype)optionsWithAccessToken:(nonnull NSString *)accessToken block:(nonnull TVOPreflightOptionsBuilderBlock)block

Parameters

accessToken

A JWT access token which will be used to run the preflight test.

block

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

Return Value

An instance of TVOPreflightOptions.

Declared In

TVOPreflightOptions.h