TVOPreflightOptions

Objective-C

@interface TVOPreflightOptions : NSObject

Swift

class TVOPreflightOptions : NSObject

Represents options available when running a preflight test.

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

    Declaration

    Objective-C

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

    Swift

    var accessToken: String? { get }

  • @brief The queue where the preflight test will invoke delegate methods.

    @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.

    Declaration

    Objective-C

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

    Swift

    var delegateQueue: dispatch_queue_t? { get }

  • @brief A custom ICE configuration used to run a preflight test.

    Declaration

    Objective-C

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

    Swift

    var iceOptions: TVOIceOptions? { get }

  • @brief The collection of preferred audio codecs.

    @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.

    Declaration

    Objective-C

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

    Swift

    var preferredAudioCodecs: [TVOAudioCodec] { get }

  • Unavailable

    Use the designated builder methods instead.

    @brief Developers shouldn’t initialize this class directly.

    @discussion Use the designated builder methods instead.

    Declaration

    Objective-C

    - (null_unspecified instancetype)init;

  • @brief Creates an instance of TVOPreflightOptions using an access token.

    Declaration

    Objective-C

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

    Swift

    convenience init(accessToken: String)

    Parameters

    accessToken

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

    Return Value

    An instance of TVOPreflightOptions.

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

    Declaration

    Objective-C

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

    Swift

    convenience init(accessToken: String, block: @escaping TVOPreflightOptionsBuilderBlock)

    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.