TwilioVideo Class Reference

Inherits from NSObject
Declared in TwilioVideo.h

Overview

TwilioVideo is the root class of the Twilio Video SDK. You can connect to a Room using class methods on this class.

  audioDevice

The TVIAudioDevice used to record and playback audio in a Room.

@property (class, nonatomic, strong, nonnull) id<TVIAudioDevice> audioDevice

Discussion

If you wish to provide your own TVIAudioDevice then you must set it before performing any other actions with the SDK (like creating Tracks or connecting to Rooms). It is also possible to change the device when you are no longer connected to any Rooms and have destroyed all other SDK objects (Tracks, Participants, and Rooms).

See Also

Declared In

TwilioVideo.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Use TwilioVideo class factory methods to create a TVIRoom.

Declared In

TwilioVideo.h

+ connectWithOptions:delegate:

Connect to a Room with options and a delegate.

+ (nonnull TVIRoom *)connectWithOptions:(nonnull TVIConnectOptions *)options delegate:(nullable id<TVIRoomDelegate>)delegate

Parameters

options

The connect options.
delegate

A delegate conforming to TVIRoomDelegate for handling Room related events.

Return Value

An instance of TVIRoom if successful and nil otherwise.

Declared In

TwilioVideo.h

+ version

Returns the SDK version.

+ (nonnull NSString *)version

Return Value

Video sdk version of type string.

Declared In

TwilioVideo.h

+ logLevel

Retrieve the log level for the Twilio Video SDK. The default log level is TVILogLevelError.

+ (TVILogLevel)logLevel

Return Value

The current log level.

Declared In

TwilioVideo.h

+ setLogLevel:

Set the log level for the Twilio Video SDK.

+ (void)setLogLevel:(TVILogLevel)logLevel

Parameters

logLevel

The TVILogLevel in use by the system.

Declared In

TwilioVideo.h

+ logLevelForModule:

Retrieve the log level for a specific module in the Twilio Video SDK.

+ (TVILogLevel)logLevelForModule:(TVILogModule)module

Parameters

module

The TVILogModule for which the log level needs to be set.

Return Value

The current log level for the specified module.

Declared In

TwilioVideo.h

+ setLogLevel:module:

Set the log level for a specific module in the Twilio Video SDK.

+ (void)setLogLevel:(TVILogLevel)logLevel module:(TVILogModule)module

Parameters

logLevel

The TVILogLevel to be used by the module.
module

The TVILogModule for which the log level needs to be set.

Declared In

TwilioVideo.h