TVIConnectOptionsBuilder Class Reference
Inherits from | NSObject |
---|---|
Declared in | TVIConnectOptions.h |
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
dataTracks
A collection of local data tracks which will be shared in the Room.
@property (nonatomic, copy, nonnull) NSArray<TVILocalDataTrack*> *dataTracks
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
encodingParameters
Encoding parameters to use when sharing media in the Room.
@property (nonatomic, strong, nullable) TVIEncodingParameters *encodingParameters
Discussion
See TVIEncodingParameters
for more information. Setting this value to nil
indicates that default parameters will be chosen by the media engine.
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
preferredAudioCodecs
The collection of preferred audio codecs.
@property (nonatomic, copy, nonnull) NSArray<TVIAudioCodec> *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. TVIAudioCodecOpus
is the default audio codec if no preferences are set.
Declared In
TVIConnectOptions.h
preferredVideoCodecs
The collection of preferred video codecs.
@property (nonatomic, copy, nonnull) NSArray<TVIVideoCodec> *preferredVideoCodecs
Discussion
The list specifies which video codecs will be preferred when negotiating video between participants.
The preferences are applied in the order found in the list starting with the most preferred video codec to the
least preferred video codec. Video codec preferences are not guaranteed to be satisfied because not all participants
are guaranteed to support all video codecs. TVIVideoCodecVP8
is the default video codec if no preferences are set.
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