TVIEncodingParameters Class Reference

Inherits from NSObject
Declared in TVIEncodingParameters.h

Overview

TVIEncodingParameters defines audio and video encoding parameters.

Maximum bitrate is specified as Transport Independent Application Specific Maximum (TIAS) bitrate RFC3890 in Kilobits per second (Kbps) excluding IP/UDP/TCP headers. These encoding parameters are applied for each PeerConnection. For peer-to-peer Rooms, there is a separate PeerConnection for each participant, i.e., if you set the maximum video bitrate to 1,000 Kbps and you have two TVIRemoteParticipants in the Room, the SDK sends up to 2,000 Kbps. For group Rooms, there is a single PeerConnection to Twilio’s Media Server.

If you are publishing multiple video tracks (e.g., video and screen share), each track receives up to the maximum bitrate specified, i.e., if you set the maximum video bitrate to 1,000 Kbps and you publish both video and screen Tracks, the SDK sends at most 2,000 Kbps. You may update encoding parameters any time using [TVILocalParticipant setEncodingParameters:].

– initWithAudioBitrate:videoBitrate:

Initializes a TVIEncodingParameters object.

- (_Nonnull instancetype)initWithAudioBitrate:(NSUInteger)maxAudioBitrate videoBitrate:(NSUInteger)maxVideoBitrate

Parameters

maxAudioBitrate

The maximum audio send bitrate in Kilobits per second (Kbps).

maxVideoBitrate

The maximum video send bitrate in Kilobits per second (Kbps).

Return Value

A TVIEncodingParameters instance.

Declared In

TVIEncodingParameters.h

  maxAudioBitrate

Maximum audio send bitrate in Kilobits per second.

@property (nonatomic, assign, readonly) NSUInteger maxAudioBitrate

Discussion

Zero indicates the WebRTC default value, which is codec dependent. The maximum bitrate for Opus is 510 Kbps.

Declared In

TVIEncodingParameters.h

  maxVideoBitrate

Maximum video send bitrate in Kilobits per second.

@property (nonatomic, assign, readonly) NSUInteger maxVideoBitrate

Discussion

Zero indicates the WebRTC default value, which is 2000 Kbps.

Declared In

TVIEncodingParameters.h