TVILocalParticipant Class Reference
| Inherits from | TVIParticipant : NSObject |
|---|---|
| Declared in | TVILocalParticipant.h |
delegate
The Local Participant’s delegate. Set this property to be notified about Participant events such as tracks being published.
@property (atomic, weak, nullable) id<TVILocalParticipantDelegate> delegateDeclared In
TVILocalParticipant.h
localAudioTracks
A collection of TVILocalAudioTrackPublication objects.
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalAudioTrackPublication*> *localAudioTracksDeclared In
TVILocalParticipant.h
localDataTracks
A collection of TVILocalDataTrackPublication objects.
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalDataTrackPublication*> *localDataTracksDeclared In
TVILocalParticipant.h
localVideoTracks
A collection of TVILocalVideoTrackPublication objects.
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalVideoTrackPublication*> *localVideoTracksDeclared In
TVILocalParticipant.h
networkQualityLevel
The Local Participant’s Network Quality Level
@property (nonatomic, assign, readonly) TVINetworkQualityLevel networkQualityLevelDiscussion
This property represents the quality of a Local Participant’s connection in a Room. This value may not
be immediately available, and, in some cases, it’s impossible to calculate it. In these instances,
networkQualityLevel will return TVINetworkQualityLevelUnknown. Calling this API in a Peer-to-Peer Room will
always return TVINetworkQualityLevelUnknown. This is part of the Network Quality API and must be enabled by
enabling the networkQualityEnabled option in TVIConnectOptions.
Declared In
TVILocalParticipant.h
– publishAudioTrack:
Publishes the audio track to the Room.
- (BOOL)publishAudioTrack:(nonnull TVILocalAudioTrack *)trackParameters
track |
The |
|---|
Return Value
YES if the track was published successfully, NO otherwise.
Declared In
TVILocalParticipant.h
– publishDataTrack:
Publishes the data track to the Room.
- (BOOL)publishDataTrack:(nonnull TVILocalDataTrack *)trackParameters
track |
The |
|---|
Return Value
YES if the track was published successfully, NO otherwise.
Declared In
TVILocalParticipant.h
– publishVideoTrack:
Publishes the video track to the Room.
- (BOOL)publishVideoTrack:(nonnull TVILocalVideoTrack *)trackParameters
track |
The |
|---|
Return Value
YES if the track was published successfully, NO otherwise.
Declared In
TVILocalParticipant.h
– unpublishAudioTrack:
Unpublishes the audio track from the Room.
- (BOOL)unpublishAudioTrack:(nonnull TVILocalAudioTrack *)trackParameters
track |
The |
|---|
Return Value
YES if the track was unpublished successfully, NO otherwise.
Declared In
TVILocalParticipant.h
– unpublishDataTrack:
Unpublishes the data track from the Room.
- (BOOL)unpublishDataTrack:(nonnull TVILocalDataTrack *)trackParameters
track |
The |
|---|
Return Value
YES if the track was unpublished successfully, NO otherwise.
Declared In
TVILocalParticipant.h
– unpublishVideoTrack:
Unpublishes the video track from the Room.
- (BOOL)unpublishVideoTrack:(nonnull TVILocalVideoTrack *)trackParameters
track |
The |
|---|
Return Value
YES if the track was unpublished successfully, NO otherwise.
Declared In
TVILocalParticipant.h
– setEncodingParameters:
Updates the TVIEncodingParameters used to share media in the Room.
- (void)setEncodingParameters:(nullable TVIEncodingParameters *)encodingParametersParameters
encodingParameters |
The |
|---|
Declared In
TVILocalParticipant.h
– init
Developers shouldn’t initialize this class directly.
- (null_unspecified instancetype)initDiscussion
Use TwilioVideo connectWith* methods to join a TVIRoom and query its localParticipant property.
Declared In
TVILocalParticipant.h