TVIParticipant Class Reference

Inherits from NSObject
Declared in TVIParticipant.h

Overview

TVIParticipant is the base class from which Local and Remote Participants are derived.

  identity

The Participant’s identity.

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

Declared In

TVIParticipant.h

  sid

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

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

Declared In

TVIParticipant.h

  state

The signaling connection state of the Participant.

@property (nonatomic, assign, readonly) TVIParticipantState state

Declared In

TVIParticipant.h

  networkQualityLevel

The Participant’s Network Quality Level

@property (nonatomic, assign, readonly) TVINetworkQualityLevel networkQualityLevel

Discussion

This property represents the quality of a 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

TVIParticipant.h

  audioTracks

A collection of shared audio tracks.

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

Declared In

TVIParticipant.h

  videoTracks

A collection of shared video tracks.

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

Declared In

TVIParticipant.h

  dataTracks

A collection of shared data tracks.

@property (nonatomic, copy, readonly, nonnull) NSArray<TVIDataTrackPublication*> *dataTracks

Declared In

TVIParticipant.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

TVIParticipant cannot be created explicitly.

Declared In

TVIParticipant.h

– getTrack:

A utility method which finds a TVITrackPublication by its sid.

- (nullable TVITrackPublication *)getTrack:(nonnull NSString *)sid

Parameters

sid

The track sid.

Return Value

An instance of TVITrackPublication if found, otherwise nil.

Declared In

TVIParticipant.h

– getAudioTrack:

A utility method which finds a TVIAudioTrackPublication by its sid.

- (nullable TVIAudioTrackPublication *)getAudioTrack:(nonnull NSString *)sid

Parameters

sid

The track sid.

Return Value

An instance of TVIAudioTrackPublication if found, otherwise nil.

Declared In

TVIParticipant.h

– getVideoTrack:

A utility method which finds a TVIVideoTrackPublication by its sid.

- (nullable TVIVideoTrackPublication *)getVideoTrack:(nonnull NSString *)sid

Parameters

sid

The track sid.

Return Value

An instance of TVIVideoTrackPublication if found, otherwise nil.

Declared In

TVIParticipant.h

– getDataTrack:

A utility method which finds a TVIDataTrackPublication by its sid.

- (nullable TVIDataTrackPublication *)getDataTrack:(nonnull NSString *)sid

Parameters

sid

The track sid.

Return Value

An instance of TVIDataTrackPublication if found, otherwise nil.

Declared In

TVIParticipant.h