TVILocalParticipant Class Reference

Inherits from	NSObject
Declared in	TVILocalParticipant.h

Overview

TVILocalParticipant represents your Client in a Room which you are connected to.

`identity`

The identity of the TVILocalParticipant.

@property (nonatomic, readonly, copy, nonnull) NSString *identity

Declared In

TVILocalParticipant.h

`sid`

The LocalParticipant’s server identifier. This value uniquely identifies your Client in a Room and is often useful for debugging purposes.

@property (nonatomic, readonly, copy, nonnull) NSString *sid

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

`audioTracks`

The collection of local audio tracks being shared in the Room.

@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalAudioTrack*> *audioTracks

Declared In

TVILocalParticipant.h

`videoTracks`

The collection of local video tracks being shared in the Room.

@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalVideoTrack*> *videoTracks

Declared In

TVILocalParticipant.h

`– addAudioTrack:`

Adds a Track to the LocalParticipant, sharing it in the Room.

- (BOOL)addAudioTrack:(nonnull TVILocalAudioTrack *)track

Parameters

`track`	The `TVILocalAudioTrack` which you would like to share.

Return Value

YES if the track was added successfully, NO otherwise.

Declared In

TVILocalParticipant.h

`– addVideoTrack:`

Adds a Track to the LocalParticipant, sharing it in the Room.

- (BOOL)addVideoTrack:(nonnull TVILocalVideoTrack *)track

Parameters

`track`	The `TVILocalVideoTrack` which you would like to share.

Return Value

YES if the track was added successfully, NO otherwise.

Declared In

TVILocalParticipant.h

`– removeAudioTrack:`

Removes a Track from the LocalParticipant, un-sharing it from the Room.

- (BOOL)removeAudioTrack:(nonnull TVILocalAudioTrack *)track

Parameters

`track`	The `TVILocalVideoTrack` which you would like to remove.

Return Value

YES if the track was removed successfully, NO otherwise.

Declared In

TVILocalParticipant.h

`– removeVideoTrack:`

Removes a Track from the LocalParticipant, un-sharing it from the Room.

- (BOOL)removeVideoTrack:(nonnull TVILocalVideoTrack *)track

Parameters

`track`	The `TVILocalVideoTrack` which you would like to remove.

Return Value

YES if the track was removed successfully, NO otherwise.

Declared In

TVILocalParticipant.h