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> delegate
Declared In
TVILocalParticipant.h
localAudioTracks
A collection of TVILocalAudioTrackPublication
objects.
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalAudioTrackPublication*> *localAudioTracks
Declared In
TVILocalParticipant.h
localDataTracks
A collection of TVILocalDataTrackPublication
objects.
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalDataTrackPublication*> *localDataTracks
Declared In
TVILocalParticipant.h
localVideoTracks
A collection of TVILocalVideoTrackPublication
objects.
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalVideoTrackPublication*> *localVideoTracks
Declared In
TVILocalParticipant.h
signalingRegion
Where the Participant’s signaling traffic enters and exits Twilio’s communications cloud.
This property reflects the TVIConnectOptions.region
provided by the Participant and when “gll”
(the default value) is provided, the region that was selected using latency based routing.
@property (nonatomic, copy, readonly, nonnull) NSString *signalingRegion
Declared In
TVILocalParticipant.h
– publishAudioTrack:
Publishes the audio track to the Room with the default TVILocalTrackPublicationOptions
.
- (BOOL)publishAudioTrack:(nonnull TVILocalAudioTrack *)track
Parameters
track |
The |
---|
Return Value
YES
if the track was published successfully, NO
otherwise.
Declared In
TVILocalParticipant.h
– publishAudioTrack:publicationOptions:
Publishes the audio track to the Room.
- (BOOL)publishAudioTrack:(nonnull TVILocalAudioTrack *)track publicationOptions:(nonnull TVILocalTrackPublicationOptions *)options
Parameters
track |
The |
---|---|
options |
The |
Return Value
YES
if the track was published successfully, NO
otherwise.
Declared In
TVILocalParticipant.h
– publishDataTrack:
Publishes the data track to the Room with the default TVILocalTrackPublicationOptions
.
- (BOOL)publishDataTrack:(nonnull TVILocalDataTrack *)track
Parameters
track |
The |
---|
Return Value
YES
if the track was published successfully, NO
otherwise.
Declared In
TVILocalParticipant.h
– publishDataTrack:publicationOptions:
Publishes the data track to the Room.
- (BOOL)publishDataTrack:(nonnull TVILocalDataTrack *)track publicationOptions:(nonnull TVILocalTrackPublicationOptions *)options
Parameters
track |
The |
---|---|
options |
The |
Return Value
YES
if the track was published successfully, NO
otherwise.
Declared In
TVILocalParticipant.h
– publishVideoTrack:
Publishes the video track to the Room with the default TVILocalTrackPublicationOptions
.
- (BOOL)publishVideoTrack:(nonnull TVILocalVideoTrack *)track
Parameters
track |
The |
---|
Return Value
YES
if the track was published successfully, NO
otherwise.
Declared In
TVILocalParticipant.h
– publishVideoTrack:publicationOptions:
Publishes the video track to the Room.
- (BOOL)publishVideoTrack:(nonnull TVILocalVideoTrack *)track publicationOptions:(nonnull TVILocalTrackPublicationOptions *)options
Parameters
track |
The |
---|---|
options |
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 *)track
Parameters
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 *)track
Parameters
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 *)track
Parameters
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 *)encodingParameters
Parameters
encodingParameters |
The |
---|
Declared In
TVILocalParticipant.h
– init
Developers shouldn’t initialize this class directly.
- (null_unspecified instancetype)init
Discussion
Use TwilioVideo
connectWith* methods to join a TVIRoom
and query its localParticipant
property.
Declared In
TVILocalParticipant.h