TVIDataTrackOptions Class Reference

Inherits from NSObject
Declared in TVIDataTrackOptions.h

Overview

TVIDataTrackOptions specifies options for TVILocalDataTrack.

  ordered

Ordered transmission of messages. Defaults to YES.

@property (nonatomic, assign, readonly, getter=isOrdered) BOOL ordered

Declared In

TVIDataTrackOptions.h

  maxPacketLifeTime

Maximum retransmit time in milliseconds.

@property (nonatomic, assign, readonly) int maxPacketLifeTime

Declared In

TVIDataTrackOptions.h

  maxRetransmits

Maximum number of retransmitted messages.

@property (nonatomic, assign, readonly) int maxRetransmits

Declared In

TVIDataTrackOptions.h

  name

The name for the Track.

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

Declared In

TVIDataTrackOptions.h

+ options

Creates default options.

+ (null_unspecified instancetype)options

Return Value

An instance of TVIDataTrackOptions.

Declared In

TVIDataTrackOptions.h

+ optionsWithBlock:

Constructs TVIDataTrackOptions using the builder pattern.

+ (null_unspecified instancetype)optionsWithBlock:(nonnull TVIDataTrackOptionsBuilderBlock)block

Parameters

block

You can pass data track options to the builder using this block. The builder will construct a TVIDataTrackOptions object using the options provided.

Return Value

An instance of TVIDataTrackOptions.

Discussion

If both maxPacketLifeTime and maxRetransmits are set to non default values, or if maxPacketLifeTime or maxRetransmits are set to an out of range value, an NSInvalidArgumentException will be thrown.

Declared In

TVIDataTrackOptions.h