TVIRoom Class Reference

Inherits from NSObject
Declared in TVIRoom.h

Overview

TVIRoom represents a media session with zero or more remote Participants. Media shared by any one Participant is distributed equally to all other Participants.

CallKit specific additions.

Other Methods

  delegate

The TVIRoomDelegate. Set this property to be notified about Room events such as connection status, and Participants joining and leaving.

@property (nonatomic, weak, readonly, nullable) id<TVIRoomDelegate> delegate

Declared In

TVIRoom.h

  localParticipant

A representation of your local Client in the Room.

@property (nonatomic, strong, readonly, nullable) TVILocalParticipant *localParticipant

Discussion

TVILocalParticipant is available once the delegate method didConnectToRoom is called. If you have not yet connected to the Room, or your attempt fails then this property will return nil.

Declared In

TVIRoom.h

  name

The name of the Room.

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

Discussion

name will return the sid if the Room was created without a name.

Declared In

TVIRoom.h

  participants

A collection of connected participants to TVIRoom.

@property (nonatomic, copy, readonly, nonnull) NSArray<TVIParticipant*> *participants

Declared In

TVIRoom.h

  recording

Indicates if the Room is being recorded.

@property (nonatomic, assign, readonly, getter=isRecording) BOOL recording

Declared In

TVIRoom.h

  sid

The sid of the Room.

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

Declared In

TVIRoom.h

  state

The Room’s current state. Use TVIRoomDelegate to know about changes in TVIRoomState.

@property (nonatomic, assign, readonly) TVIRoomState state

Declared In

TVIRoom.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

TVIRoom can not be created with init

Declared In

TVIRoom.h

– getParticipantWithSid:

Utility method which gets a Participant using its sid.

- (nullable TVIParticipant *)getParticipantWithSid:(nonnull NSString *)sid

Parameters

sid

The sid.

Return Value

An instance of TVIParticipant if successful, or nil if not.

Declared In

TVIRoom.h

– disconnect

Disconnects from the Room.

- (void)disconnect

Declared In

TVIRoom.h

CallKit Methods

  uuid

The CallKit identifier for the Room.

@property (nonatomic, readonly, nullable) NSUUID *uuid

Discussion

Use this UUID as an argument to CallKit methods.

Declared In

TVIRoom.h