diff --git a/docs/5.8.0/Blocks/TVIAVAudioSessionConfigurationBlock.html b/docs/5.8.0/Blocks/TVIAVAudioSessionConfigurationBlock.html new file mode 100644 index 00000000..73da6fc3 --- /dev/null +++ b/docs/5.8.0/Blocks/TVIAVAudioSessionConfigurationBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIAVAudioSessionConfigurationBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAVAudioSessionConfigurationBlock Block Reference

+ + +
+ + + + +
Declared inTVIDefaultAudioDevice.h
+ + + + + + + + + + +

Block Definition

+

TVIAVAudioSessionConfigurationBlock

+ + +
+

TVIAVAudioSessionConfigurationBlock allows you to configure AVAudioSession.

+
+ + + +typedef void (^TVIAVAudioSessionConfigurationBlock) (void ) + + + +
+

Discussion

+

TVIAVAudioSessionConfigurationBlock allows you to configure AVAudioSession.

+
+ + + + + + + + + +
+

Declared In

+ TVIDefaultAudioDevice.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIAppScreenSourceOptionsBuilderBlock.html b/docs/5.8.0/Blocks/TVIAppScreenSourceOptionsBuilderBlock.html new file mode 100644 index 00000000..3507d85d --- /dev/null +++ b/docs/5.8.0/Blocks/TVIAppScreenSourceOptionsBuilderBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIAppScreenSourceOptionsBuilderBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAppScreenSourceOptionsBuilderBlock Block Reference

+ + +
+ + + + +
Declared inTVIAppScreenSourceOptions.h
+ + + + + + + + + + +

Block Definition

+

TVIAppScreenSourceOptionsBuilderBlock

+ + +
+

TVIAppScreenSourceOptionsBuilderBlock allows you to construct TVIAppScreenSourceOptions using the builder pattern.

+
+ + + +typedef void (^TVIAppScreenSourceOptionsBuilderBlock) (TVIAppScreenSourceOptionsBuilder *_Nonnull, builder ) + + + +
+

Discussion

+

TVIAppScreenSourceOptionsBuilderBlock allows you to construct TVIAppScreenSourceOptions using the builder pattern.

+
+ + + + + + + + + +
+

Declared In

+ TVIAppScreenSourceOptions.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIAppScreenSourceStartedBlock.html b/docs/5.8.0/Blocks/TVIAppScreenSourceStartedBlock.html new file mode 100644 index 00000000..1e1c4703 --- /dev/null +++ b/docs/5.8.0/Blocks/TVIAppScreenSourceStartedBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIAppScreenSourceStartedBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAppScreenSourceStartedBlock Block Reference

+ + +
+ + + + +
Declared inTVIAppScreenSource.h
+ + + + + + + + + + +

Block Definition

+

TVIAppScreenSourceStartedBlock

+ + +
+

A block called when your request to start a TVIAppScreenSource has completed.

+
+ + + +typedef void (^TVIAppScreenSourceStartedBlock) (NSError *_Nullable, error ) + + + +
+

Discussion

+

A block called when your request to start a TVIAppScreenSource has completed.

+
+ + + + + + + + + +
+

Declared In

+ TVIAppScreenSource.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIAppScreenSourceStoppedBlock.html b/docs/5.8.0/Blocks/TVIAppScreenSourceStoppedBlock.html new file mode 100644 index 00000000..81ad31be --- /dev/null +++ b/docs/5.8.0/Blocks/TVIAppScreenSourceStoppedBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIAppScreenSourceStoppedBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAppScreenSourceStoppedBlock Block Reference

+ + +
+ + + + +
Declared inTVIAppScreenSource.h
+ + + + + + + + + + +

Block Definition

+

TVIAppScreenSourceStoppedBlock

+ + +
+

A block called when your request to stop a TVIAppScreenSource has completed.

+
+ + + +typedef void (^TVIAppScreenSourceStoppedBlock) (NSError *_Nullable, error ) + + + +
+

Discussion

+

A block called when your request to stop a TVIAppScreenSource has completed.

+
+ + + + + + + + + +
+

Declared In

+ TVIAppScreenSource.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIAudioDeviceWorkerBlock.html b/docs/5.8.0/Blocks/TVIAudioDeviceWorkerBlock.html new file mode 100644 index 00000000..b83e85a7 --- /dev/null +++ b/docs/5.8.0/Blocks/TVIAudioDeviceWorkerBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIAudioDeviceWorkerBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioDeviceWorkerBlock Block Reference

+ + +
+ + + + +
Declared inTVIAudioDevice.h
+ + + + + + + + + + +

Block Definition

+

TVIAudioDeviceWorkerBlock

+ + +
+

A block which is executed on the media engine’s worker thread.

+
+ + + +typedef void (^TVIAudioDeviceWorkerBlock) (void ) + + + +
+

Discussion

+

A block which is executed on the media engine’s worker thread.

+
+ + + + + + + + + +
+

Declared In

+ TVIAudioDevice.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIAudioOptionsBuilderBlock.html b/docs/5.8.0/Blocks/TVIAudioOptionsBuilderBlock.html new file mode 100644 index 00000000..b540378f --- /dev/null +++ b/docs/5.8.0/Blocks/TVIAudioOptionsBuilderBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIAudioOptionsBuilderBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioOptionsBuilderBlock Block Reference

+ + +
+ + + + +
Declared inTVIAudioOptions.h
+ + + + + + + + + + +

Block Definition

+

TVIAudioOptionsBuilderBlock

+ + +
+

TVIAudioOptionsBuilderBlock allows you to construct TVIAudioOptions using the builder pattern.

+
+ + + +typedef void (^TVIAudioOptionsBuilderBlock) (TVIAudioOptionsBuilder *_Nonnull, builder ) + + + +
+

Discussion

+

TVIAudioOptionsBuilderBlock allows you to construct TVIAudioOptions using the builder pattern.

+
+ + + + + + + + + +
+

Declared In

+ TVIAudioOptions.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVICameraSourceOptionsBuilderBlock.html b/docs/5.8.0/Blocks/TVICameraSourceOptionsBuilderBlock.html new file mode 100644 index 00000000..f0dfd2c6 --- /dev/null +++ b/docs/5.8.0/Blocks/TVICameraSourceOptionsBuilderBlock.html @@ -0,0 +1,143 @@ + + + + + + TVICameraSourceOptionsBuilderBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceOptionsBuilderBlock Block Reference

+ + +
+ + + + +
Declared inTVICameraSourceOptions.h
+ + + + + + + + + + +

Block Definition

+

TVICameraSourceOptionsBuilderBlock

+ + +
+

TVICameraSourceOptionsBuilderBlock allows you to construct TVICameraSourceOptions using the builder pattern.

+
+ + + +typedef void (^TVICameraSourceOptionsBuilderBlock) (TVICameraSourceOptionsBuilder *_Nonnull, builder ) + + + +
+

Discussion

+

TVICameraSourceOptionsBuilderBlock allows you to construct TVICameraSourceOptions using the builder pattern.

+
+ + + + + + + + + +
+

Declared In

+ TVICameraSourceOptions.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVICameraSourceStartedBlock.html b/docs/5.8.0/Blocks/TVICameraSourceStartedBlock.html new file mode 100644 index 00000000..e0acbe15 --- /dev/null +++ b/docs/5.8.0/Blocks/TVICameraSourceStartedBlock.html @@ -0,0 +1,143 @@ + + + + + + TVICameraSourceStartedBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceStartedBlock Block Reference

+ + +
+ + + + +
Declared inTVICameraSource.h
+ + + + + + + + + + +

Block Definition

+

TVICameraSourceStartedBlock

+ + +
+

A block called when your request to start, or reconfigure a TVICameraSource has completed.

+
+ + + +typedef void (^TVICameraSourceStartedBlock) (AVCaptureDevice *_Nonnull, device , TVIVideoFormat *_Nonnull, format , NSError *_Nullable, error ) + + + +
+

Discussion

+

A block called when your request to start, or reconfigure a TVICameraSource has completed.

+
+ + + + + + + + + +
+

Declared In

+ TVICameraSource.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVICameraSourceStoppedBlock.html b/docs/5.8.0/Blocks/TVICameraSourceStoppedBlock.html new file mode 100644 index 00000000..ac1e9bfe --- /dev/null +++ b/docs/5.8.0/Blocks/TVICameraSourceStoppedBlock.html @@ -0,0 +1,143 @@ + + + + + + TVICameraSourceStoppedBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceStoppedBlock Block Reference

+ + +
+ + + + +
Declared inTVICameraSource.h
+ + + + + + + + + + +

Block Definition

+

TVICameraSourceStoppedBlock

+ + +
+

A block called when your request to stop a TVICameraSource has completed.

+
+ + + +typedef void (^TVICameraSourceStoppedBlock) (NSError *_Nullable, error ) + + + +
+

Discussion

+

A block called when your request to stop a TVICameraSource has completed.

+
+ + + + + + + + + +
+

Declared In

+ TVICameraSource.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIConnectOptionsBuilderBlock.html b/docs/5.8.0/Blocks/TVIConnectOptionsBuilderBlock.html new file mode 100644 index 00000000..ebaec11e --- /dev/null +++ b/docs/5.8.0/Blocks/TVIConnectOptionsBuilderBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIConnectOptionsBuilderBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIConnectOptionsBuilderBlock Block Reference

+ + +
+ + + + +
Declared inTVIConnectOptions.h
+ + + + + + + + + + +

Block Definition

+

TVIConnectOptionsBuilderBlock

+ + +
+

TVIConnectOptionsBuilderBlock allows you to construct TVIConnectOptions using the builder pattern.

+
+ + + +typedef void (^TVIConnectOptionsBuilderBlock) (TVIConnectOptionsBuilder *_Nonnull, builder ) + + + +
+

Discussion

+

TVIConnectOptionsBuilderBlock allows you to construct TVIConnectOptions using the builder pattern.

+
+ + + + + + + + + +
+

Declared In

+ TVIConnectOptions.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIDataTrackOptionsBuilderBlock.html b/docs/5.8.0/Blocks/TVIDataTrackOptionsBuilderBlock.html new file mode 100644 index 00000000..0bd898f1 --- /dev/null +++ b/docs/5.8.0/Blocks/TVIDataTrackOptionsBuilderBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIDataTrackOptionsBuilderBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIDataTrackOptionsBuilderBlock Block Reference

+ + +
+ + + + +
Declared inTVIDataTrackOptions.h
+ + + + + + + + + + +

Block Definition

+

TVIDataTrackOptionsBuilderBlock

+ + +
+

TVIDataTrackOptionsBuilderBlock allows you to construct TVIDataTrackOptions using the builder pattern.

+
+ + + +typedef void (^TVIDataTrackOptionsBuilderBlock) (TVIDataTrackOptionsBuilder *_Nonnull, builder ) + + + +
+

Discussion

+

TVIDataTrackOptionsBuilderBlock allows you to construct TVIDataTrackOptions using the builder pattern.

+
+ + + + + + + + + +
+

Declared In

+ TVIDataTrackOptions.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIIceOptionsBuilderBlock.html b/docs/5.8.0/Blocks/TVIIceOptionsBuilderBlock.html new file mode 100644 index 00000000..f58e760e --- /dev/null +++ b/docs/5.8.0/Blocks/TVIIceOptionsBuilderBlock.html @@ -0,0 +1,138 @@ + + + + + + TVIIceOptionsBuilderBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIIceOptionsBuilderBlock Block Reference

+ + +
+ + + + +
Declared inTVIIceOptions.h
+ + + + + + + + + + +

Block Definition

+

TVIIceOptionsBuilderBlock

+ + +
+

TVIIceOptionsBuilderBlock is a block to configure ICE options.

+
+ + + +typedef void (^TVIIceOptionsBuilderBlock) (TVIIceOptionsBuilder *_Nonnull, builder ) + + + + + + + + + + + +
+

Declared In

+ TVIIceOptions.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIRoomGetStatsBlock.html b/docs/5.8.0/Blocks/TVIRoomGetStatsBlock.html new file mode 100644 index 00000000..0686788b --- /dev/null +++ b/docs/5.8.0/Blocks/TVIRoomGetStatsBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIRoomGetStatsBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRoomGetStatsBlock Block Reference

+ + +
+ + + + +
Declared inTVIRoom.h
+ + + + + + + + + + +

Block Definition

+

TVIRoomGetStatsBlock

+ + +
+

TVIRoomGetStatsBlock is invoked asynchronously when the results of the TVIRoom getStatsWithBlock: method are available.

+
+ + + +typedef void (^TVIRoomGetStatsBlock) (NSArray <, TVIStatsReport *>, * _Nonnull, statsReports ) + + + +
+

Discussion

+

TVIRoomGetStatsBlock is invoked asynchronously when the results of the TVIRoom getStatsWithBlock: method are available.

+
+ + + + + + + + + +
+

Declared In

+ TVIRoom.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIVideoBandwidthProfileOptionsBuilderBlock.html b/docs/5.8.0/Blocks/TVIVideoBandwidthProfileOptionsBuilderBlock.html new file mode 100644 index 00000000..491d4ca1 --- /dev/null +++ b/docs/5.8.0/Blocks/TVIVideoBandwidthProfileOptionsBuilderBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIVideoBandwidthProfileOptionsBuilderBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoBandwidthProfileOptionsBuilderBlock Block Reference

+ + +
+ + + + +
Declared inTVIVideoBandwidthProfileOptions.h
+ + + + + + + + + + +

Block Definition

+

TVIVideoBandwidthProfileOptionsBuilderBlock

+ + +
+

TVIVideoBandwidthProfileOptionsBuilderBlock allows you to construct TVIVideoBandwidthProfileOptions using the builder pattern.

+
+ + + +typedef void (^TVIVideoBandwidthProfileOptionsBuilderBlock) (TVIVideoBandwidthProfileOptionsBuilder *_Nonnull, builder ) + + + +
+

Discussion

+

TVIVideoBandwidthProfileOptionsBuilderBlock allows you to construct TVIVideoBandwidthProfileOptions using the builder pattern.

+
+ + + + + + + + + +
+

Declared In

+ TVIVideoBandwidthProfileOptions.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Blocks/TVIVideoContentPreferencesBuilderBlock.html b/docs/5.8.0/Blocks/TVIVideoContentPreferencesBuilderBlock.html new file mode 100644 index 00000000..e2ed2686 --- /dev/null +++ b/docs/5.8.0/Blocks/TVIVideoContentPreferencesBuilderBlock.html @@ -0,0 +1,143 @@ + + + + + + TVIVideoContentPreferencesBuilderBlock Block Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoContentPreferencesBuilderBlock Block Reference

+ + +
+ + + + +
Declared inTVIVideoContentPreferences.h
+ + + + + + + + + + +

Block Definition

+

TVIVideoContentPreferencesBuilderBlock

+ + +
+

TVIVideoContentPreferencesBuilderBlock allows you to construct TVIVideoContentPreferences using the builder pattern.

+
+ + + +typedef void (^TVIVideoContentPreferencesBuilderBlock) (TVIVideoContentPreferencesBuilder *_Nonnull, builder ) + + + +
+

Discussion

+

TVIVideoContentPreferencesBuilderBlock allows you to construct TVIVideoContentPreferences using the builder pattern.

+
+ + + + + + + + + +
+

Declared In

+ TVIVideoContentPreferences.h
+
+ + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Categories/TVICameraSource+AVCaptureDeviceControl.html b/docs/5.8.0/Categories/TVICameraSource+AVCaptureDeviceControl.html new file mode 100644 index 00000000..8ac10b79 --- /dev/null +++ b/docs/5.8.0/Categories/TVICameraSource+AVCaptureDeviceControl.html @@ -0,0 +1,311 @@ + + + + + + TVICameraSource(AVCaptureDeviceControl) Category Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSource(AVCaptureDeviceControl) Category Reference

+ + +
+ + + + +
Declared inTVICameraSource.h
+ + + + +
+ +

Overview

+

Methods to safely control some AVCaptureDevice features.

+
+ + + + + +
+ + + + + + +
+
+ +

  torchLevel +

+ +
+
+ +
+ + +
+

The torch level to use for the capture device. Throws an NSInvalidArgumentException if setting the +torch level is not supported by the currently selected device. Defaults to 0.

+
+ + + +
@property (nonatomic, assign) float torchLevel
+ + + + + + + + + +
+

Discussion

+

You should only set the torch level while using AVCaptureTorchModeOn.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

  torchMode +

+ +
+
+ +
+ + +
+

The torch mode to use for the capture device. Throws an NSInvalidArgumentException if the +torch mode is not supported by the currently selected device. Defaults to AVCaptureTorchModeOff.

+
+ + + +
@property (nonatomic, assign) AVCaptureTorchMode torchMode
+ + + + + + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

  zoomFactor +

+ +
+
+ +
+ + +
+

The zoom factor to use for the capture device. Throws an NSInvalidArgumentException if the +zoom factor is not supported by the currently selected device. Defaults to TVICameraSourceOptions.zoomFactor.

+
+ + + +
@property (nonatomic, assign) CGFloat zoomFactor
+ + + + + + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Categories/TVIConnectOptions+CallKit.html b/docs/5.8.0/Categories/TVIConnectOptions+CallKit.html new file mode 100644 index 00000000..33dc74cd --- /dev/null +++ b/docs/5.8.0/Categories/TVIConnectOptions+CallKit.html @@ -0,0 +1,197 @@ + + + + + + TVIConnectOptions(CallKit) Category Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIConnectOptions(CallKit) Category Reference

+ + +
+ + + + +
Declared inTVIConnectOptions.h
+ + + + +
+ +

Overview

+

CallKit specific additions.

+
+ + + + + +
+ + + + + + +
+
+ +

  uuid +

+ +
+
+ +
+ + +
+

The CallKit identifier for the Room.

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

Discussion

+

This property allows you to provide your CallKit UUID as part of TVIConnectOptions. This is offered +as a convenience if you wish to use TVIRoom for CallKit book keeping. The UUID set here will be reflected on any +TVIRoom instance created with these options.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Categories/TVIConnectOptionsBuilder+CallKit.html b/docs/5.8.0/Categories/TVIConnectOptionsBuilder+CallKit.html new file mode 100644 index 00000000..0c9a4dea --- /dev/null +++ b/docs/5.8.0/Categories/TVIConnectOptionsBuilder+CallKit.html @@ -0,0 +1,197 @@ + + + + + + TVIConnectOptionsBuilder(CallKit) Category Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIConnectOptionsBuilder(CallKit) Category Reference

+ + +
+ + + + +
Declared inTVIConnectOptions.h
+ + + + +
+ +

Overview

+

CallKit specific additions.

+
+ + + + + +
+ + + + + + +
+
+ +

  uuid +

+ +
+
+ +
+ + +
+

The CallKit identifier for the Room.

+
+ + + +
@property (nonatomic, strong, nullable) NSUUID *uuid
+ + + + + + + + + +
+

Discussion

+

This property allows you to provide your CallKit UUID as part of TVIConnectOptions. This is offered +as a convenience if you wish to use TVIRoom for CallKit book keeping. The UUID set here will be reflected on any +TVIRoom instance created with these options.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Categories/TVIRoom+CallKit.html b/docs/5.8.0/Categories/TVIRoom+CallKit.html new file mode 100644 index 00000000..fa171786 --- /dev/null +++ b/docs/5.8.0/Categories/TVIRoom+CallKit.html @@ -0,0 +1,195 @@ + + + + + + TVIRoom(CallKit) Category Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRoom(CallKit) Category Reference

+ + +
+ + + + +
Declared inTVIRoom.h
+ + + + +
+ +

Overview

+

CallKit specific additions.

+
+ + + + + +
+ + + + + + +
+
+ +

  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

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAppScreenSource.html b/docs/5.8.0/Classes/TVIAppScreenSource.html new file mode 100644 index 00000000..89d48772 --- /dev/null +++ b/docs/5.8.0/Classes/TVIAppScreenSource.html @@ -0,0 +1,731 @@ + + + + + + TVIAppScreenSource Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAppScreenSource Class Reference

+ + +
+ + + + + + + + + + +
Inherits fromNSObject
Conforms toTVIVideoSource
Declared inTVIAppScreenSource.h
+ + + + +
+ +

Overview

+

TVIAppScreenSource is a TVIVideoSource that allows you to stream video of the app screen. This +class manages a RPScreenRecorder internally.

+
+ + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initializes a TVIAppScreenSource with default options. You may set a delegate later if you wish.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + +
+

Return Value

+

A TVIAppScreenSource, or nil if one could not be created.

+
+ + + + + +
+

Discussion

+

When running on the simulator nil will be returned.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– initWithDelegate: +

+ +
+
+ +
+ + +
+

Initializes a TVIAppScreenSource with a delegate and default options.

+
+ + + +
- (nullable instancetype)initWithDelegate:(nullable id<TVIAppScreenSourceDelegate>)delegate
+ + + +
+

Parameters

+ + + + + + + +
delegate

A delegate conforming to TVIAppScreenSourceDelegate, or nil.

+
+ + + +
+

Return Value

+

A TVIAppScreenSource, or nil if one could not be created.

+
+ + + + + +
+

Discussion

+

When running on the simulator nil will be returned. The delegate is called on the main queue.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– initWithOptions:delegate: +

+ +
+
+ +
+ + +
+

Initializes a TVIAppScreenSource with all configuration options.

+
+ + + +
- (nullable instancetype)initWithOptions:(nonnull TVIAppScreenSourceOptions *)options delegate:(nullable id<TVIAppScreenSourceDelegate>)delegate
+ + + +
+

Parameters

+ + + + + + + + + + + + +
options

A TVIAppScreenSourceOptions instance to configure your source.

delegate

A delegate conforming to TVIAppScreenSourceDelegate, or nil.

+
+ + + +
+

Return Value

+

A TVIAppScreenSource, or nil if one could not be created.

+
+ + + + + +
+

Discussion

+

When running on the simulator nil will be returned. The delegate is called on the main queue.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

The source’s delegate.

+
+ + + +
@property (nonatomic, weak, nullable) id<TVIAppScreenSourceDelegate> delegate
+ + + + + + + + + +
+

Discussion

+

The delegate is called on the main queue.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

  isAvailable +

+ +
+
+ +
+ + +
+

Indicates whether the screen is available for capture.

+
+ + + +
@property (nonatomic, readonly) BOOL isAvailable
+ + + + + + + + + +
+

Discussion

+

When set to YES, the screen is available for capture. Screen capture can be unavailable due to unsupported +hardware, the user’s device displaying information over AirPlay or through a TVOut session, or another app using ReplayKit.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

  isCapturing +

+ +
+
+ +
+ + +
+

Indicates whether the screen is being captured.

+
+ + + +
@property (nonatomic, readonly) BOOL isCapturing
+ + + + + + + + + +
+

Discussion

+

When set to YES, the screen is being captured.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– startCapture +

+ +
+
+ +
+ + +
+

Starts capture. The video pipeline will start asynchronously after this method returns.

+
+ + + +
- (void)startCapture
+ + + + + + + + + +
+

Discussion

+

The system will lock screen orientation during screen capture. When you are done capturing video using the TVIAppScreenSource +you must call either [TVIAppScreenSource stopCapture] or [TVIAppScreenSource stopCaptureWithCompletion:].

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– startCaptureWithCompletion: +

+ +
+
+ +
+ + +
+

Starts capture with a completion handler.

+
+ + + +
- (void)startCaptureWithCompletion:(nullable TVIAppScreenSourceStartedBlock)completion
+ + + +
+

Parameters

+ + + + + + + +
completion

A handler block to be called on the main queue once capture has started, or failed to start.

+
+ + + + + + + +
+

Discussion

+

The system will lock screen orientation during screen capture. When you are done capturing video using the TVIAppScreenSource +you must call either [TVIAppScreenSource stopCapture] or [TVIAppScreenSource stopCaptureWithCompletion:].

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– stopCapture +

+ +
+
+ +
+ + +
+

Stops capture asynchronously.

+
+ + + +
- (void)stopCapture
+ + + + + + + + + +
+

Discussion

+

This method is equivalent to calling [TVIAppScreenSource stopCaptureWithCompletion:] with a nil block.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– stopCaptureWithCompletion: +

+ +
+
+ +
+ + +
+

Stops capture asynchronously with a completion handler.

+
+ + + +
- (void)stopCaptureWithCompletion:(nullable TVIAppScreenSourceStoppedBlock)completion
+ + + +
+

Parameters

+ + + + + + + +
completion

A handler block to be called on the main queue once the RPScreenRecorder is stopped.

+
+ + + + + + + +
+

Discussion

+

Use this method to coordinate your application logic with the stopping of the source’s video pipeline.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAppScreenSourceOptions.html b/docs/5.8.0/Classes/TVIAppScreenSourceOptions.html new file mode 100644 index 00000000..3c9af65e --- /dev/null +++ b/docs/5.8.0/Classes/TVIAppScreenSourceOptions.html @@ -0,0 +1,314 @@ + + + + + + TVIAppScreenSourceOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAppScreenSourceOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIAppScreenSourceOptions.h
+ + + + +
+ +

Overview

+

Represents immutable configuration options for a TVIAppScreenSource.

+
+ + + + + +
+ + + + + + +
+
+ +

  screenContent +

+ +
+
+ +
+ + +
+

How TVIAppScreenSource should optimize the video format. Defaults to TVIScreenContentDefault.

+
+ + + +
@property (nonatomic, readonly) TVIScreenContent screenContent
+ + + + + + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIAppScreenSourceOptions.h

+
+ + +
+
+
+ +

+ options +

+ +
+
+ +
+ + +
+

Creates default options.

+
+ + + +
+ (nonnull instancetype)options
+ + + + + +
+

Return Value

+

An instance of TVIAppScreenSourceOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIAppScreenSourceOptions.h

+
+ + +
+
+
+ +

+ optionsWithBlock: +

+ +
+
+ +
+ + +
+

Creates an instance of TVIAppScreenSourceOptions using a builder block.

+
+ + + +
+ (nonnull instancetype)optionsWithBlock:(nonnull TVIAppScreenSourceOptionsBuilderBlock)block
+ + + +
+

Parameters

+ + + + + + + +
block

The builder block which will be used to configure the TVIAppScreenSourceOptions instance.

+
+ + + +
+

Return Value

+

An instance of TVIAppScreenSourceOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIAppScreenSourceOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAppScreenSourceOptionsBuilder.html b/docs/5.8.0/Classes/TVIAppScreenSourceOptionsBuilder.html new file mode 100644 index 00000000..36ddfb9b --- /dev/null +++ b/docs/5.8.0/Classes/TVIAppScreenSourceOptionsBuilder.html @@ -0,0 +1,249 @@ + + + + + + TVIAppScreenSourceOptionsBuilder Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAppScreenSourceOptionsBuilder Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIAppScreenSourceOptions.h
+ + + + +
+ +

Overview

+

TVIAppScreenSourceOptionsBuilder is a builder class for TVIAppScreenSourceOptions.

+
+ + + + + +
+ + + + + + +
+
+ +

  screenContent +

+ +
+
+ +
+ + +
+

How TVIAppScreenSource should optimize the video format.

+
+ + + +
@property (nonatomic) TVIScreenContent screenContent
+ + + + + + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIAppScreenSourceOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

You should not initialize TVIAppScreenSourceOptionsBuilder directly, use a TVIAppScreenSourceOptionsBuilderBlock instead.

+
+ + + +
- (nonnull instancetype)init
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAppScreenSourceOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAudioCodec.html b/docs/5.8.0/Classes/TVIAudioCodec.html new file mode 100644 index 00000000..abaa2e8b --- /dev/null +++ b/docs/5.8.0/Classes/TVIAudioCodec.html @@ -0,0 +1,245 @@ + + + + + + TVIAudioCodec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioCodec Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIAudioCodec.h
+ + + + +
+ +

Overview

+

TVIAudioCodec is the base class for all supported audio codecs.

+
+ + + + + +
+ + + + + + +
+
+ +

  name +

+ +
+
+ +
+ + +
+

The name of the audio codec.

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

Declared In

+

TVIAudioCodec.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

TVIAudioCodec can not be created with init. To use an audio codec, use one of the TVIAudioCodec subclasses.

+
+ + + + + + + +
+

Declared In

+

TVIAudioCodec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAudioFormat.html b/docs/5.8.0/Classes/TVIAudioFormat.html new file mode 100644 index 00000000..9f596939 --- /dev/null +++ b/docs/5.8.0/Classes/TVIAudioFormat.html @@ -0,0 +1,545 @@ + + + + + + TVIAudioFormat Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioFormat Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIAudioFormat.h
+ + + + +
+ +

Overview

+

TVIAudioFormat describes audio that is captured or rendered via a TVIAudioDevice. The class also offers +convenience methods to help interoperate with CoreAudio and size your audio buffers appropriately.

+
+ + + + + +
+ + + + + + +
+
+ +

  numberOfChannels +

+ +
+
+ +
+ + +
+

The number of channels in the audio stream.

+
+ + + +
@property (nonatomic, assign, readonly) size_t numberOfChannels
+ + + + + + + + + +
+

Discussion

+

Valid values for this property are either 1 or 2. Only mono and stereo LPCM audio are supported.

+
+ + + + + + + +
+

Declared In

+

TVIAudioFormat.h

+
+ + +
+
+
+ +

  sampleRate +

+ +
+
+ +
+ + +
+

The sample rate of the audio stream in units of frequency (Hz), i.e. the number of audio samples per second.

+
+ + + +
@property (nonatomic, assign, readonly) uint32_t sampleRate
+ + + + + + + + + +
+

Discussion

+

Valid values for this property are 8000, 16000, 24000, 32000, 44100 and 48000 Hz.

+
+ + + + + + + +
+

Declared In

+

TVIAudioFormat.h

+
+ + +
+
+
+ +

  framesPerBuffer +

+ +
+
+ +
+ + +
+

The maximum number of frames contained in a single audio buffer.

+
+ + + +
@property (nonatomic, assign, readonly) size_t framesPerBuffer
+ + + + + + + + + +
+

Discussion

+

The underlying media engine operates on 10 millisecond slices of LPCM audio. Ideally, your audio device +should capture and render in exactly 10 millisecond buffers. However, in many cases this is not possible on iOS. +If you’re using AudioUnits to produce or consume audio you should use AVAudioSession.preferredIOBufferDuration +to request appropriately sized buffers.

+
+ + + + + + + +
+

Declared In

+

TVIAudioFormat.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t use init to create TVIAudioFormat.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use initWithChannels:sampleRate:framesPerBuffer: instead.

+
+ + + + + + + +
+

Declared In

+

TVIAudioFormat.h

+
+ + +
+
+
+ +

– initWithChannels:sampleRate:framesPerBuffer: +

+ +
+
+ +
+ + +
+

Initializes an instance of TVIAudioFormat.

+
+ + + +
- (nullable instancetype)initWithChannels:(size_t)channels sampleRate:(uint32_t)sampleRate framesPerBuffer:(size_t)framesPerBuffer
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
channels

The number of channels in the audio stream.

sampleRate

The sample rate of the audio stream.

framesPerBuffer

The maximum number of frames contained in a single audio stream buffer.

+
+ + + +
+

Return Value

+

An instance of TVIAudioFormat, which is immutable once created. Returns nil if one or more parameters +passed to the initializer are not supported by the SDK.

+
+ + + + + +
+

Discussion

+

TVIAudioFormat describes signed 16-bit LPCM audio. This is the working format used to interoperate +between TVIAudioDevice and the underlying media engine. Please note that the media engine may be forced to perform +a format conversion depending on the codecs used for sending and receiving audio. For example, ISAC accepts mono +32 kHz audio while OPUS accepts mono or stereo at 48 kHz.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIAudioFormat.h

+
+ + +
+
+
+ +

– bufferSize +

+ +
+
+ +
+ + +
+

Computes the required buffer size for a given audio format.

+
+ + + +
- (size_t)bufferSize
+ + + + + +
+

Return Value

+

The required buffer size, in bytes, to work with a given TVIAudioFormat.

+
+ + + + + +
+

Discussion

+

This helper method can be used to size audio buffers appropriately.

+
+ + + + + + + +
+

Declared In

+

TVIAudioFormat.h

+
+ + +
+
+
+ +

– streamDescription +

+ +
+
+ +
+ + +
+

Generates an audio stream description which can be used with CoreAudio.

+
+ + + +
- (AudioStreamBasicDescription)streamDescription
+ + + + + +
+

Return Value

+

An AudioStreamBasicDescription which reflects the properties of the TVIAudioFormat being queried.

+
+ + + + + +
+

Discussion

+

AudioStreamBasicDescription can be used to describe many different constant bitrate audio formats. +Since TVIAudioFormat defines only signed 16-bit LPCM audio there is a well known transformation between the two.

+
+ + + + + + + +
+

Declared In

+

TVIAudioFormat.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAudioOptions.html b/docs/5.8.0/Classes/TVIAudioOptions.html new file mode 100644 index 00000000..76161a4f --- /dev/null +++ b/docs/5.8.0/Classes/TVIAudioOptions.html @@ -0,0 +1,443 @@ + + + + + + TVIAudioOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIAudioOptions.h
+ + + + +
+ +

Overview

+

TVIAudioOptions specifies options for TVILocalAudioTrack.

+
+ + + + + +
+ + + + + + +
+
+ +

  audioJitterBufferMaxPackets +

+ +
+
+ +
+ + +
+

Audio receiver jitter buffer (NetEq) max capacity in number of packets. Defaults to 50.

+
+ + + +
@property (nonatomic, assign, readonly) int audioJitterBufferMaxPackets
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

  audioJitterBufferFastAccelerate +

+ +
+
+ +
+ + +
+

Audio receiver jitter buffer (NetEq) fast accelerate mode. Defaults to NO.

+
+ + + +
@property (nonatomic, assign, readonly) BOOL audioJitterBufferFastAccelerate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

  softwareAecEnabled +

+ +
+
+ +
+ + +
+

Enable software Acoustic Echo Cancellation (AEC). Defaults to NO.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isSoftwareAecEnabled) BOOL softwareAecEnabled
+ + + + + + + + + +
+

Discussion

+

TVIDefaultAudioDevice uses Apple’s built-in hardware echo cancellation. If you are having issues with +echo cancellation and TVIDefaultAudioDevice, or you’ve written your own TVIAudioDevice without echo cancellation +you may wish to enable software echo cancellation instead. This API is currently experimental, and we may extend the +TVIAudioDecice’s APIs to work with this property.

+
+ + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

  highpassFilter +

+ +
+
+ +
+ + +
+

Audio processing to remove background noise of lower frequencies. Defaults to YES.

+
+ + + +
@property (nonatomic, assign, readonly) BOOL highpassFilter
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

+ options +

+ +
+
+ +
+ + +
+

Creates default options.

+
+ + + +
+ (null_unspecified instancetype)options
+ + + + + +
+

Return Value

+

An instance of TVIAudioOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

+ optionsWithBlock: +

+ +
+
+ +
+ + +
+

Constructs TVIAudioOptions using the builder pattern.

+
+ + + +
+ (null_unspecified instancetype)optionsWithBlock:(nonnull TVIAudioOptionsBuilderBlock)block
+ + + +
+

Parameters

+ + + + + + + +
block

You can pass audio options to the builder using this block. The builder will construct a +TVIAudioOptions object using the options provided.

+
+ + + +
+

Return Value

+

An instance of TVIAudioOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAudioOptionsBuilder.html b/docs/5.8.0/Classes/TVIAudioOptionsBuilder.html new file mode 100644 index 00000000..1e3a7c10 --- /dev/null +++ b/docs/5.8.0/Classes/TVIAudioOptionsBuilder.html @@ -0,0 +1,377 @@ + + + + + + TVIAudioOptionsBuilder Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioOptionsBuilder Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIAudioOptions.h
+ + + + +
+ +

Overview

+

TVIAudioOptionsBuilder constructs TVIAudioOptions.

+
+ + + + + +
+ + + + + + +
+
+ +

  audioJitterBufferFastAccelerate +

+ +
+
+ +
+ + +
+

Audio receiver jitter buffer (NetEq) fast accelerate mode. Defaults to NO.

+
+ + + +
@property (nonatomic, assign) BOOL audioJitterBufferFastAccelerate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

  audioJitterBufferMaxPackets +

+ +
+
+ +
+ + +
+

Audio receiver jitter buffer (NetEq) max capacity in number of packets. Defaults to 50.

+
+ + + +
@property (nonatomic, assign) int audioJitterBufferMaxPackets
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

  softwareAecEnabled +

+ +
+
+ +
+ + +
+

Enable software Acoustic Echo Cancellation (AEC). Defaults to NO.

+
+ + + +
@property (nonatomic, assign, getter=isSoftwareAecEnabled) BOOL softwareAecEnabled
+ + + + + + + + + +
+

Discussion

+

TVIDefaultAudioDevice uses Apple’s built-in hardware echo cancellation. If you are having issues with +echo cancellation and TVIDefaultAudioDevice, or you’ve written your own TVIAudioDevice without echo cancellation +you may wish to enable software echo cancellation instead. This API is currently experimental, and we may extend the +TVIAudioDecice’s APIs to work with this property.

+
+ + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

  highpassFilter +

+ +
+
+ +
+ + +
+

Audio processing to remove background noise of lower frequencies. Defaults to YES.

+
+ + + +
@property (nonatomic, assign) BOOL highpassFilter
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

You should not initialize TVIAudioOptionsBuilder directly, use a TVIAudioOptionsBuilderBlock instead.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAudioOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAudioTrack.html b/docs/5.8.0/Classes/TVIAudioTrack.html new file mode 100644 index 00000000..316ac359 --- /dev/null +++ b/docs/5.8.0/Classes/TVIAudioTrack.html @@ -0,0 +1,365 @@ + + + + + + TVIAudioTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVITrack : NSObject
Declared inTVIAudioTrack.h
+ + + + +
+ +

Overview

+

TVIAudioTrack represents a local or remote audio track.

+
+ + + + + +
+ + + + + + +
+
+ +

  sinks +

+ +
+
+ +
+ + +
+

An array of sinks that are currently attached to the TVIAudioTrack.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) NSArray<id<TVIAudioSink> > *sinks
+ + + + + + + + + +
+

Discussion

+

Note: Use the ‘addSink:’ and ‘removeSink:’ methods to manipulate this collection.

+
+ + + + + + + +
+

Declared In

+

TVIAudioTrack.h

+
+ + +
+
+
+ +

– addSink: +

+ +
+
+ +
+ + +
+

Adds a sink to the Track.

+
+ + + +
- (void)addSink:(nonnull id<TVIAudioSink>)sink
+ + + +
+

Parameters

+ + + + + + + +
sink

An object or Swift struct that implements the TVIAudioSink protocol.

+
+ + + + + + + +
+

Discussion

+

Sinks consume raw audio samples for further processing or storage.

+
+ + + + + + + +
+

Declared In

+

TVIAudioTrack.h

+
+ + +
+
+
+ +

– removeSink: +

+ +
+
+ +
+ + +
+

Removes a sink from the Track.

+
+ + + +
- (void)removeSink:(nonnull id<TVIAudioSink>)sink
+ + + +
+

Parameters

+ + + + + + + +
sink

An object or Swift struct that implements the TVIAudioSink protocol.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIAudioTrack.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Tracks cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIAudioTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIAudioTrackPublication.html b/docs/5.8.0/Classes/TVIAudioTrackPublication.html new file mode 100644 index 00000000..de075c4d --- /dev/null +++ b/docs/5.8.0/Classes/TVIAudioTrackPublication.html @@ -0,0 +1,245 @@ + + + + + + TVIAudioTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVITrackPublication : NSObject
Declared inTVIAudioTrackPublication.h
+ + + + +
+ +

Overview

+

TVIAudioTrackPublication contains the mapping between an audio track and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  audioTrack +

+ +
+
+ +
+ + +
+

The audio track associated with the audio track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIAudioTrack *audioTrack
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIAudioTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Published tracks cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVIAudioTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIBandwidthProfileOptions.html b/docs/5.8.0/Classes/TVIBandwidthProfileOptions.html new file mode 100644 index 00000000..2274ba3b --- /dev/null +++ b/docs/5.8.0/Classes/TVIBandwidthProfileOptions.html @@ -0,0 +1,263 @@ + + + + + + TVIBandwidthProfileOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIBandwidthProfileOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIBandwidthProfileOptions.h
+ + + + +
+ +

Overview

+

BandwidthProfileOptions enables you to configure how available bandwidth is shared among the +Tracks in a Group Room.

+
+ + + + + +
+ + + + + + +
+
+ +

  video +

+ +
+
+ +
+ + +
+

Get video options specified in the BandwidthProfileOptions initializer.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) TVIVideoBandwidthProfileOptions *video
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIBandwidthProfileOptions.h

+
+ + +
+
+
+ +

– initWithVideoOptions: +

+ +
+
+ +
+ + +
+

The initializer with video options param.

+
+ + + +
- (nonnull instancetype)initWithVideoOptions:(nonnull TVIVideoBandwidthProfileOptions *)video
+ + + +
+

Parameters

+ + + + + + + +
video

Bandwidth profile options for video.

+
+ + + +
+

Return Value

+

An instance of TVIBandwidthProfileOptions.

+
+ + + + + +
+

Discussion

+

The initializer with video options param.

+
+ + + + + + + +
+

Declared In

+

TVIBandwidthProfileOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIBaseTrackStats.html b/docs/5.8.0/Classes/TVIBaseTrackStats.html new file mode 100644 index 00000000..2f15b693 --- /dev/null +++ b/docs/5.8.0/Classes/TVIBaseTrackStats.html @@ -0,0 +1,417 @@ + + + + + + TVIBaseTrackStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIBaseTrackStats Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIBaseTrackStats.h
+ + + + +
+ +

Overview

+

TVIBaseTrackStats represents stats common to both local and remote tracks.

+
+ + + + + +
+ + + + + + +
+
+ +

  trackSid +

+ +
+
+ +
+ + +
+

The Tracks’s server identifier. This value uniquely identifies the Track within the scope of a Room.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *trackSid
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIBaseTrackStats.h

+
+ + +
+
+
+ +

  packetsLost +

+ +
+
+ +
+ + +
+

Total number of RTP packets lost for this SSRC since the beginning of the reception.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger packetsLost
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIBaseTrackStats.h

+
+ + +
+
+
+ +

  codec +

+ +
+
+ +
+ + +
+

Name of codec used for this track.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *codec
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIBaseTrackStats.h

+
+ + +
+
+
+ +

  ssrc +

+ +
+
+ +
+ + +
+

The SSRC identifier of the source.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *ssrc
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIBaseTrackStats.h

+
+ + +
+
+
+ +

  timestamp +

+ +
+
+ +
+ + +
+

Unix timestamp in milliseconds

+
+ + + +
@property (nonatomic, assign, readonly) CFTimeInterval timestamp
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIBaseTrackStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Base track stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIBaseTrackStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVICameraPreviewView.html b/docs/5.8.0/Classes/TVICameraPreviewView.html new file mode 100644 index 00000000..223f45a8 --- /dev/null +++ b/docs/5.8.0/Classes/TVICameraPreviewView.html @@ -0,0 +1,243 @@ + + + + + + TVICameraPreviewView Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraPreviewView Class Reference

+ + +
+ + + + + + + +
Inherits fromUIView
Declared inTVICameraPreviewView.h
+ + + + +
+ +

Overview

+

TVICameraPreviewView previews video captured by TVICameraCapturer.

This view uses the special preview path offered by AVCaptureVideoPreviewLayer. It offers some benefits +which are not provided by TVIVideoView such as frame accurate mirroring, and graceful support for UIViewContentMode. +The supported content modes are: UIViewContentModeScaleToFill, UIViewContentModeScaleAspectFill, and UIViewContentModeScaleAspectFit.

+
+ + + + + +
+ + + + + + +
+
+ +

  orientation +

+ +
+
+ +
+ + +
+

The orientation of the view’s content. This value is updated by listening to UIApplicationWillChangeStatusBarOrientationNotification.

+
+ + + +
@property (nonatomic, assign, readonly) UIInterfaceOrientation orientation
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVICameraPreviewView.h

+
+ + +
+
+
+ +

  videoDimensions +

+ +
+
+ +
+ + +
+

The dimensions of the preview feed, in the frame of reference specified by the TVICameraPreviewView’s orientation.

+
+ + + +
@property (nonatomic, assign, readonly) CMVideoDimensions videoDimensions
+ + + + + + + + + +
+

Discussion

+

With default constraints the dimensions would be 640x480 in landscape, and 480x640 in portrait.

+
+ + + + + + + +
+

Declared In

+

TVICameraPreviewView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVICameraSource.html b/docs/5.8.0/Classes/TVICameraSource.html new file mode 100644 index 00000000..edd3ccf8 --- /dev/null +++ b/docs/5.8.0/Classes/TVICameraSource.html @@ -0,0 +1,1210 @@ + + + + + + TVICameraSource Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSource Class Reference

+ + +
+ + + + + + + + + + +
Inherits fromNSObject
Conforms toTVIVideoSource
Declared inTVICameraSource.h
+ + + + +
+ +

Overview

+

TVICameraSource is a TVIVideoSource that allows you to preview and stream video from the device cameras. This +class manages an AVCaptureSession internally.

+
+ + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initializes a TVICameraSource with default options. You may set a delegate later if you wish.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + +
+

Return Value

+

A TVICameraSource, or nil if one could not be created.

+
+ + + + + + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– initWithDelegate: +

+ +
+
+ +
+ + +
+

Initializes a TVICameraSource with a delegate, and default options.

+
+ + + +
- (nullable instancetype)initWithDelegate:(nullable id<TVICameraSourceDelegate>)delegate
+ + + +
+

Parameters

+ + + + + + + +
delegate

A delegate conforming to TVICameraSourceDelegate, or nil.

+
+ + + +
+

Return Value

+

A TVICameraSource, or nil if one could not be created.

+
+ + + + + + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– initWithOptions:delegate: +

+ +
+
+ +
+ + +
+

Initializes a TVICameraSource with all configuration options. This is the designated initializer.

+
+ + + +
- (nullable instancetype)initWithOptions:(nonnull TVICameraSourceOptions *)options delegate:(nullable id<TVICameraSourceDelegate>)delegate
+ + + +
+

Parameters

+ + + + + + + + + + + + +
options

A TVICameraSourceOptions instance to configure your source.

delegate

A delegate conforming to TVICameraSourceDelegate, or nil.

+
+ + + +
+

Return Value

+

A TVICameraSource, or nil if one could not be created.

+
+ + + + + + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

The source’s delegate.

+
+ + + +
@property (nonatomic, weak, nullable) id<TVICameraSourceDelegate> delegate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

  device +

+ +
+
+ +
+ + +
+

Returns the device that the source is currently capturing from. This property will be set when invoking +TVICameraSourceStartedBlock, and reset to nil immediately before invoking TVICameraSourceStoppedBlock.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) AVCaptureDevice *device
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

  previewView +

+ +
+
+ +
+ + +
+

A view which allows you to preview the camera source.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVICameraPreviewView *previewView
+ + + + + + + + + +
+

Discussion

+

previewView will be nil unless the source is initialized using +[TVICameraSource initWithOptions:delegate:], while setting TVICameraSourceOptions.enablePreview to YES.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– startCaptureWithDevice: +

+ +
+
+ +
+ + +
+

Starts video capture with a device. The video pipeline will start asynchronously after this method returns.

+
+ + + +
- (void)startCaptureWithDevice:(nonnull AVCaptureDevice *)device
+ + + +
+

Parameters

+ + + + + + + +
device

The AVCaptureDevice which the source should use. Must be non-null.

+
+ + + + + + + +
+

Discussion

+

This method will automatically choose a format that works well with your capture device.

Note: When you are done capturing video using the TVICameraSource you must call either [TVICameraSource stopCapture] +or [TVICameraSource stopCaptureWithCompletion:].

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– startCaptureWithDevice:completion: +

+ +
+
+ +
+ + +
+

Starts video capture with a device and a completion handler.

+
+ + + +
- (void)startCaptureWithDevice:(nonnull AVCaptureDevice *)device completion:(nullable TVICameraSourceStartedBlock)completion
+ + + +
+

Parameters

+ + + + + + + + + + + + +
device

The AVCaptureDevice which the source should use. Must be non-null.

completion

A handler block to be called on the main thread once capture has started, or failed to start.

+
+ + + + + + + +
+

Discussion

+

This method will automatically choose a format that works well with your capture device.

Note: When you are done capturing video using the TVICameraSource you must call either [TVICameraSource stopCapture] +or [TVICameraSource stopCaptureWithCompletion:].

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– startCaptureWithDevice:format:completion: +

+ +
+
+ +
+ + +
+

Starts video capture with a device, format and completion handler.

+
+ + + +
- (void)startCaptureWithDevice:(nonnull AVCaptureDevice *)device format:(nonnull TVIVideoFormat *)format completion:(nullable TVICameraSourceStartedBlock)completion
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
device

The AVCaptureDevice which the source should use. Must be non-null.

format

The TVIVideoFormat which the source should use. Must be non-null.

completion

A handler block to be called on the main thread once capture has started, or failed to start.

+
+ + + + + + + +
+

Discussion

+

Use this method if you have a specific capture device and format in mind for your use case.

Note: When you are done capturing video using the TVICameraSource you must call either [TVICameraSource stopCapture] +or [TVICameraSource stopCaptureWithCompletion:].

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– stopCapture +

+ +
+
+ +
+ + +
+

Stops capture asynchronously.

+
+ + + +
- (void)stopCapture
+ + + + + + + + + +
+

Discussion

+

This method is equivalent to calling [TVICameraSource stopCaptureWithCompletion:] with a nil block.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– stopCaptureWithCompletion: +

+ +
+
+ +
+ + +
+

Stops video capture asynchronously with a completion handler.

+
+ + + +
- (void)stopCaptureWithCompletion:(nullable TVICameraSourceStoppedBlock)completion
+ + + +
+

Parameters

+ + + + + + + +
completion

A handler block to be called on the main thread once the AVCaptureSession is stopped.

+
+ + + + + + + +
+

Discussion

+

Use this method to coordinate your application logic with the stopping of the source’s video pipeline. +If you are managing your own AVCaptureSession, you should be able to use it safely after the handler is called.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– selectCaptureDevice: +

+ +
+
+ +
+ + +
+

Reconfigures the source to capture from a new device. The video pipeline will start asynchronously +after this method returns.

+
+ + + +
- (void)selectCaptureDevice:(nonnull AVCaptureDevice *)device
+ + + +
+

Parameters

+ + + + + + + +
device

The AVCaptureDevice which the source should use. Must be non-null.

+
+ + + + + + + +
+

Discussion

+

This method will automatically choose a format that works well with your capture device.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– selectCaptureDevice:completion: +

+ +
+
+ +
+ + +
+

Reconfigures the source to capture from a new device. The video pipeline will start asynchronously +after this method returns.

+
+ + + +
- (void)selectCaptureDevice:(nonnull AVCaptureDevice *)device completion:(nullable TVICameraSourceStartedBlock)completion
+ + + +
+

Parameters

+ + + + + + + + + + + + +
device

The AVCaptureDevice which the source should use. Must be non-null.

completion

A handler block to be called on the main thread once configuration has completed, or failed.

+
+ + + + + + + +
+

Discussion

+

Use this method if you have a specific capture device and format in mind for your use case.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– selectCaptureDevice:format:completion: +

+ +
+
+ +
+ + +
+

Reconfigures the source to capture from a new device and/or format.

+
+ + + +
- (void)selectCaptureDevice:(nonnull AVCaptureDevice *)device format:(nonnull TVIVideoFormat *)format completion:(nullable TVICameraSourceStartedBlock)completion
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
device

The AVCaptureDevice which the source should use. Must be non-null.

format

The TVIVideoFormat which the source should use. Must be non-null.

completion

A handler block to be called on the main thread once configuration has completed, or failed.

+
+ + + + + + + +
+

Discussion

+

Use this method if you have a specific capture device and format in mind for your use case.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

+ captureDeviceForPosition: +

+ +
+
+ +
+ + +
+

Discover an AVCaptureDevice by position.

+
+ + + +
+ (nullable AVCaptureDevice *)captureDeviceForPosition:(AVCaptureDevicePosition)position
+ + + +
+

Parameters

+ + + + + + + +
position

The position that you want to use, or AVCaptureDevicePositionUnspecified if you don’t care.

+
+ + + +
+

Return Value

+

An AVCaptureDevice of type AVMediaTypeVideo, or nil if one could not be found.

+
+ + + + + +
+

Discussion

+

If you are on an iOS simulator then you should not expect to discover any devices.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

+ captureDeviceForPosition:type: +

+ +
+
+ +
+ + +
+

Discover an AVCaptureDevice by position and type.

+
+ + + +
+ (nullable AVCaptureDevice *)captureDeviceForPosition:(AVCaptureDevicePosition)position type:(nonnull AVCaptureDeviceType)deviceType
+ + + +
+

Parameters

+ + + + + + + + + + + + +
position

The position that you want to use, or AVCaptureDevicePositionUnspecified if you don’t care.

deviceType

An AVCaptureDeviceType to further refine your query.

+
+ + + +
+

Return Value

+

An AVCaptureDevice of type AVMediaTypeVideo, or nil if one could not be found.

+
+ + + + + +
+

Discussion

+

If you are on an iOS simulator then you should not expect to discover any devices. +This method uses AVCaptureDeviceDiscoverySession.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

+ supportedFormatsForDevice: +

+ +
+
+ +
+ + +
+

Determines the formats that are optimal for video streaming from a given AVCaptureDevice.

+
+ + + +
+ (nonnull NSOrderedSet<TVIVideoFormat*> *)supportedFormatsForDevice:(nonnull AVCaptureDevice *)captureDevice
+ + + +
+

Parameters

+ + + + + + + +
captureDevice

The AVCaptureDevice that you want to query.

+
+ + + +
+

Return Value

+

An NSOrderedSet containing zero or more TVIVideoFormat objects ordered by increasing size.

+
+ + + + + +
+

Discussion

+

Use this method in conjunction with [TVICameraSource startCaptureWithDevice:format:completion:] for +fine-grained control over video format selection.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVICameraSourceOptions.html b/docs/5.8.0/Classes/TVICameraSourceOptions.html new file mode 100644 index 00000000..e1879351 --- /dev/null +++ b/docs/5.8.0/Classes/TVICameraSourceOptions.html @@ -0,0 +1,541 @@ + + + + + + TVICameraSourceOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVICameraSourceOptions.h
+ + + + +
+ +

Overview

+

Represents immutable configuration options for a TVICameraSource.

+
+ + + + + +
+ + + + + + +
+
+ +

  orientationTracker +

+ +
+
+ +
+ + +
+

Allows the developer to customize how TVICameraSource tracks video orientation for capture and preview.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) id<TVICameraSourceOrientationTracker> orientationTracker
+ + + + + + + + + +
+

Discussion

+

Defaults to +[TVIUserInterfaceTracker tracker].

+ +

You can also manually control how orientation is tracked. For example, you might decide to use UIDevice instead of UIScene to determine the orientation of video from the camera.

+ +

Note that the video data output connection is configured for the native orientation of the camera sensor. +The connection is set to AVCaptureVideoOrientationLandscapeLeft for front facing devices, and +AVCaptureVideoOrientationLandscapeRight for rear facing devices. For example, if you are holding your iOS device in +AVCaptureVideoOrientationLandscapeLeft (UIDeviceOrientationLandscapeRight) with the front +camera facing towards you, then no rotation is required and the correct tag would be TVIVideoOrientationUp.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

  enablePreview +

+ +
+
+ +
+ + +
+

Enable the use of TVICameraPreviewView to preview video from the camera. Defaults to NO.

+
+ + + +
@property (nonatomic, assign, readonly) BOOL enablePreview
+ + + + + + + + + +
+

Discussion

+

Enable the use of TVICameraPreviewView to preview video from the camera. Defaults to NO.

+
+ + + + + + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

  rotationTags +

+ +
+
+ +
+ + +
+

How TVICameraSource should handle rotation tags. Defaults to TVICameraSourceOptionsRotationTagsKeep.

+
+ + + +
@property (nonatomic, assign, readonly) TVICameraSourceOptionsRotationTags rotationTags
+ + + + + + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

  zoomFactor +

+ +
+
+ +
+ + +
+

The initial zoom factor to use for the capture device. Throws an NSInvalidArgumentException if the +selected zoom factor is not supported by the device. Defaults to 1.0.

+
+ + + +
@property (nonatomic, assign, readonly) CGFloat zoomFactor
+ + + + + + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

  enableCameraMultitasking +

+ +
+
+ +
+ + +
+

Allows the developer to enable support for camera multi tasking. When this is supported by the device, setting this option to true will allow the camera to continue running when the video applicaiton is put in background

+
+ + + +
@property (nonatomic, assign) BOOL enableCameraMultitasking
+ + + + + + + + + +
+

Discussion

+

Only a few apple devices supports this features. Twilio Video SDK will enable this feature by default when possible.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use the class method optionsWithBlock: instead.

+
+ + + + + + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

+ optionsWithBlock: +

+ +
+
+ +
+ + +
+

Creates an instance of TVICameraSourceOptions using a builder block.

+
+ + + +
+ (nonnull instancetype)optionsWithBlock:(nonnull TVICameraSourceOptionsBuilderBlock)block
+ + + +
+

Parameters

+ + + + + + + +
block

The builder block which will be used to configure the TVICameraSourceOptions instance.

+
+ + + +
+

Return Value

+

An instance of TVICameraSourceOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVICameraSourceOptionsBuilder.html b/docs/5.8.0/Classes/TVICameraSourceOptionsBuilder.html new file mode 100644 index 00000000..dbb85160 --- /dev/null +++ b/docs/5.8.0/Classes/TVICameraSourceOptionsBuilder.html @@ -0,0 +1,475 @@ + + + + + + TVICameraSourceOptionsBuilder Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceOptionsBuilder Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVICameraSourceOptions.h
+ + + + +
+ +

Overview

+

TVICameraSourceOptionsBuilder is a builder class for TVICameraSourceOptions.

+
+ + + + + +
+ + + + + + +
+
+ +

  enableCameraMultitasking +

+ +
+
+ +
+ + +
+

Allows the developer to enable support for camera multi tasking. When this is supported by the device, setting this option to true will allow the camera to continue running when the video applicaiton is put in background, or on a splitted view.

+
+ + + +
@property (nonatomic, assign) BOOL enableCameraMultitasking
+ + + + + + + + + +
+

Discussion

+

Only a few apple devices supports this features. Twilio Video SDK will enable this feature by default when possible.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

  orientationTracker +

+ +
+
+ +
+ + +
+

Allows the developer to customize how TVICameraSource tracks video orientation for capture and preview.

+
+ + + +
@property (nonatomic, strong, nonnull) id<TVICameraSourceOrientationTracker> orientationTracker
+ + + + + + + + + +
+

Discussion

+

Defaults to +[TVIUserInterfaceTracker tracker] which monitors -[UIApplication statusBarOrientation].

+ +

When a tracker is created with +[TVIUserInterfaceTracker trackerWithScene:], TVICameraSource monitors for UISceneWillEnterForegroundNotification. +Otherwise, the source monitors for UIApplicationWillEnterForegroundNotification.

+ +

You can also manually control how orientation is tracked. For example, you might decide to use UIDevice instead of UIScene to determine the orientation of the camera.

+ +

Note that the video data output connection is configured for the native orientation of the camera sensor. +The connection is set to AVCaptureVideoOrientationLandscapeLeft for front facing devices, and +AVCaptureVideoOrientationLandscapeRight for rear facing devices. For example, if you are holding your iOS device in +AVCaptureVideoOrientationLandscapeLeft (UIDeviceOrientationLandscapeRight) with the front +camera facing towards you, then no rotation is required and the correct tag would be TVIVideoOrientationUp.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

  enablePreview +

+ +
+
+ +
+ + +
+

Enable the use of TVICameraPreviewView to preview video from the camera. Defaults to NO.

+
+ + + +
@property (nonatomic, assign) BOOL enablePreview
+ + + + + + + + + +
+

Discussion

+

Enable the use of TVICameraPreviewView to preview video from the camera. Defaults to NO.

+
+ + + + + + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

  rotationTags +

+ +
+
+ +
+ + +
+

How TVICameraSource should handle rotation tags. Defaults to TVICameraSourceOptionsRotationTagsKeep.

+
+ + + +
@property (nonatomic, assign) TVICameraSourceOptionsRotationTags rotationTags
+ + + + + + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

  zoomFactor +

+ +
+
+ +
+ + +
+

The initial zoom factor to use for the capture device. Throws an NSInvalidArgumentException if the +selected zoom factor is not supported by the device. Defaults to 1.0.

+
+ + + +
@property (nonatomic, assign) CGFloat zoomFactor
+ + + + + + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

You should not initialize TVICameraSourceOptionsBuilder directly, use a TVICameraSourceOptionsBuilderBlock instead.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIConnectOptions.html b/docs/5.8.0/Classes/TVIConnectOptions.html new file mode 100644 index 00000000..9c88b71d --- /dev/null +++ b/docs/5.8.0/Classes/TVIConnectOptions.html @@ -0,0 +1,1272 @@ + + + + + + TVIConnectOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIConnectOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIConnectOptions.h
+ + + + +
+ +

Overview

+

This configuration overrides what was provided in TVIClientOptions.

+
+ + + + + +
+ + + + + + +
+
+ +

  accessToken +

+ +
+
+ +
+ + +
+

A JWT access token which will be used to join the Room.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *accessToken
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  audioTracks +

+ +
+
+ +
+ + +
+

A collection of local audio tracks which will be shared in the Room.

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

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  automaticSubscriptionEnabled +

+ +
+
+ +
+ + +
+

Enables or disables automatic Track subcription in Group Rooms.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isAutomaticSubscriptionEnabled) BOOL automaticSubscriptionEnabled
+ + + + + + + + + +
+

Discussion

+

By default, your LocalParticipant will subscribe to every RemoteParticipant’s Tracks. You can disable +this by setting automaticSubscriptionEnabled to NO. Note that this does not take effect in Peer-to-Peer (P2P) Rooms, +where the setting is silently ignored.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  dataTracks +

+ +
+
+ +
+ + +
+

A collection of local data tracks which will be shared in the Room.

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

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  delegateQueue +

+ +
+
+ +
+ + +
+

The queue where the Room and associated classes will invoke delegate methods.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) dispatch_queue_t delegateQueue
+ + + + + + + + + +
+

Discussion

+

All delegate methods except for TVIVideoViewDelegate and TVICameraCaptureDelegate +are performed on this queue. Any TVIRoom instance which is created with these options will maintain a +strong reference to the queue until it is destroyed. +The default value of nil indicates that the main dispatch queue will be used.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  dominantSpeakerEnabled +

+ +
+
+ +
+ + +
+

Enables or disables the Dominant Speaker API.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isDominantSpeakerEnabled) BOOL dominantSpeakerEnabled
+ + + + + + + + + +
+

Discussion

+

Set this to YES to enable the Dominant Speaker API when using Group Rooms. This option has no effect +in Peer-to-Peer Rooms. The default value is NO.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  encodingParameters +

+ +
+
+ +
+ + +
+

Encoding parameters to use when sharing media in the Room.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIEncodingParameters *encodingParameters
+ + + + + + + + + +
+

Discussion

+

The default value is nil which indicates that parameters will be chosen by the media engine.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  iceOptions +

+ +
+
+ +
+ + +
+

A custom ICE configuration used to connect to a Room.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIIceOptions *iceOptions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  insightsEnabled +

+ +
+
+ +
+ + +
+

Enables or disables Insights statistics collection.

+
+ + + +
@property (nonatomic, assign, readonly, getter=areInsightsEnabled) BOOL insightsEnabled
+ + + + + + + + + +
+

Discussion

+

The default value is YES. Insights reports metrics about the Media that your Participant +sends and receives in a Room.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  networkQualityEnabled +

+ +
+
+ +
+ + +
+

Enables or disables the Network Quality API.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isNetworkQualityEnabled) BOOL networkQualityEnabled
+ + + + + + + + + +
+

Discussion

+

Set this to YES to enable the Network Quality API when using Group Rooms. This option has no effect +in Peer-to-Peer Rooms. The default value is NO.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  networkPrivacyPolicy +

+ +
+
+ +
+ + +
+

This policy restricts which communication routes can be used to send and receive media with other Participants.

+
+ + + +
@property (nonatomic, assign, readonly) TVILocalNetworkPrivacyPolicy networkPrivacyPolicy
+ + + + + + + + + +
+

Discussion

+

The default value is allowAll on iOS 11-13 and blockLocal on iOS 14 and above.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  networkQualityConfiguration +

+ +
+
+ +
+ + +
+

Sets the verbosity level for network quality information returned by the Network Quality API.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVINetworkQualityConfiguration *networkQualityConfiguration
+ + + + + + + + + +
+

Discussion

+

If a TVINetworkQualityConfiguration is not provided, the default configuration is used: +TVINetworkQualityVerbosityMinimal for the Local Participant and TVINetworkQualityVerbosityNone for the Remote +Participants.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  preferredAudioCodecs +

+ +
+
+ +
+ + +
+

The collection of preferred audio codecs.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVIAudioCodec*> *preferredAudioCodecs
+ + + + + + + + + +
+

Discussion

+

The list specifies which audio codecs will be preferred when negotiating audio between participants. +The preferences are applied in the order found in the list starting with the most preferred audio codec to the +least preferred audio codec. Audio codec preferences are not guaranteed to be satisfied because not all participants +are guaranteed to support all audio codecs. TVIOpusCodec is the default audio codec if no preferences are set.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  preferredVideoCodecs +

+ +
+
+ +
+ + +
+

The collection of preferred video codecs.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVIVideoCodec*> *preferredVideoCodecs
+ + + + + + + + + +
+

Discussion

+

The list specifies which video codecs will be preferred when negotiating video between participants. +The preferences are applied in the order found in the list starting with the most preferred video codec to the +least preferred video codec. Video codec preferences are not guaranteed to be satisfied because not all participants +are guaranteed to support all video codecs. TVIVp8Codec is the default video codec if no preferences are set.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  region +

+ +
+
+ +
+ + +
+

The region that the Client will connect to.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *region
+ + + + + + + + + +
+

Discussion

+

By default, the Client will connect to the nearest signaling Server determined by +latency based routing. +Setting a value other than “gll” bypasses routing and guarantees that signaling traffic will be terminated +in the region that you prefer. If you are connecting to a Group Room created with the “gll” Media Region +(either Ad-Hoc or via the +REST API), then the +Room’s Media Region will be selected based upon your Client’s region. The default value is gll.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  roomName +

+ +
+
+ +
+ + +
+

The name of the Room which you want to connect to.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *roomName
+ + + + + + + + + +
+

Discussion

+

You can provide the name of new or existing Room. The default value of nil indicates that a new Room will be created.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  videoEncodingMode +

+ +
+
+ +
+ + +
+

Specify the VideoEncodingMode. This is a beta API.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) TVIVideoEncodingMode videoEncodingMode
+ + + + + + + + + +
+

Discussion

+

The default value is unset.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  videoTracks +

+ +
+
+ +
+ + +
+

A collection of local video tracks which will be shared in the Room.

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

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  bandwidthProfileOptions +

+ +
+
+ +
+ + +
+

Configure how the available downlink bandwidth is shared among the TVIRemoteVideoTracks you have +subscribed to in a Group or Small-Group Room. This property has no effect in Peer-to-Peer Rooms.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIBandwidthProfileOptions *bandwidthProfileOptions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use the class methods optionsWithToken: or optionsWithToken:block: instead.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

+ optionsWithToken: +

+ +
+
+ +
+ + +
+

Creates TVIConnectOptions using an access token.

+
+ + + +
+ (nonnull instancetype)optionsWithToken:(nonnull NSString *)token
+ + + +
+

Parameters

+ + + + + + + +
token

A JWT access token which will be used to join the Room.

+
+ + + +
+

Return Value

+

An instance of TVIConnectOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

+ optionsWithToken:block: +

+ +
+
+ +
+ + +
+

Creates an instance of TVIConnectOptions using an access token and a builder block.

+
+ + + +
+ (nonnull instancetype)optionsWithToken:(nonnull NSString *)token block:(nonnull TVIConnectOptionsBuilderBlock)block
+ + + +
+

Parameters

+ + + + + + + + + + + + +
token

A JWT access token which will be used to join the Room.

block

The builder block which will be used to configure the TVIConnectOptions instance.

+
+ + + +
+

Return Value

+

An instance of TVIConnectOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIConnectOptionsBuilder.html b/docs/5.8.0/Classes/TVIConnectOptionsBuilder.html new file mode 100644 index 00000000..1cef6091 --- /dev/null +++ b/docs/5.8.0/Classes/TVIConnectOptionsBuilder.html @@ -0,0 +1,1100 @@ + + + + + + TVIConnectOptionsBuilder Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIConnectOptionsBuilder Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIConnectOptions.h
+ + + + +
+ +

Overview

+

TVIConnectOptionsBuilder is a builder class for TVIConnectOptions.

+
+ + + + + +
+ + + + + + +
+
+ +

  audioTracks +

+ +
+
+ +
+ + +
+

A collection of local audio tracks which will be shared in the Room.

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

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  automaticSubscriptionEnabled +

+ +
+
+ +
+ + +
+

Enables or disables automatic Track subcription in Group Rooms.

+
+ + + +
@property (nonatomic, assign, getter=isAutomaticSubscriptionEnabled) BOOL automaticSubscriptionEnabled
+ + + + + + + + + +
+

Discussion

+

By default, your LocalParticipant will subscribe to every RemoteParticipant’s Tracks. You can disable +this by setting automaticSubscriptionEnabled to NO. Note that this does not take effect in Peer-to-Peer (P2P) Rooms, +where the setting is silently ignored.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  dataTracks +

+ +
+
+ +
+ + +
+

A collection of local data tracks which will be shared in the Room.

+
+ + + +
@property (nonatomic, copy, nonnull) NSArray<TVILocalDataTrack*> *dataTracks
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  delegateQueue +

+ +
+
+ +
+ + +
+

The queue where the Room and associated classes will invoke delegate methods.

+
+ + + +
@property (nonatomic, strong, nullable) dispatch_queue_t delegateQueue
+ + + + + + + + + +
+

Discussion

+

All delegate methods except for TVIVideoViewDelegate and TVICameraCaptureDelegate +are performed on this queue. Any TVIRoom instance which is created with these options will maintain a +strong reference to the queue until it is destroyed. +The default value of nil indicates that the main dispatch queue will be used.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  dominantSpeakerEnabled +

+ +
+
+ +
+ + +
+

Enables or disables the Dominant Speaker API.

+
+ + + +
@property (nonatomic, assign, getter=isDominantSpeakerEnabled) BOOL dominantSpeakerEnabled
+ + + + + + + + + +
+

Discussion

+

Set this to YES to enable the Dominant Speaker API when using Group Rooms. This option has no effect +in Peer-to-Peer Rooms. The default value is NO.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  encodingParameters +

+ +
+
+ +
+ + +
+

Encoding parameters to use when sharing media in the Room.

+
+ + + +
@property (nonatomic, strong, nullable) TVIEncodingParameters *encodingParameters
+ + + + + + + + + +
+

Discussion

+

The default value is nil which indicates that parameters will be chosen by the media engine. +Setting both videoEncodingMode and EncodingParameters.maxVideoBitrate is not allowed and will result in an NSInvalidArgumentException.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  iceOptions +

+ +
+
+ +
+ + +
+

A custom ICE configuration used to connect to a Room.

+
+ + + +
@property (nonatomic, strong, nullable) TVIIceOptions *iceOptions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  insightsEnabled +

+ +
+
+ +
+ + +
+

Enables or disables Insights statistics collection.

+
+ + + +
@property (nonatomic, assign, getter=areInsightsEnabled) BOOL insightsEnabled
+ + + + + + + + + +
+

Discussion

+

The default value is YES. Insights reports metrics about the Media that your Participant +sends and receives in a Room.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  networkPrivacyPolicy +

+ +
+
+ +
+ + +
+

This policy restricts which communication routes can be used to send and receive media with other Participants.

+
+ + + +
@property (nonatomic, assign) TVILocalNetworkPrivacyPolicy networkPrivacyPolicy
+ + + + + + + + + +
+

Discussion

+

The default value is allowAll on iOS 11-13 and blockLocal on iOS 14 and above.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  networkQualityEnabled +

+ +
+
+ +
+ + +
+

Enables or disables the Network Quality API.

+
+ + + +
@property (nonatomic, assign, getter=isNetworkQualityEnabled) BOOL networkQualityEnabled
+ + + + + + + + + +
+

Discussion

+

Set this to YES to enable the Network Quality API when using Group Rooms. This option has no effect +in Peer-to-Peer Rooms. The default value is NO.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  networkQualityConfiguration +

+ +
+
+ +
+ + +
+

Sets the verbosity level for network quality information returned by the Network Quality API.

+
+ + + +
@property (nonatomic, strong, nullable) TVINetworkQualityConfiguration *networkQualityConfiguration
+ + + + + + + + + +
+

Discussion

+

If a TVINetworkQualityConfiguration is not provided, the default configuration is used: +TVINetworkQualityVerbosityMinimal for the Local Participant and TVINetworkQualityVerbosityNone for the Remote +Participants.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  preferredAudioCodecs +

+ +
+
+ +
+ + +
+

The collection of preferred audio codecs.

+
+ + + +
@property (nonatomic, copy, nonnull) NSArray<TVIAudioCodec*> *preferredAudioCodecs
+ + + + + + + + + +
+

Discussion

+

The list specifies which audio codecs will be preferred when negotiating audio between participants. +The preferences are applied in the order found in the list starting with the most preferred audio codec to the +least preferred audio codec. Audio codec preferences are not guaranteed to be satisfied because not all participants +are guaranteed to support all audio codecs. TVIOpusCodec is the default audio codec if no preferences are set.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  preferredVideoCodecs +

+ +
+
+ +
+ + +
+

The collection of preferred video codecs.

+
+ + + +
@property (nonatomic, copy, nonnull) NSArray<TVIVideoCodec*> *preferredVideoCodecs
+ + + + + + + + + +
+

Discussion

+

The list specifies which video codecs will be preferred when negotiating video between participants. +The preferences are applied in the order found in the list starting with the most preferred video codec to the +least preferred video codec. Video codec preferences are not guaranteed to be satisfied because not all participants +are guaranteed to support all video codecs. TVIVp8Codec is the default video codec if no preferences are set.

+ +

Setting both videoEncodingMode and preferredVideoCodecs is not allowed and will result in an NSInvalidArgumentException.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  region +

+ +
+
+ +
+ + +
+

The region that the Client will connect to.

+
+ + + +
@property (nonatomic, copy, nonnull) NSString *region
+ + + + + + + + + +
+

Discussion

+

By default, the Client will connect to the nearest signaling Server determined by +latency based routing. +Setting a value other than “gll” bypasses routing and guarantees that signaling traffic will be terminated +in the region that you prefer. If you are connecting to a Group Room created with the “gll” Media Region +(either Ad-Hoc or via the +REST API), then the +Room’s Media Region will be selected based upon your Client’s region. The default value is gll.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  roomName +

+ +
+
+ +
+ + +
+

The name of the Room which you want to connect to.

+
+ + + +
@property (nonatomic, copy, nullable) NSString *roomName
+ + + + + + + + + +
+

Discussion

+

You can provide the name of new or existing Room. The default value of nil indicates that a new Room will be created.

+
+ + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  videoEncodingMode +

+ +
+
+ +
+ + +
+

Specify the VideoEncodingMode. This is a beta API.

+
+ + + +
@property (nonatomic, copy, nullable) TVIVideoEncodingMode videoEncodingMode
+ + + + + + + + + +
+

Discussion

+

The default value is unset. +Attempting to set videoEncodingMode while either EncodingParameters.maxVideoBitrate or preferredVideoCodecs +is set will result in an NSInvalidArgumentException being thrown.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  videoTracks +

+ +
+
+ +
+ + +
+

A collection of local video tracks which will be shared in the Room.

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

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

  bandwidthProfileOptions +

+ +
+
+ +
+ + +
+

Configure how the available downlink bandwidth is shared among the TVIRemoteVideoTracks you have +subscribed to in a Group or Small-Group Room. This property has no effect in Peer-to-Peer Rooms.

+
+ + + +
@property (nonatomic, strong, nullable) TVIBandwidthProfileOptions *bandwidthProfileOptions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

You should not initialize TVIConnectOptionsBuilder directly, use a TVIConnectOptionsBuilderBlock instead.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIConnectOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIDataTrack.html b/docs/5.8.0/Classes/TVIDataTrack.html new file mode 100644 index 00000000..00b23c9f --- /dev/null +++ b/docs/5.8.0/Classes/TVIDataTrack.html @@ -0,0 +1,374 @@ + + + + + + TVIDataTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIDataTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVITrack : NSObject
Declared inTVIDataTrack.h
+ + + + +
+ +

Overview

+

TVIDataTrack represents a local or remote data track.

+
+ + + + + +
+ + + + + + +
+
+ +

  reliable +

+ +
+
+ +
+ + +
+

Returns YES if the data track guarantees reliable transmission of messages.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isReliable) BOOL reliable
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrack.h

+
+ + +
+
+
+ +

  ordered +

+ +
+
+ +
+ + +
+

Returns YES if data track guarantees in-order delivery of messages.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isOrdered) BOOL ordered
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrack.h

+
+ + +
+
+
+ +

  maxPacketLifeTime +

+ +
+
+ +
+ + +
+

Returns the maximum period of time in milliseconds in which retransmissions will be sent.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger maxPacketLifeTime
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrack.h

+
+ + +
+
+
+ +

  maxRetransmits +

+ +
+
+ +
+ + +
+

Returns the maximum number of times to transmit a message before giving up.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger maxRetransmits
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrack.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Tracks cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIDataTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIDataTrackOptions.html b/docs/5.8.0/Classes/TVIDataTrackOptions.html new file mode 100644 index 00000000..33480dd5 --- /dev/null +++ b/docs/5.8.0/Classes/TVIDataTrackOptions.html @@ -0,0 +1,442 @@ + + + + + + TVIDataTrackOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIDataTrackOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIDataTrackOptions.h
+ + + + +
+ +

Overview

+

TVIDataTrackOptions specifies options for TVILocalDataTrack.

+
+ + + + + +
+ + + + + + +
+
+ +

  ordered +

+ +
+
+ +
+ + +
+

Ordered transmission of messages. Defaults to YES.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isOrdered) BOOL ordered
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

  maxPacketLifeTime +

+ +
+
+ +
+ + +
+

Maximum retransmit time in milliseconds.

+
+ + + +
@property (nonatomic, assign, readonly) int maxPacketLifeTime
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

  maxRetransmits +

+ +
+
+ +
+ + +
+

Maximum number of retransmitted messages.

+
+ + + +
@property (nonatomic, assign, readonly) int maxRetransmits
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

  name +

+ +
+
+ +
+ + +
+

The name for the Track.

+
+ + + +
@property (nonatomic, nullable, copy, readonly) NSString *name
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

+ options +

+ +
+
+ +
+ + +
+

Creates default options.

+
+ + + +
+ (null_unspecified instancetype)options
+ + + + + +
+

Return Value

+

An instance of TVIDataTrackOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

+ optionsWithBlock: +

+ +
+
+ +
+ + +
+

Constructs TVIDataTrackOptions using the builder pattern.

+
+ + + +
+ (null_unspecified instancetype)optionsWithBlock:(nonnull TVIDataTrackOptionsBuilderBlock)block
+ + + +
+

Parameters

+ + + + + + + +
block

You can pass data track options to the builder using this block. The builder will construct a +TVIDataTrackOptions object using the options provided.

+
+ + + +
+

Return Value

+

An instance of TVIDataTrackOptions.

+
+ + + + + +
+

Discussion

+

If both maxPacketLifeTime and maxRetransmits are set to non default values, or if +maxPacketLifeTime or maxRetransmits are set to an out of range value, an NSInvalidArgumentException will +be thrown.

+
+ + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIDataTrackOptionsBuilder.html b/docs/5.8.0/Classes/TVIDataTrackOptionsBuilder.html new file mode 100644 index 00000000..2d979e24 --- /dev/null +++ b/docs/5.8.0/Classes/TVIDataTrackOptionsBuilder.html @@ -0,0 +1,383 @@ + + + + + + TVIDataTrackOptionsBuilder Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIDataTrackOptionsBuilder Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIDataTrackOptions.h
+ + + + +
+ +

Overview

+

TVIDataTrackOptionsBuilder constructs TVIDataTrackOptionsBuilder.

+
+ + + + + +
+ + + + + + +
+
+ +

  ordered +

+ +
+
+ +
+ + +
+

Ordered transmission of messages. Defaults to YES.

+
+ + + +
@property (nonatomic, assign, getter=isOrdered) BOOL ordered
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

  maxPacketLifeTime +

+ +
+
+ +
+ + +
+

Maximum retransmit time in milliseconds. Default value is kTVIDataTrackOptionsDefaultMaxPacketLifeTime.

+
+ + + +
@property (nonatomic, assign) int maxPacketLifeTime
+ + + + + + + + + +
+

Discussion

+

maxPacketLifeTime and maxRetransmits are mutually exclusive. This means that only one of these +values can be set to a non default value at a time. Valid values are kTVIDataTrackOptionsDefaultMaxPacketLifeTime +and 0..UINT16_MAX.

+
+ + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

  maxRetransmits +

+ +
+
+ +
+ + +
+

Maximum number of retransmitted messages. Default value is kTVIDataTrackOptionsDefaultMaxRetransmits.

+
+ + + +
@property (nonatomic, assign) int maxRetransmits
+ + + + + + + + + +
+

Discussion

+

maxRetransmits and maxPacketLifeTime are mutually exclusive. This means that only one of these +values can be set to a non default value at a time. Valid values are kTVIDataTrackOptionsDefaultMaxRetransmits +and 0..UINT16_MAX.

+
+ + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

  name +

+ +
+
+ +
+ + +
+

The name for the Track.

+
+ + + +
@property (nonatomic, nullable, copy) NSString *name
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

You should not initialize TVIDataTrackOptionsBuilder directly, use a TVIDataTrackOptionsBuilderBlock instead.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrackOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIDataTrackPublication.html b/docs/5.8.0/Classes/TVIDataTrackPublication.html new file mode 100644 index 00000000..5da81453 --- /dev/null +++ b/docs/5.8.0/Classes/TVIDataTrackPublication.html @@ -0,0 +1,245 @@ + + + + + + TVIDataTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIDataTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVITrackPublication : NSObject
Declared inTVIDataTrackPublication.h
+ + + + +
+ +

Overview

+

TVIDataTrackPublication contains the mapping between a data track and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  dataTrack +

+ +
+
+ +
+ + +
+

The data track associated with the data track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIDataTrack *dataTrack
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDataTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Published tracks cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVIDataTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIDefaultAudioDevice.html b/docs/5.8.0/Classes/TVIDefaultAudioDevice.html new file mode 100644 index 00000000..963deae7 --- /dev/null +++ b/docs/5.8.0/Classes/TVIDefaultAudioDevice.html @@ -0,0 +1,469 @@ + + + + + + TVIDefaultAudioDevice Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIDefaultAudioDevice Class Reference

+ + +
+ + + + + + + + + + +
Inherits fromNSObject
Conforms toTVIAudioDevice
Declared inTVIDefaultAudioDevice.h
+ + + + +
+ +

Overview

+

TVIDefaultAudioDevice allows you to record and playback audio when you are connected to a Room.

+
+ + + + + +
+ + + + + + +
+
+ +

  block +

+ +
+
+ +
+ + +
+

A block to configure the AVAudiosession.

+
+ + + +
@property (nonatomic, copy, nonnull) TVIAVAudioSessionConfigurationBlock block
+ + + + + + + + + +
+

Discussion

+

If TVIDefaultAudioDevice is enabled, the SDK executes this block and activates the audio session while + connecting to a Room, otherwise it is the developer’s responsibility to execute the block. Please note that the getter of + this property returns a wrapper block which internally executes the block you set. By default, the SDK returns a default + wrapper block which executes kTVIDefaultAVAudioSessionConfigurationBlock internally.

+ +

The following example demonstrates changing the audio route from speaker to receiver:

+ +
  TVIDefaultAudioDevice *audioDevice = [TVIDefaultAudioDevice audioDevice];
+
+  TwilioVideoSDK.audioDevice = audioDevice;
+
+  //...connect to a Room with audioDevice. By default the audio route will be configured to speaker.
+
+  audioDevice.block =  ^ {
+      // We will execute `kTVIDefaultAVAudioSessionConfigurationBlock` first.
+      kTVIDefaultAVAudioSessionConfigurationBlock();
+
+      // Overwrite the audio route
+      AVAudioSession *session = [AVAudioSession sharedInstance];
+      NSError *error = nil;
+      if (![session setMode:AVAudioSessionModeVoiceChat error:&error]) {
+          NSLog(@"AVAudiosession setMode %@",error);
+      }
+
+      if (![session overrideOutputAudioPort:AVAudioSessionPortOverrideNone error:&error]) {
+          NSLog(@"AVAudiosession overrideOutputAudioPort %@",error);
+      }
+  };
+  audioDevice.block();
+
+
+ + + + + + + +
+

Declared In

+

TVIDefaultAudioDevice.h

+
+ + +
+
+
+ +

  enabled +

+ +
+
+ +
+ + +
+

A boolean which enables playback and recording.

+
+ + + +
@property (nonatomic, assign, getter=isEnabled) BOOL enabled
+ + + + + + + + + +
+

Discussion

+

By default, the SDK initializes this property to YES. Setting it to NO forces the underlying CoreAudio +graph to be stopped (if active), and prevents it from being started again. Setting the property to YES allows the +audio graph to be started whenever there is audio to play or record in a Room.

+
+ + + + + + + +
+

Declared In

+

TVIDefaultAudioDevice.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use defaultAudioDeviceto create a TVIDefaultAudioDevice.

+
+ + + + + + + +
+

Declared In

+

TVIDefaultAudioDevice.h

+
+ + +
+
+
+ +

+ audioDevice +

+ +
+
+ +
+ + +
+

Factory method to create an instance of TVIDefaultAudioDevice.

+
+ + + +
+ (nonnull instancetype)audioDevice
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIDefaultAudioDevice.h

+
+ + +
+
+
+ +

+ audioDeviceWithBlock: +

+ +
+
+ +
+ + +
+

Factory method with a block to create an instance of TVIDefaultAudioDevice.

+
+ + + +
+ (nonnull instancetype)audioDeviceWithBlock:(TVIAVAudioSessionConfigurationBlock _Nonnull)block
+ + + +
+

Parameters

+ + + + + + + +
block

The AVAudioSession configuration block.

+
+ + + +
+

Return Value

+

An instance of TVIDefaultAudioDevice.

+
+ + + + + +
+

Discussion

+

Use this factory method if you want to connect to a Room with your choice of audio session configuration.

+ +

The following example demonstrates connecting to a Room using the AVAudioSessionCategoryPlayback category:

+ +
  TwilioVideoSDK.audioDevice = [TVIDefaultAudioDevice audioDeviceWithBlock:^ {
+    // We will execute `kTVIDefaultAVAudioSessionConfigurationBlock` first.
+    kTVIDefaultAVAudioSessionConfigurationBlock();
+
+    // Overwrite the category to `playback`
+    AVAudioSession *session = [AVAudioSession sharedInstance];
+    NSError *error = nil;
+    if (![session setCategory:AVAudioSessionCategoryPlayback
+                         mode:AVAudioSessionModeVideoChat
+                      options:AVAudioSessionCategoryOptionAllowBluetooth
+                        error:&error]) {
+        NSLog(@"AVAudioSession setCategory:options:mode:error: %@",error);
+    }
+  }];
+
+  TVIConnectOptions *connectOptions = [TVIConnectOptions optionsWithToken:token
+                                                                  block:^(TVIConnectOptionsBuilder *builder) {
+                                                                    builder.audioTracks = @[[TVILocalAudioTrack track]];
+                                                                }];
+
+  TVIRoom *room = [TwilioVideoSDK connectWithOptions:connectOptions];
+
+
+ + + + + + + +
+

Declared In

+

TVIDefaultAudioDevice.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIEncodingParameters.html b/docs/5.8.0/Classes/TVIEncodingParameters.html new file mode 100644 index 00000000..7f2763f7 --- /dev/null +++ b/docs/5.8.0/Classes/TVIEncodingParameters.html @@ -0,0 +1,357 @@ + + + + + + TVIEncodingParameters Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIEncodingParameters Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIEncodingParameters.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.

+
+ + + + + +
+

Discussion

+

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. Maximum bitrate applies to variable bitrate codecs and is limited to 100 Mbps.

+ +

Note: These encoding parameters are applied for each peer connection, each track and each simulcast layer.

+ +

For group Rooms, there is a single peer connection to Twilio Media Server, but for peer-to-peer Rooms, there is +a separate peer connection for each participant. I.e., if you set maximum video bitrate to 1 Mbps and you have two +TVIRemoteParticipant in the Room, the effective video send bitrate may be up to 2 Mbps.

+ +

If you are publishing multiple video tracks (e.g. camera and screen share), each track +receives the maximum bitrate specified. I.e. if you set maximum video bitrate to 1 Mbps and you publish both +a camera and a screen share track, the effective video send bitrate may be up to 2 Mbps.

+ +

If simulcast is used for video tracks, each simulcast layer receives the maximum bitrate specified. +i.e. if your set the maximum bitrate to 1 Mbps and you publish a simulcast video track, the effective +video send bitrate may be up to 3 Mbps if there are three simulcast layers.

+ +

The codec used also affects the bitrate. Each codec type has a minimum and maximum bitrate, and the +bitrate used for a track will always be between those values, even if a higher or lower bitrate is specified here.

+ +

Encoding parameters can be updated any time, using TVILocalParticipant::setEncodingParameters

+ +

Please note that values reported by statistics API will be higher due to packetization overhead etc.

+
+ + + + + + + +
+

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. +The bitrate limit is applied individually to each video track and, if simulcast is used, to each simulcast layer.

+
+ + + + + + + +
+

Declared In

+

TVIEncodingParameters.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIG722Codec.html b/docs/5.8.0/Classes/TVIG722Codec.html new file mode 100644 index 00000000..60dd55b1 --- /dev/null +++ b/docs/5.8.0/Classes/TVIG722Codec.html @@ -0,0 +1,192 @@ + + + + + + TVIG722Codec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIG722Codec Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIAudioCodec : NSObject
Declared inTVIG722Codec.h
+ + + + + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initialzes an instance of the TVIG722Codec codec.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Initialzes an instance of the TVIG722Codec codec.

+
+ + + + + + + +
+

Declared In

+

TVIG722Codec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIH264Codec.html b/docs/5.8.0/Classes/TVIH264Codec.html new file mode 100644 index 00000000..32bcc27d --- /dev/null +++ b/docs/5.8.0/Classes/TVIH264Codec.html @@ -0,0 +1,199 @@ + + + + + + TVIH264Codec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIH264Codec Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIVideoCodec : NSObject
Declared inTVIH264Codec.h
+ + + + +
+ +

Overview

+

The SDK supports Constrained Baseline Profile @ Level 3.1. The H.264 codec is hardware +accelerated on all iOS devices, whereas the VP8 & VP9 codecs are software implementations.

+
+ + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initialzes an instance of the TVIH264Codec codec.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Initialzes an instance of the TVIH264Codec codec.

+
+ + + + + + + +
+

Declared In

+

TVIH264Codec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIIceCandidatePairStats.html b/docs/5.8.0/Classes/TVIIceCandidatePairStats.html new file mode 100644 index 00000000..00fc4fdd --- /dev/null +++ b/docs/5.8.0/Classes/TVIIceCandidatePairStats.html @@ -0,0 +1,1426 @@ + + + + + + TVIIceCandidatePairStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIIceCandidatePairStats Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIIceCandidatePairStats.h
+ + + + +
+ +

Overview

+

TVIIceCandidatePairStats reflects the properties of a Ice candidate pair

+
+ + + + + +
+ + + + + + +
+
+ +

  activeCandidatePair +

+ +
+
+ +
+ + +
+

A boolean to indicate if the candidate pair is active.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isActiveCandidatePair) BOOL activeCandidatePair
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  relayProtocol +

+ +
+
+ +
+ + +
+

The relay protocol.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *relayProtocol
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  transportId +

+ +
+
+ +
+ + +
+

The unique identifier used for TVIIceCandidateStats associated with this candidate.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *transportId
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  localCandidateId +

+ +
+
+ +
+ + +
+

The unique identifier that is associated to the object that was inspected to produce the Ice candidate attributes for the local candidate associated with this candidate pair.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *localCandidateId
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  localCandidateIp +

+ +
+
+ +
+ + +
+

The IP address of the local candidate associated with this candidate pair.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *localCandidateIp
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  remoteCandidateId +

+ +
+
+ +
+ + +
+

The unique identifier that is associated to the object that was inspected to produce the Ice candidate attributes for the remote candidate associated with this candidate pair.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *remoteCandidateId
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  remoteCandidateIp +

+ +
+
+ +
+ + +
+

The IP address of the remote candidate associated with this candidate pair.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *remoteCandidateIp
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  state +

+ +
+
+ +
+ + +
+

Represents the state of the checklist for the local and remote candidates in a pair.

+
+ + + +
@property (nonatomic, assign, readonly) TVIIceCandidatePairState state
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  priority +

+ +
+
+ +
+ + +
+

The priority of the candidate. Priority is calculated as defined in [RFC5245] section 15.1.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t priority
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  nominated +

+ +
+
+ +
+ + +
+

This booean is related to updating the nominated flag described in Section 7.1.3.2.4 of [ RFC5245].

+
+ + + +
@property (nonatomic, assign, readonly, getter=isNominated) BOOL nominated
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  writable +

+ +
+
+ +
+ + +
+

Has gotten ACK to an ICE request.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isWritable) BOOL writable
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  readable +

+ +
+
+ +
+ + +
+

Has gotten a valid incoming ICE request.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isReadable) BOOL readable
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  bytesSent +

+ +
+
+ +
+ + +
+

Represents the total number of payload bytes sent on this candidate pair, i.e., not including headers or padding.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t bytesSent
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  bytesReceived +

+ +
+
+ +
+ + +
+

Represents the total number of payload bytes received on this candidate pair, i.e., not including headers or padding.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t bytesReceived
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  totalRoundTripTime +

+ +
+
+ +
+ + +
+

Total round trip time.

+
+ + + +
@property (nonatomic, assign, readonly) CFTimeInterval totalRoundTripTime
+ + + + + + + + + +
+

Discussion

+

Represents the sum of all round trip time measurements in seconds since the beginning of the session, based on both STUN connectivity check [ STUN-PATH-CHAR] responses (responsesReceived) and consent [ RFC7675] responses (consentResponsesReceived). The average round trip time can be computed from totalRoundTripTime by dividing it by (responsesReceived + consentResponsesReceived).

+
+ + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  currentRoundTripTime +

+ +
+
+ +
+ + +
+

Current round trip time.

+
+ + + +
@property (nonatomic, assign, readonly) CFTimeInterval currentRoundTripTime
+ + + + + + + + + +
+

Discussion

+

Represents the latest round trip time measured in seconds, computed from both STUN connectivity checks [STUN-PATH-CHAR] and consent responses [RFC7675].

+
+ + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  availableOutgoingBitrate +

+ +
+
+ +
+ + +
+

Available outgoing bitrate

+
+ + + +
@property (nonatomic, assign, readonly) double availableOutgoingBitrate
+ + + + + + + + + +
+

Discussion

+

It is calculated by the underlying congestion control by combining the available bitrate for all the outgoing RTP streams using this candidate pair. The bitrate measurement does not count the size of the IP or other transport layers like TCP or UDP. It is similar to the TIAS defined in [RFC3890], i.e., it is measured in bits per second and the bitrate is calculated over a 1 second window.

+
+ + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  availableIncomingBitrate +

+ +
+
+ +
+ + +
+

Available incoming bitrate

+
+ + + +
@property (nonatomic, assign, readonly) double availableIncomingBitrate
+ + + + + + + + + +
+

Discussion

+

It is calculated by the underlying congestion control by combining the available bitrate for all the incoming RTP streams using this candidate pair. The bitrate measurement does not count the size of the IP or other transport layers like TCP or UDP. It is similar to the TIAS defined in [RFC3890], i.e., it is measured in bits per second and the bitrate is calculated over a 1 second window.

+
+ + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  requestsReceived +

+ +
+
+ +
+ + +
+

Represents the total number of connectivity check requests received (including retransmissions).

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t requestsReceived
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  requestsSent +

+ +
+
+ +
+ + +
+

Represents the total number of connectivity check requests sent (not including retransmissions).

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t requestsSent
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  responsesReceived +

+ +
+
+ +
+ + +
+

Represents the total number of connectivity check responses received.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t responsesReceived
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  responsesSent +

+ +
+
+ +
+ + +
+

Represents the total number of connectivity check responses sent.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t responsesSent
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  retransmissionsReceived +

+ +
+
+ +
+ + +
+

Represents the total number of connectivity check retransmissions received.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t retransmissionsReceived
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  retransmissionsSent +

+ +
+
+ +
+ + +
+

Represents the total number of connectivity check retransmissions sent.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t retransmissionsSent
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  consentRequestsReceived +

+ +
+
+ +
+ + +
+

Represents the total number of consent requests received.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t consentRequestsReceived
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  consentRequestsSent +

+ +
+
+ +
+ + +
+

Represents the total number of consent requests sent.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t consentRequestsSent
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  consentResponsesReceived +

+ +
+
+ +
+ + +
+

Represents the total number of consent responses received.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t consentResponsesReceived
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

  consentResponsesSent +

+ +
+
+ +
+ + +
+

Represents the total number of consent responses sent.

+
+ + + +
@property (nonatomic, assign, readonly) uint64_t consentResponsesSent
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Ice candidate pair stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIIceCandidateStats.html b/docs/5.8.0/Classes/TVIIceCandidateStats.html new file mode 100644 index 00000000..7d785578 --- /dev/null +++ b/docs/5.8.0/Classes/TVIIceCandidateStats.html @@ -0,0 +1,594 @@ + + + + + + TVIIceCandidateStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIIceCandidateStats Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIIceCandidateStats.h
+ + + + +
+ +

Overview

+

TVIIceCandidateStats reflects the properties of a candidate in Section 15.1 in [RFC5245].

+
+ + + + + +
+ + + + + + +
+
+ +

  candidateType +

+ +
+
+ +
+ + +
+

Ice candidate type.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *candidateType
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

  deleted +

+ +
+
+ +
+ + +
+

Determines if the ice candidate is deleted or not.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isDeleted) BOOL deleted
+ + + + + + + + + +
+

Discussion

+

For local candidates, YES indicates that the candidate has been deleted/freed as described by [RFC5245]. For host candidates, this means that any network resources (typically a socket) associated with the candidate have been released. For TURN candidates, this means the TURN allocation is no longer active.

+
+ + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

  ip +

+ +
+
+ +
+ + +
+

The IP address of the candidate, allowing for IPv4 addresses and IPv6 addresses, but fully qualified domain names (FQDNs) are not allowed. See [RFC5245] section 15.1 for details.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *ip
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

  remote +

+ +
+
+ +
+ + +
+

NO indicates that this represents a local candidate; YES indicates that this represents a remote candidate.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isRemote) BOOL remote
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

  port +

+ +
+
+ +
+ + +
+

The port number of the candidate.

+
+ + + +
@property (nonatomic, assign, readonly) long port
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

  priority +

+ +
+
+ +
+ + +
+

The priority of the candidate. Priority is calculated as defined in [RFC5245] section 15.1.

+
+ + + +
@property (nonatomic, assign, readonly) long priority
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

  protocol +

+ +
+
+ +
+ + +
+

The protocol used by the candidate. The valid values for transport is one of udp and tcp. Based on the “transport” defined in [RFC5245] section 15.1.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *protocol
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

  url +

+ +
+
+ +
+ + +
+

The URL of the TURN or STUN server indicated in the that translated this IP address. It is the URL address surfaced in an peer connection ice event.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *url
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

  transportId +

+ +
+
+ +
+ + +
+

The unique identifier used for TVIIceCandidateStats associated with this candidate.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *transportId
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Ice candidate stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIIceCandidateStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIIceOptions.html b/docs/5.8.0/Classes/TVIIceOptions.html new file mode 100644 index 00000000..c2dafa51 --- /dev/null +++ b/docs/5.8.0/Classes/TVIIceOptions.html @@ -0,0 +1,351 @@ + + + + + + TVIIceOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIIceOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIIceOptions.h
+ + + + +
+ +

Overview

+

Media connections are established using the ICE (Interactive Connectivity Establishment) protocol. +These options allow you to customize how data flows to and from participants, and which protocols to use. +You may also provide your own ICE servers, overriding the defaults. +https://www.twilio.com/stun-turn

+
+ + + + + +
+ + + + + + +
+
+ +

  servers +

+ +
+
+ +
+ + +
+

An array of TVIIceServer objects to be used during connection establishment.

+
+ + + +
@property (nonatomic, copy, nonnull, readonly) NSArray<TVIIceServer*> *servers
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

  transportPolicy +

+ +
+
+ +
+ + +
+

The transport policy to use. Defaults to TVIIceTransportPolicyAll.

+
+ + + +
@property (nonatomic, assign, readonly) TVIIceTransportPolicy transportPolicy
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

+ options +

+ +
+
+ +
+ + +
+

Creates a default TVIIceOptions instance.

+
+ + + +
+ (_Null_unspecified instancetype)options
+ + + + + +
+

Return Value

+

An instance of TVIIceOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

+ optionsWithBlock: +

+ +
+
+ +
+ + +
+

Creates a TVIIceOptions instance using a builder block that you specify.

+
+ + + +
+ (nonnull instancetype)optionsWithBlock:(nonnull TVIIceOptionsBuilderBlock)block
+ + + +
+

Parameters

+ + + + + + + +
block

A TVIIceOptionsBuilderBlock which sets specific options on the builder.

+
+ + + +
+

Return Value

+

A TVIIceOptions instance created using options set in the builder block.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIIceOptionsBuilder.html b/docs/5.8.0/Classes/TVIIceOptionsBuilder.html new file mode 100644 index 00000000..f72a210c --- /dev/null +++ b/docs/5.8.0/Classes/TVIIceOptionsBuilder.html @@ -0,0 +1,238 @@ + + + + + + TVIIceOptionsBuilder Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIIceOptionsBuilder Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIIceOptions.h
+ + + + +
+ +

Overview

+

If you provide a transportPolicy but do not provide any ICE Servers, then the servers will automatically +be fetched for you based upon how the Room was created. For Client created Rooms the default Room settings +are used, while settings are provided on a per-Room basis when creating Rooms using the REST API.

+
+ + + + + +
+ + + + + + +
+
+ +

  servers +

+ +
+
+ +
+ + +
+

An array of TVIIceServer objects to be used during connection establishment.

+
+ + + +
@property (nonatomic, strong, nullable) NSArray<TVIIceServer*> *servers
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

  transportPolicy +

+ +
+
+ +
+ + +
+

The transport policy to use. Defaults to TVIIceTransportPolicyAll.

+
+ + + +
@property (nonatomic, assign) TVIIceTransportPolicy transportPolicy
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIIceServer.html b/docs/5.8.0/Classes/TVIIceServer.html new file mode 100644 index 00000000..e175d6f8 --- /dev/null +++ b/docs/5.8.0/Classes/TVIIceServer.html @@ -0,0 +1,477 @@ + + + + + + TVIIceServer Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIIceServer Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIIceOptions.h
+ + + + +
+ +

Overview

+

TVIIceServer is a single STUN or TURN server.

+
+ + + + + +
+ + + + + + +
+
+ +

  urlString +

+ +
+
+ +
+ + +
+

The URL string for the ICE server.

+
+ + + +
@property (nonnull, nonatomic, readonly, copy) NSString *urlString
+ + + + + + + + + +
+

Discussion

+

Your server URL must begin with either the stun: or turn: scheme. +For example, a STUN server could be defined as <stun:stun.company.com:port>.

+
+ + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

  username +

+ +
+
+ +
+ + +
+

The user name. Required for TURN servers.

+
+ + + +
@property (nullable, nonatomic, readonly, copy) NSString *username
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

  password +

+ +
+
+ +
+ + +
+

The password. Required for TURN servers.

+
+ + + +
@property (nullable, nonatomic, readonly, copy) NSString *password
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

– initWithURLString: +

+ +
+
+ +
+ + +
+

Creates a TVIIceServer.

+
+ + + +
- (null_unspecified instancetype)initWithURLString:(nonnull NSString *)serverURLString
+ + + +
+

Parameters

+ + + + + + + +
serverURLString

The URL for your STUN or TURN server.

+
+ + + +
+

Return Value

+

A TVIIceServer object.

+
+ + + + + +
+

Discussion

+

Creates a TVIIceServer.

+
+ + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

– initWithURLString:username:password: +

+ +
+
+ +
+ + +
+

Creates a TVIIceServer.

+
+ + + +
- (null_unspecified instancetype)initWithURLString:(nonnull NSString *)serverURLString username:(nullable NSString *)username password:(nullable NSString *)password
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
serverURLString

The URL for your STUN or TURN server.

username

The username credential for your server.

password

The password credential for your server.

+
+ + + +
+

Return Value

+

A TVIIceServer object.

+
+ + + + + +
+

Discussion

+

Creates a TVIIceServer.

+
+ + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers should initialize with a parameterized initializer.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

TVIIceServer cannot be created without supplying parameters.

+
+ + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalAudioTrack.html b/docs/5.8.0/Classes/TVILocalAudioTrack.html new file mode 100644 index 00000000..a2744bd4 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalAudioTrack.html @@ -0,0 +1,430 @@ + + + + + + TVILocalAudioTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalAudioTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIAudioTrack : TVITrack : NSObject
Declared inTVILocalAudioTrack.h
+ + + + +
+ +

Overview

+

TVILocalAudioTrack represents an audio track where the content is captured from your device’s audio subsystem.

+
+ + + + + +
+ + + + + + +
+
+ +

  options +

+ +
+
+ +
+ + +
+

The TVIAudioOptions that were provided when the track was added to TVILocalMedia.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIAudioOptions *options
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalAudioTrack.h

+
+ + +
+
+
+ +

  enabled +

+ +
+
+ +
+ + +
+

Indicates if the track content is enabled.

+
+ + + +
@property (nonatomic, assign, getter=isEnabled) BOOL enabled
+ + + + + + + + + +
+

Discussion

+

It is possible to enable and disable local tracks. The results of this operation are signaled to other +Participants in the same Room. When an audio track is disabled, silence is sent in place of normal audio.

+
+ + + + + + + +
+

Declared In

+

TVILocalAudioTrack.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use track or trackWithOptions:enabled:name: to create a TVILocalAudioTrack.

+
+ + + + + + + +
+

Declared In

+

TVILocalAudioTrack.h

+
+ + +
+
+
+ +

+ track +

+ +
+
+ +
+ + +
+

Creates a TVILocalAudioTrack with the default settings.

+
+ + + +
+ (nullable instancetype)track
+ + + + + +
+

Return Value

+

A Track which is ready to be shared with Participants in a Room, or nil if an error occurs.

+
+ + + + + +
+

Discussion

+

This method uses the default TVIAudioOptions, and produces an enabled Track. If you are using a +custom TVIAudioDevice which doesn’t support audio capturing then attempting to create a TVILocalAudioTrack will +cause an exception to be thrown.

+
+ + + + + + + +
+

Declared In

+

TVILocalAudioTrack.h

+
+ + +
+
+
+ +

+ trackWithOptions:enabled:name: +

+ +
+
+ +
+ + +
+

Creates a TVILocalAudioTrack with TVIAudioOptions and an enabled setting.

+
+ + + +
+ (nullable instancetype)trackWithOptions:(nullable TVIAudioOptions *)options enabled:(BOOL)enabled name:(nullable NSString *)name
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
options

An instance of TVIAudioOptions to configure the Track.

enabled

Determines if the Track is enabled at creation time.

name

The Track name.

+
+ + + +
+

Return Value

+

A Track which is ready to be shared with Participants in a Room, or nil if an error occurs.

+
+ + + + + +
+

Discussion

+

This method allows you to provide specific TVIAudioOptions, and produce a disabled Track if you wish. +If you are using a custom TVIAudioDevice which doesn’t support audio capturing then attempting to create a +TVILocalAudioTrack will cause an exception to be thrown.

+
+ + + + + + + +
+

Declared In

+

TVILocalAudioTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalAudioTrackPublication.html b/docs/5.8.0/Classes/TVILocalAudioTrackPublication.html new file mode 100644 index 00000000..202fbdd0 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalAudioTrackPublication.html @@ -0,0 +1,294 @@ + + + + + + TVILocalAudioTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalAudioTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIAudioTrackPublication : TVITrackPublication : NSObject
Declared inTVILocalAudioTrackPublication.h
+ + + + +
+ +

Overview

+

TVILocalAudioTrackPublication contains the mapping between a published TVILocalAudioTrack and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  localTrack +

+ +
+
+ +
+ + +
+

The local audio track associated with track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVILocalAudioTrack *localTrack
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalAudioTrackPublication.h

+
+ + +
+
+
+ +

  priority +

+ +
+
+ +
+ + +
+

The track priority of the TVILocalAudioTrackPublication

+
+ + + +
@property (nonatomic, copy, nonnull) TVITrackPriority priority
+ + + + + + + + + +
+

Discussion

+

The publisher’s TVITrackPriority for the corresponding TVILocalAudioTrack can be updated after +it has been published.

+
+ + + + + + + +
+

Declared In

+

TVILocalAudioTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Track publications cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVILocalAudioTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalAudioTrackStats.html b/docs/5.8.0/Classes/TVILocalAudioTrackStats.html new file mode 100644 index 00000000..5c0574c0 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalAudioTrackStats.html @@ -0,0 +1,293 @@ + + + + + + TVILocalAudioTrackStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalAudioTrackStats Class Reference

+ + +
+ + + + + + + +
Inherits fromTVILocalTrackStats : TVIBaseTrackStats : NSObject
Declared inTVILocalAudioTrackStats.h
+ + + + +
+ +

Overview

+

TVILocalAudioTrackStats represents stats about a local audio track.

+
+ + + + + +
+ + + + + + +
+
+ +

  audioLevel +

+ +
+
+ +
+ + +
+

Audio input level.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger audioLevel
+ + + + + + + + + +
+

Discussion

+

The input level is an amplitude within the range of 0 to 32,767.

+
+ + + + + + + +
+

Declared In

+

TVILocalAudioTrackStats.h

+
+ + +
+
+
+ +

  jitter +

+ +
+
+ +
+ + +
+

Packet jitter measured in milliseconds.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger jitter
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalAudioTrackStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Local audio track stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVILocalAudioTrackStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalDataTrack.html b/docs/5.8.0/Classes/TVILocalDataTrack.html new file mode 100644 index 00000000..6433d6c6 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalDataTrack.html @@ -0,0 +1,431 @@ + + + + + + TVILocalDataTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalDataTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIDataTrack : TVITrack : NSObject
Declared inTVILocalDataTrack.h
+ + + + +
+ +

Overview

+

A data track represents a unidirectional data source that can be used to send messages to +participants of a Room.

+
+ + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use track or trackWithOptions:name: to create a TVILocalDataTrack.

+
+ + + + + + + +
+

Declared In

+

TVILocalDataTrack.h

+
+ + +
+
+
+ +

– sendString: +

+ +
+
+ +
+ + +
+

Send a string message.

+
+ + + +
- (void)sendString:(nonnull NSString *)message
+ + + +
+

Parameters

+ + + + + + + +
message

The string message.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVILocalDataTrack.h

+
+ + +
+
+
+ +

– sendData: +

+ +
+
+ +
+ + +
+

Send a binary message.

+
+ + + +
- (void)sendData:(nonnull NSData *)message
+ + + +
+

Parameters

+ + + + + + + +
message

The binary message.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVILocalDataTrack.h

+
+ + +
+
+
+ +

+ track +

+ +
+
+ +
+ + +
+

Creates a TVILocalDataTrack with the default settings.

+
+ + + +
+ (nullable instancetype)track
+ + + + + +
+

Return Value

+

A Track which is ready to be shared with Participants in a Room, or nil if an error occurs.

+
+ + + + + +
+

Discussion

+

This method uses the default TVIDataTrackOptions, and produces an enabled Track.

+
+ + + + + + + +
+

Declared In

+

TVILocalDataTrack.h

+
+ + +
+
+
+ +

+ trackWithOptions: +

+ +
+
+ +
+ + +
+

Creates a TVILocalDataTrack with TVIDataTrackOptions.

+
+ + + +
+ (nullable instancetype)trackWithOptions:(nullable TVIDataTrackOptions *)options
+ + + +
+

Parameters

+ + + + + + + +
options

An instance of TVIDataTrackOptions to configure the Track.

+
+ + + +
+

Return Value

+

A Track which is ready to be shared with Participants in a Room, or nil if an error occurs.

+
+ + + + + +
+

Discussion

+

This method allows you to provide specific TVIDataTrackOptions.

+
+ + + + + + + +
+

Declared In

+

TVILocalDataTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalDataTrackPublication.html b/docs/5.8.0/Classes/TVILocalDataTrackPublication.html new file mode 100644 index 00000000..ddc48782 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalDataTrackPublication.html @@ -0,0 +1,294 @@ + + + + + + TVILocalDataTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalDataTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIDataTrackPublication : TVITrackPublication : NSObject
Declared inTVILocalDataTrackPublication.h
+ + + + +
+ +

Overview

+

TVILocalDataTrackPublication contains the mapping between a published TVILocalDataTrack and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  localTrack +

+ +
+
+ +
+ + +
+

The local data track associated with track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVILocalDataTrack *localTrack
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalDataTrackPublication.h

+
+ + +
+
+
+ +

  priority +

+ +
+
+ +
+ + +
+

The track priority of the TVILocalDataTrackPublication

+
+ + + +
@property (nonatomic, copy, nonnull) TVITrackPriority priority
+ + + + + + + + + +
+

Discussion

+

The publisher’s TVITrackPriority for the corresponding TVILocalDataTrack can be updated after +it has been published.

+
+ + + + + + + +
+

Declared In

+

TVILocalDataTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Track publications cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVILocalDataTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalParticipant.html b/docs/5.8.0/Classes/TVILocalParticipant.html new file mode 100644 index 00000000..0f66e153 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalParticipant.html @@ -0,0 +1,1036 @@ + + + + + + TVILocalParticipant Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalParticipant Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIParticipant : NSObject
Declared inTVILocalParticipant.h
+ + + + +
+ +

Overview

+

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

+
+ + + + + +
+ + + + + + +
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

The Local Participant’s delegate. Set this property to be notified about Participant events such as tracks being +published.

+
+ + + +
@property (atomic, weak, nullable) id<TVILocalParticipantDelegate> delegate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

  localAudioTracks +

+ +
+
+ +
+ + +
+

A collection of TVILocalAudioTrackPublication objects.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalAudioTrackPublication*> *localAudioTracks
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

  localDataTracks +

+ +
+
+ +
+ + +
+

A collection of TVILocalDataTrackPublication objects.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalDataTrackPublication*> *localDataTracks
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

  localVideoTracks +

+ +
+
+ +
+ + +
+

A collection of TVILocalVideoTrackPublication objects.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVILocalVideoTrackPublication*> *localVideoTracks
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

  signalingRegion +

+ +
+
+ +
+ + +
+

Where the Participant’s signaling traffic enters and exits Twilio’s communications cloud. +This property reflects the TVIConnectOptions.region provided by the Participant and when “gll” +(the default value) is provided, the region that was selected using latency based routing.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *signalingRegion
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– publishAudioTrack: +

+ +
+
+ +
+ + +
+

Publishes the audio track to the Room with the default TVILocalTrackPublicationOptions.

+
+ + + +
- (BOOL)publishAudioTrack:(nonnull TVILocalAudioTrack *)track
+ + + +
+

Parameters

+ + + + + + + +
track

The TVILocalAudioTrack to publish.

+
+ + + +
+

Return Value

+

YES if the track was published successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– publishAudioTrack:publicationOptions: +

+ +
+
+ +
+ + +
+

Publishes the audio track to the Room.

+
+ + + +
- (BOOL)publishAudioTrack:(nonnull TVILocalAudioTrack *)track publicationOptions:(nonnull TVILocalTrackPublicationOptions *)options
+ + + +
+

Parameters

+ + + + + + + + + + + + +
track

The TVILocalAudioTrack to publish.

options

The TVILocalTrackPublicationOptions used to publish the track.

+
+ + + +
+

Return Value

+

YES if the track was published successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– publishDataTrack: +

+ +
+
+ +
+ + +
+

Publishes the data track to the Room with the default TVILocalTrackPublicationOptions.

+
+ + + +
- (BOOL)publishDataTrack:(nonnull TVILocalDataTrack *)track
+ + + +
+

Parameters

+ + + + + + + +
track

The TVILocalDataTrack to publish.

+
+ + + +
+

Return Value

+

YES if the track was published successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– publishDataTrack:publicationOptions: +

+ +
+
+ +
+ + +
+

Publishes the data track to the Room.

+
+ + + +
- (BOOL)publishDataTrack:(nonnull TVILocalDataTrack *)track publicationOptions:(nonnull TVILocalTrackPublicationOptions *)options
+ + + +
+

Parameters

+ + + + + + + + + + + + +
track

The TVILocalDataTrack to publish.

options

The TVILocalTrackPublicationOptions used to publish the track.

+
+ + + +
+

Return Value

+

YES if the track was published successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– publishVideoTrack: +

+ +
+
+ +
+ + +
+

Publishes the video track to the Room with the default TVILocalTrackPublicationOptions.

+
+ + + +
- (BOOL)publishVideoTrack:(nonnull TVILocalVideoTrack *)track
+ + + +
+

Parameters

+ + + + + + + +
track

The TVILocalVideoTrack to publish.

+
+ + + +
+

Return Value

+

YES if the track was published successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– publishVideoTrack:publicationOptions: +

+ +
+
+ +
+ + +
+

Publishes the video track to the Room.

+
+ + + +
- (BOOL)publishVideoTrack:(nonnull TVILocalVideoTrack *)track publicationOptions:(nonnull TVILocalTrackPublicationOptions *)options
+ + + +
+

Parameters

+ + + + + + + + + + + + +
track

The TVILocalVideoTrack to publish.

options

The TVILocalTrackPublicationOptions used to publish the track.

+
+ + + +
+

Return Value

+

YES if the track was published successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– unpublishAudioTrack: +

+ +
+
+ +
+ + +
+

Unpublishes the audio track from the Room.

+
+ + + +
- (BOOL)unpublishAudioTrack:(nonnull TVILocalAudioTrack *)track
+ + + +
+

Parameters

+ + + + + + + +
track

The TVILocalAudioTrack to unpublish.

+
+ + + +
+

Return Value

+

YES if the track was unpublished successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– unpublishDataTrack: +

+ +
+
+ +
+ + +
+

Unpublishes the data track from the Room.

+
+ + + +
- (BOOL)unpublishDataTrack:(nonnull TVILocalDataTrack *)track
+ + + +
+

Parameters

+ + + + + + + +
track

The TVILocalDataTrack to unpublish.

+
+ + + +
+

Return Value

+

YES if the track was unpublished successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– unpublishVideoTrack: +

+ +
+
+ +
+ + +
+

Unpublishes the video track from the Room.

+
+ + + +
- (BOOL)unpublishVideoTrack:(nonnull TVILocalVideoTrack *)track
+ + + +
+

Parameters

+ + + + + + + +
track

The TVILocalVideoTrack to unpublish.

+
+ + + +
+

Return Value

+

YES if the track was unpublished successfully, NO otherwise.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– setEncodingParameters: +

+ +
+
+ +
+ + +
+

Updates the TVIEncodingParameters used to share media in the Room.

+
+ + + +
- (void)setEncodingParameters:(nullable TVIEncodingParameters *)encodingParameters
+ + + +
+

Parameters

+ + + + + + + +
encodingParameters

The TVIEncodingParameters to use or nil for the default values.

+
+ + + + + + + +
+

Discussion

+

Setting both EncodingParameters.maxVideoBitrate and ConnectOptions.videoEncodingMode is not allowed +and will result in an NSInvalidArgumentException.

+
+ + + + + + + +
+

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

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalTrackPublicationOptions.html b/docs/5.8.0/Classes/TVILocalTrackPublicationOptions.html new file mode 100644 index 00000000..fd4c4159 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalTrackPublicationOptions.html @@ -0,0 +1,309 @@ + + + + + + TVILocalTrackPublicationOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalTrackPublicationOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVILocalTrackPublicationOptions.h
+ + + + +
+ +

Overview

+

TVILocalTrackPublicationOptions represents options that can be specified when publishing a Local Track.

+
+ + + + + +
+ + + + + + +
+
+ +

  priority +

+ +
+
+ +
+ + +
+

The track priority to be used when publishing a Local Track. TVITrackPriorityStandard is the default priority.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) TVITrackPriority priority
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalTrackPublicationOptions.h

+
+ + +
+
+
+ +

+ optionsWithPriority: +

+ +
+
+ +
+ + +
+

Creates an instance of TVILocalTrackPublicationOptions.

+
+ + + +
+ (nonnull instancetype)optionsWithPriority:(nonnull TVITrackPriority)priority
+ + + +
+

Parameters

+ + + + + + + +
priority

The track priority to be used when publishing a Local Track.

+
+ + + +
+

Return Value

+

An instance of TVILocalTrackPublicationOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVILocalTrackPublicationOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use the class methods optionsWithPriority: instead.

+
+ + + + + + + +
+

Declared In

+

TVILocalTrackPublicationOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalTrackStats.html b/docs/5.8.0/Classes/TVILocalTrackStats.html new file mode 100644 index 00000000..d2703118 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalTrackStats.html @@ -0,0 +1,331 @@ + + + + + + TVILocalTrackStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalTrackStats Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIBaseTrackStats : NSObject
Declared inTVILocalTrackStats.h
+ + + + +
+ +

Overview

+

TVILocalTrackStats represents stats common to local tracks.

+
+ + + + + +
+ + + + + + +
+
+ +

  bytesSent +

+ +
+
+ +
+ + +
+

Total number of bytes sent for this SSRC.

+
+ + + +
@property (nonatomic, assign, readonly) int64_t bytesSent
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalTrackStats.h

+
+ + +
+
+
+ +

  packetsSent +

+ +
+
+ +
+ + +
+

Total number of RTP packets sent for this SSRC.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger packetsSent
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalTrackStats.h

+
+ + +
+
+
+ +

  roundTripTime +

+ +
+
+ +
+ + +
+

Estimated round trip time for this SSRC based on the RTCP timestamps. Measured in milliseconds.

+
+ + + +
@property (nonatomic, assign, readonly) int64_t roundTripTime
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalTrackStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Local track stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVILocalTrackStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalVideoTrack.html b/docs/5.8.0/Classes/TVILocalVideoTrack.html new file mode 100644 index 00000000..575128c8 --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalVideoTrack.html @@ -0,0 +1,456 @@ + + + + + + TVILocalVideoTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalVideoTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIVideoTrack : TVITrack : NSObject
Declared inTVILocalVideoTrack.h
+ + + + +
+ +

Overview

+

TVILocalVideoTrack represents local video produced by a TVIVideoSource.

+
+ + + + + +
+ + + + + + +
+
+ +

  enabled +

+ +
+
+ +
+ + +
+

Indicates if track is enabled.

+
+ + + +
@property (nonatomic, assign, getter=isEnabled) BOOL enabled
+ + + + + + + + + +
+

Discussion

+

It is possible to enable and disable local tracks. The results of this operation are signaled to other +Participants in the same Room. When a video track is disabled, black frames are sent in place of normal video.

+
+ + + + + + + +
+

Declared In

+

TVILocalVideoTrack.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use trackWithCapturer: or trackWithCapturer:enabled:constraints:name: to create a TVILocalVideoTrack.

+
+ + + + + + + +
+

Declared In

+

TVILocalVideoTrack.h

+
+ + +
+
+
+ +

  source +

+ +
+
+ +
+ + +
+

The video source that is associated with this track when using the TVIVideoSource based initializers.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) id<TVIVideoSource> source
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalVideoTrack.h

+
+ + +
+
+
+ +

+ trackWithSource: +

+ +
+
+ +
+ + +
+

Creates a TVILocalVideoTrack with a TVIVideoSource.

+
+ + + +
+ (nullable instancetype)trackWithSource:(nonnull id<TVIVideoSource>)source
+ + + +
+

Parameters

+ + + + + + + +
source

A TVIVideoSource which will provide the content for this Track.

+
+ + + +
+

Return Value

+

A Track which is ready to be shared with Participants in a Room, or nil if an error occurs.

+
+ + + + + +
+

Discussion

+

The Track will be enabled, and use a randomly generated name.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVILocalVideoTrack.h

+
+ + +
+
+
+ +

+ trackWithSource:enabled:name: +

+ +
+
+ +
+ + +
+

Creates a TVILocalVideoTrack with a TVIVideoSource.

+
+ + + +
+ (nullable instancetype)trackWithSource:(nonnull id<TVIVideoSource>)source enabled:(BOOL)enabled name:(nullable NSString *)name
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
source

A TVIVideoSource which will provide the content for this Track.

enabled

Determines if the Track is enabled at creation time.

name

A name for the Track. Names are immutable and can only be provided at Track creation time.

+
+ + + +
+

Return Value

+

A Track which is ready to be shared with Participants in a Room, or nil if an error occurs.

+
+ + + + + +
+

Discussion

+

The Track will be enabled, and use a randomly generated name.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVILocalVideoTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalVideoTrackPublication.html b/docs/5.8.0/Classes/TVILocalVideoTrackPublication.html new file mode 100644 index 00000000..65a5413c --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalVideoTrackPublication.html @@ -0,0 +1,294 @@ + + + + + + TVILocalVideoTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalVideoTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIVideoTrackPublication : TVITrackPublication : NSObject
Declared inTVILocalVideoTrackPublication.h
+ + + + +
+ +

Overview

+

TVILocalVideoTrackPublication contains the mapping between a published TVILocalVideoTrack and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  localTrack +

+ +
+
+ +
+ + +
+

The local video track associated with track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVILocalVideoTrack *localTrack
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalVideoTrackPublication.h

+
+ + +
+
+
+ +

  priority +

+ +
+
+ +
+ + +
+

The track priority of the TVILocalVideoTrackPublication

+
+ + + +
@property (nonatomic, copy, nonnull) TVITrackPriority priority
+ + + + + + + + + +
+

Discussion

+

The publisher’s TVITrackPriority for the corresponding TVILocalVideoTrack can be updated after +it has been published.

+
+ + + + + + + +
+

Declared In

+

TVILocalVideoTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Track publications cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVILocalVideoTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVILocalVideoTrackStats.html b/docs/5.8.0/Classes/TVILocalVideoTrackStats.html new file mode 100644 index 00000000..1864208c --- /dev/null +++ b/docs/5.8.0/Classes/TVILocalVideoTrackStats.html @@ -0,0 +1,417 @@ + + + + + + TVILocalVideoTrackStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalVideoTrackStats Class Reference

+ + +
+ + + + + + + +
Inherits fromTVILocalTrackStats : TVIBaseTrackStats : NSObject
Declared inTVILocalVideoTrackStats.h
+ + + + +
+ +

Overview

+

TVILocalVideoTrackStats represents stats about a local video track.

+
+ + + + + +
+ + + + + + +
+
+ +

  captureDimensions +

+ +
+
+ +
+ + +
+

Captured frame dimensions.

+
+ + + +
@property (nonatomic, assign, readonly) CMVideoDimensions captureDimensions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalVideoTrackStats.h

+
+ + +
+
+
+ +

  captureFrameRate +

+ +
+
+ +
+ + +
+

Captured frame rate.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger captureFrameRate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalVideoTrackStats.h

+
+ + +
+
+
+ +

  dimensions +

+ +
+
+ +
+ + +
+

Sent frame dimensions.

+
+ + + +
@property (nonatomic, assign, readonly) CMVideoDimensions dimensions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalVideoTrackStats.h

+
+ + +
+
+
+ +

  frameRate +

+ +
+
+ +
+ + +
+

Sent frame rate.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger frameRate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalVideoTrackStats.h

+
+ + +
+
+
+ +

  framesEncoded +

+ +
+
+ +
+ + +
+

The number of frames encoded.

+
+ + + +
@property (nonatomic, assign, readonly) uint32_t framesEncoded
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVILocalVideoTrackStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Local video track stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVILocalVideoTrackStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVINetworkQualityConfiguration.html b/docs/5.8.0/Classes/TVINetworkQualityConfiguration.html new file mode 100644 index 00000000..a31be786 --- /dev/null +++ b/docs/5.8.0/Classes/TVINetworkQualityConfiguration.html @@ -0,0 +1,339 @@ + + + + + + TVINetworkQualityConfiguration Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVINetworkQualityConfiguration Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVINetworkQualityConfiguration.h
+ + + + + + + + +
+ + + + + + +
+
+ +

  local +

+ +
+
+ +
+ + +
+

The TVINetworkQualityVerbosity for the Local Participant.

+
+ + + +
@property (nonatomic, readonly, assign) TVINetworkQualityVerbosity local
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVINetworkQualityConfiguration.h

+
+ + +
+
+
+ +

  remote +

+ +
+
+ +
+ + +
+

The TVINetworkQualityVerbosity for the Remote Participants.

+
+ + + +
@property (nonatomic, readonly, assign) TVINetworkQualityVerbosity remote
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVINetworkQualityConfiguration.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initializes a TVINetworkQualityConfiguration object with the default values, TVINetworkQualityVerbosityMinimal +for the Local Participant and TVINetworkQualityVerbosityNone for the Remote Participants.

+
+ + + +
- (nonnull instancetype)init
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVINetworkQualityConfiguration.h

+
+ + +
+
+
+ +

– initWithLocalVerbosity:remoteVerbosity: +

+ +
+
+ +
+ + +
+

Initalizes a TVINetworkQualityConfiguration object with the provided TVINetworkQualityVerbosity levels.

+
+ + + +
- (nullable instancetype)initWithLocalVerbosity:(TVINetworkQualityVerbosity)local remoteVerbosity:(TVINetworkQualityVerbosity)remote
+ + + +
+

Parameters

+ + + + + + + + + + + + +
local

The TVINetworkQualityVerbosity for the Local Participant. TVINetworkQualityVerbosityNone is invalid +for the Local Participant and will throw an NSInvalidArgumentException.

remote

The TVINetworkQualityVerbosity for the Remote Participants.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVINetworkQualityConfiguration.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIOpusCodec.html b/docs/5.8.0/Classes/TVIOpusCodec.html new file mode 100644 index 00000000..be5da91f --- /dev/null +++ b/docs/5.8.0/Classes/TVIOpusCodec.html @@ -0,0 +1,306 @@ + + + + + + TVIOpusCodec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIOpusCodec Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIAudioCodec : NSObject
Declared inTVIOpusCodec.h
+ + + + + + + + +
+ + + + + + +
+
+ +

  dtxEnabled +

+ +
+
+ +
+ + +
+

Indicates if discontinuous transmission (DTX) is enabled.

+
+ + + +
@property (nonatomic, readonly, getter=isDtxEnabled) BOOL dtxEnabled
+ + + + + + + + + +
+

Discussion

+

Discontinuous transmission (DTX) in the Opus audio codec is enabled by default, +which will result in bandwidth and CPU savings during silence and background noise.

+
+ + + + + + + +
+

Declared In

+

TVIOpusCodec.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initialzes an instance of the TVIOpusCodec codec.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Initialzes an instance of the TVIOpusCodec codec.

Discontinuous transmission (DTX) in the Opus audio codec is enabled by default, +which will result in bandwidth and CPU savings during silence and background noise.

+
+ + + + + + + +
+

Declared In

+

TVIOpusCodec.h

+
+ + +
+
+
+ +

– initWithDtxEnabled: +

+ +
+
+ +
+ + +
+

Initializes an instance of the TVIOpusCodec with specified discontinuous transmission (DTX) state.

+
+ + + +
- (null_unspecified instancetype)initWithDtxEnabled:(BOOL)dtxEnabled
+ + + +
+

Parameters

+ + + + + + + +
dtxEnabled

Indicates if dtx is enabled or not.

+
+ + + +
+

Return Value

+

An instance of TVIOpusCodec.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIOpusCodec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIParticipant.html b/docs/5.8.0/Classes/TVIParticipant.html new file mode 100644 index 00000000..50598a95 --- /dev/null +++ b/docs/5.8.0/Classes/TVIParticipant.html @@ -0,0 +1,753 @@ + + + + + + TVIParticipant Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIParticipant Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIParticipant.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

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIPcmaCodec.html b/docs/5.8.0/Classes/TVIPcmaCodec.html new file mode 100644 index 00000000..ddf089df --- /dev/null +++ b/docs/5.8.0/Classes/TVIPcmaCodec.html @@ -0,0 +1,192 @@ + + + + + + TVIPcmaCodec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIPcmaCodec Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIAudioCodec : NSObject
Declared inTVIPcmaCodec.h
+ + + + + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initialzes an instance of the TVIPcmaCodec codec.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Initialzes an instance of the TVIPcmaCodec codec.

+
+ + + + + + + +
+

Declared In

+

TVIPcmaCodec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIPcmuCodec.html b/docs/5.8.0/Classes/TVIPcmuCodec.html new file mode 100644 index 00000000..5900a46c --- /dev/null +++ b/docs/5.8.0/Classes/TVIPcmuCodec.html @@ -0,0 +1,192 @@ + + + + + + TVIPcmuCodec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIPcmuCodec Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIAudioCodec : NSObject
Declared inTVIPcmuCodec.h
+ + + + + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initialzes an instance of the TVIPcmuCodec codec.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Initialzes an instance of the TVIPcmuCodec codec.

+
+ + + + + + + +
+

Declared In

+

TVIPcmuCodec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteAudioTrack.html b/docs/5.8.0/Classes/TVIRemoteAudioTrack.html new file mode 100644 index 00000000..ca2c76bb --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteAudioTrack.html @@ -0,0 +1,289 @@ + + + + + + TVIRemoteAudioTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteAudioTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIAudioTrack : TVITrack : NSObject
Declared inTVIRemoteAudioTrack.h
+ + + + +
+ +

Overview

+

TVIRemoteAudioTrack represents a remote audio track.

+
+ + + + + +
+ + + + + + +
+
+ +

  playbackEnabled +

+ +
+
+ +
+ + +
+

Controls whether the contents of the AudioTrack are played locally. Defaults to ‘YES’. Note that the remote +party can still enable or disable the track.

+
+ + + +
@property (nonatomic, assign, getter=isPlaybackEnabled) BOOL playbackEnabled
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteAudioTrack.h

+
+ + +
+
+
+ +

  sid +

+ +
+
+ +
+ + +
+

The sid of the remote audio track.

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

Declared In

+

TVIRemoteAudioTrack.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Tracks cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteAudioTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteAudioTrackPublication.html b/docs/5.8.0/Classes/TVIRemoteAudioTrackPublication.html new file mode 100644 index 00000000..4ce014a1 --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteAudioTrackPublication.html @@ -0,0 +1,341 @@ + + + + + + TVIRemoteAudioTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteAudioTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIAudioTrackPublication : TVITrackPublication : NSObject
Declared inTVIRemoteAudioTrackPublication.h
+ + + + +
+ +

Overview

+

TVIRemoteAudioTrackPublication contains the mapping between a published TVIRemoteAudioTrack and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  trackSubscribed +

+ +
+
+ +
+ + +
+

Returns whether the Local Participant has subscribed to this track.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isTrackSubscribed) BOOL trackSubscribed
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteAudioTrackPublication.h

+
+ + +
+
+
+ +

  remoteTrack +

+ +
+
+ +
+ + +
+

The remote audio track associated with the track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIRemoteAudioTrack *remoteTrack
+ + + + + + + + + +
+

Discussion

+

This property will return nil unless the Local Participant is subscribed to this track.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteAudioTrackPublication.h

+
+ + +
+
+
+ +

  publishPriority +

+ +
+
+ +
+ + +
+

Get the TVITrackPriority set by the publisher for the corresponding TVIRemoteAudioTrack.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) TVITrackPriority publishPriority
+ + + + + + + + + +
+

Discussion

+

This property will return TVITrackPriorityStandard if no priority was specified by the publisher.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteAudioTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Track publications cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVIRemoteAudioTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteAudioTrackStats.html b/docs/5.8.0/Classes/TVIRemoteAudioTrackStats.html new file mode 100644 index 00000000..28c8f8f9 --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteAudioTrackStats.html @@ -0,0 +1,293 @@ + + + + + + TVIRemoteAudioTrackStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteAudioTrackStats Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIRemoteTrackStats : TVIBaseTrackStats : NSObject
Declared inTVIRemoteAudioTrackStats.h
+ + + + +
+ +

Overview

+

TVIRemoteAudioTrackStats represents stats about a remote audio track.

+
+ + + + + +
+ + + + + + +
+
+ +

  audioLevel +

+ +
+
+ +
+ + +
+

Audio output level.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger audioLevel
+ + + + + + + + + +
+

Discussion

+

The output level is an amplitude within the range of 0 to 32,767.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteAudioTrackStats.h

+
+ + +
+
+
+ +

  jitter +

+ +
+
+ +
+ + +
+

Packet jitter measured in milliseconds.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger jitter
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteAudioTrackStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Remote audio track stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteAudioTrackStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteDataTrack.html b/docs/5.8.0/Classes/TVIRemoteDataTrack.html new file mode 100644 index 00000000..8bf0fb5f --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteDataTrack.html @@ -0,0 +1,288 @@ + + + + + + TVIRemoteDataTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteDataTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIDataTrack : TVITrack : NSObject
Declared inTVIRemoteDataTrack.h
+ + + + +
+ +

Overview

+

TVIRemoteDataTrack represents a remote data track.

+
+ + + + + +
+ + + + + + +
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

The TVIRemoteDataTrackDelegate. Set this property to receive messages sent on the DataTrack.

+
+ + + +
@property (atomic, weak, nullable) id<TVIRemoteDataTrackDelegate> delegate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteDataTrack.h

+
+ + +
+
+
+ +

  sid +

+ +
+
+ +
+ + +
+

The sid of the remote data track.

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

Declared In

+

TVIRemoteDataTrack.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Tracks cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteDataTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteDataTrackPublication.html b/docs/5.8.0/Classes/TVIRemoteDataTrackPublication.html new file mode 100644 index 00000000..aaa16759 --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteDataTrackPublication.html @@ -0,0 +1,341 @@ + + + + + + TVIRemoteDataTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteDataTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIDataTrackPublication : TVITrackPublication : NSObject
Declared inTVIRemoteDataTrackPublication.h
+ + + + +
+ +

Overview

+

TVIRemoteDataTrackPublication contains the mapping between a published TVIRemoteDataTrack and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  trackSubscribed +

+ +
+
+ +
+ + +
+

Returns whether the Local Participant has subscribed to this track.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isTrackSubscribed) BOOL trackSubscribed
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteDataTrackPublication.h

+
+ + +
+
+
+ +

  remoteTrack +

+ +
+
+ +
+ + +
+

The remote data track associated with the track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIRemoteDataTrack *remoteTrack
+ + + + + + + + + +
+

Discussion

+

This property will return nil unless the Local Participant is subscribed to this track.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteDataTrackPublication.h

+
+ + +
+
+
+ +

  publishPriority +

+ +
+
+ +
+ + +
+

Get the TVITrackPriority set by the publisher for the corresponding TVIRemoteDataTrack.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) TVITrackPriority publishPriority
+ + + + + + + + + +
+

Discussion

+

This property will return TVITrackPriorityStandard if no priority was specified by the publisher.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteDataTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Track publications cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVIRemoteDataTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteParticipant.html b/docs/5.8.0/Classes/TVIRemoteParticipant.html new file mode 100644 index 00000000..1b75e3d3 --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteParticipant.html @@ -0,0 +1,375 @@ + + + + + + TVIRemoteParticipant Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteParticipant Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIParticipant : NSObject
Declared inTVIRemoteParticipant.h
+ + + + +
+ +

Overview

+

TVIRemoteParticipant represents a remote Participant in a Room which you are connected to.

+
+ + + + + +
+ + + + + + +
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

The Remote Participant’s delegate. Set this property to be notified about Participant events such as tracks being +added or removed.

+
+ + + +
@property (atomic, weak, nullable) id<TVIRemoteParticipantDelegate> delegate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

  remoteAudioTracks +

+ +
+
+ +
+ + +
+

The collection of Remote Audio Tracks.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVIRemoteAudioTrackPublication*> *remoteAudioTracks
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

  remoteVideoTracks +

+ +
+
+ +
+ + +
+

The collection of Remote Video Tracks.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVIRemoteVideoTrackPublication*> *remoteVideoTracks
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

  remoteDataTracks +

+ +
+
+ +
+ + +
+

The collection of Remote Data Tracks.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVIRemoteDataTrackPublication*> *remoteDataTracks
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use TwilioVideo connectWith* methods to join a TVIRoom with TVIRemoteParticipant instances.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteTrackStats.html b/docs/5.8.0/Classes/TVIRemoteTrackStats.html new file mode 100644 index 00000000..1b101cbe --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteTrackStats.html @@ -0,0 +1,288 @@ + + + + + + TVIRemoteTrackStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteTrackStats Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIBaseTrackStats : NSObject
Declared inTVIRemoteTrackStats.h
+ + + + +
+ +

Overview

+

TVIRemoteTrackStats represents stats common to remote tracks.

+
+ + + + + +
+ + + + + + +
+
+ +

  bytesReceived +

+ +
+
+ +
+ + +
+

Total number of bytes received.

+
+ + + +
@property (nonatomic, assign, readonly) int64_t bytesReceived
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteTrackStats.h

+
+ + +
+
+
+ +

  packetsReceived +

+ +
+
+ +
+ + +
+

Total number of packets received.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger packetsReceived
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteTrackStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Remote track stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteTrackStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteVideoTrack.html b/docs/5.8.0/Classes/TVIRemoteVideoTrack.html new file mode 100644 index 00000000..181e2463 --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteVideoTrack.html @@ -0,0 +1,496 @@ + + + + + + TVIRemoteVideoTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteVideoTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIVideoTrack : TVITrack : NSObject
Declared inTVIRemoteVideoTrack.h
+ + + + +
+ +

Overview

+

TVIRemoteVideoTrack represents a remote video track.

+
+ + + + + +
+ + + + + + +
+
+ +

  sid +

+ +
+
+ +
+ + +
+

The sid of the remote video track.

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

Declared In

+

TVIRemoteVideoTrack.h

+
+ + +
+
+
+ +

  switchedOff +

+ +
+
+ +
+ + +
+

Get whether the track is switched off.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isSwitchedOff) BOOL switchedOff
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteVideoTrack.h

+
+ + +
+
+
+ +

  priority +

+ +
+
+ +
+ + +
+

A nullable property set by the publisher for the corresponding TVIRemoteVideoTrack.

+
+ + + +
@property (nonatomic, copy, nullable) TVITrackPriority priority
+ + + + + + + + + +
+

Discussion

+

The default subscriber priority is nil, which indicates that the subscriber has not set a +priority for this TVIRemoteVideoTrack. If the TVIRemoteVideoTrack has been unsubscribed from then +this will return the last set priority. Setting this property to nil clears the subscribers TVITrackPriority for +this TVIRemoteVideoTrack.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrack.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Tracks cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrack.h

+
+ + +
+
+
+ +

– switchOff +

+ +
+
+ +
+ + +
+

Request to switch off a RemoteVideoTrack, if it is currently switched on.

+
+ + + +
- (void)switchOff
+ + + + + + + + + +
+

Discussion

+

This method must be called only if the clientTrackSwitchOffControl is set to manual in video bandwidth profile options.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrack.h

+
+ + +
+
+
+ +

– switchOn +

+ +
+
+ +
+ + +
+

Request to switch on a RemoteVideoTrack, if it was switched off using RemoteVideoTrack.switchOff().

+
+ + + +
- (void)switchOn
+ + + + + + + + + +
+

Discussion

+

This method must be called only if the clientTrackSwitchOffControl is set to manual in video bandwidth profile options. +Tracks may still remain switched off when available bandwidth is limited.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrack.h

+
+ + +
+
+
+ +

– setContentPreferences: +

+ +
+
+ +
+ + +
+

Sets the TVIVideoContentPreferences for the RemoteVideoTrack.

+
+ + + +
- (void)setContentPreferences:(nonnull TVIVideoContentPreferences *)contentPreferences
+ + + +
+

Parameters

+ + + + + + + +
contentPreferences

The TVIVideoContentPreferences for this RemoteVideoTrack.

+
+ + + + + + + +
+

Discussion

+

This method must be called only if the contentPreferencesMode is set to manual in video bandwidth profile options.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteVideoTrackPublication.html b/docs/5.8.0/Classes/TVIRemoteVideoTrackPublication.html new file mode 100644 index 00000000..24200b41 --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteVideoTrackPublication.html @@ -0,0 +1,341 @@ + + + + + + TVIRemoteVideoTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteVideoTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIVideoTrackPublication : TVITrackPublication : NSObject
Declared inTVIRemoteVideoTrackPublication.h
+ + + + +
+ +

Overview

+

TVIRemoteVideoTrackPublication contains the mapping between a published TVIRemoteVideoTrack and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  trackSubscribed +

+ +
+
+ +
+ + +
+

Returns whether the Local Participant has subscribed to this track.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isTrackSubscribed) BOOL trackSubscribed
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteVideoTrackPublication.h

+
+ + +
+
+
+ +

  remoteTrack +

+ +
+
+ +
+ + +
+

The remote video track associated with the track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIRemoteVideoTrack *remoteTrack
+ + + + + + + + + +
+

Discussion

+

This property will return nil unless the Local Participant is subscribed to this track.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrackPublication.h

+
+ + +
+
+
+ +

  publishPriority +

+ +
+
+ +
+ + +
+

Get the TVITrackPriority set by the publisher for the corresponding TVIRemoteVideoTrack.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) TVITrackPriority publishPriority
+ + + + + + + + + +
+

Discussion

+

This property will return TVITrackPriorityStandard if no priority was specified by the publisher.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Track publications cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRemoteVideoTrackStats.html b/docs/5.8.0/Classes/TVIRemoteVideoTrackStats.html new file mode 100644 index 00000000..d0be324e --- /dev/null +++ b/docs/5.8.0/Classes/TVIRemoteVideoTrackStats.html @@ -0,0 +1,288 @@ + + + + + + TVIRemoteVideoTrackStats Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteVideoTrackStats Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIRemoteTrackStats : TVIBaseTrackStats : NSObject
Declared inTVIRemoteVideoTrackStats.h
+ + + + +
+ +

Overview

+

TVIRemoteVideoTrackStats represents stats about a remote video track.

+
+ + + + + +
+ + + + + + +
+
+ +

  dimensions +

+ +
+
+ +
+ + +
+

Received frame dimensions.

+
+ + + +
@property (nonatomic, assign, readonly) CMVideoDimensions dimensions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteVideoTrackStats.h

+
+ + +
+
+
+ +

  frameRate +

+ +
+
+ +
+ + +
+

Received frame rate.

+
+ + + +
@property (nonatomic, assign, readonly) NSUInteger frameRate
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteVideoTrackStats.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Remote video track stats cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteVideoTrackStats.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIRoom.html b/docs/5.8.0/Classes/TVIRoom.html new file mode 100644 index 00000000..79fce7ea --- /dev/null +++ b/docs/5.8.0/Classes/TVIRoom.html @@ -0,0 +1,786 @@ + + + + + + TVIRoom Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRoom Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIRoom.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.

+
+ + + + + +
+ + + + + + +
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

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

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

Discussion

+

It is recommended that this property is only accessed on the delegateQueue specified in the TVIConnectOptions +when connecting to the room. If no explicit delegateQueue was provided, the main dispatch queue should be used.

+
+ + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

  dominantSpeaker +

+ +
+
+ +
+ + +
+

The dominant speaker in the Room.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIRemoteParticipant *dominantSpeaker
+ + + + + + + + + +
+

Discussion

+

Indicates the dominant speaker in the Room, if any; in some Rooms (Peer-to-Peer), this cannot be +computed, and so is always nil. This is part of the Dominant Speaker API and must be enabled by enabling +the dominantSpeakerEnabled option in TVIConnectOptions.

+
+ + + + + + + +
+

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

+
+ + +
+
+
+ +

  mediaRegion +

+ +
+
+ +
+ + +
+

The region where media is being processed.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) NSString *mediaRegion
+ + + + + + + + + +
+

Discussion

+

This property is set in a Group Room by the time the Room reaches +\ref TVIRoomStateConnected. The property is not set for Peer-to-Peer Rooms, because they do not +use a central media server for routing and/or recording.

+
+ + + + + + + +
+

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

+
+ + +
+
+
+ +

  remoteParticipants +

+ +
+
+ +
+ + +
+

A collection of connected Remote Participants to TVIRoom.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSArray<TVIRemoteParticipant*> *remoteParticipants
+ + + + + + + + + + + + + + + +
+

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

+
+ + +
+
+
+ +

– getRemoteParticipantWithSid: +

+ +
+
+ +
+ + +
+

Utility method which gets a Remote Participant using its sid.

+
+ + + +
- (nullable TVIRemoteParticipant *)getRemoteParticipantWithSid:(nonnull NSString *)sid
+ + + +
+

Parameters

+ + + + + + + +
sid

The sid.

+
+ + + +
+

Return Value

+

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

+
+ + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– disconnect +

+ +
+
+ +
+ + +
+

Disconnects from the Room.

+
+ + + +
- (void)disconnect
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– getStatsWithBlock: +

+ +
+
+ +
+ + +
+

Retrieve stats for all media tracks.

+
+ + + +
- (void)getStatsWithBlock:(nonnull TVIRoomGetStatsBlock)block
+ + + +
+

Parameters

+ + + + + + + +
block

The block to be invoked when the stats are available.

+
+ + + + + + + +
+

Discussion

+

Stats are retrieved asynchronously. In the case where the room is the TVIRoomStateDisconnected state, +reports won’t be delivered.

+
+ + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVISampleBufferVideoView.html b/docs/5.8.0/Classes/TVISampleBufferVideoView.html new file mode 100644 index 00000000..fd5be8a2 --- /dev/null +++ b/docs/5.8.0/Classes/TVISampleBufferVideoView.html @@ -0,0 +1,410 @@ + + + + + + TVISampleBufferVideoView Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVISampleBufferVideoView Class Reference

+ + +
+ + + + + + + + + + +
Inherits fromUIView
Conforms toTVIVideoRenderer
Declared inTVISampleBufferVideoView.h
+ + + + +
+ +

Overview

+

A TVISampleBufferVideoView draws video frames from a TVIVideoTrack. +TVISampleBufferVideoView should only be used on the application’s main thread. Subclassing TVISampleBufferVideoView is not supported. +UIViewContentModeScaleToFill, UIViewContentModeScaleAspectFill and UIViewContentModeScaleAspectFit are the +supported content modes.

+ +

When TVISampleBufferVideoView is contained within a UIWindowScene on iOS 13.0+, it registers for lifecycle notifications from the scene. When the view is used on +earlier versions of iOS or added to a UIWindow without a UIWindowScene, it registers for UIApplication lifecycle notifications instead.

+
+ + + + + +
+ + + + + + +
+
+ +

– initWithFrame:delegate: +

+ +
+
+ +
+ + +
+

Creates a video view with a frame and delegate.

+
+ + + +
- (null_unspecified instancetype)initWithFrame:(CGRect)frame delegate:(nullable id<TVISampleBufferVideoViewDelegate>)delegate
+ + + +
+

Parameters

+ + + + + + + + + + + + +
frame

The frame rectangle for the view.

delegate

An object implementing the TVISampleBufferVideoViewDelegate protocol (often a UIViewController).

+
+ + + +
+

Return Value

+

A renderer.

+
+ + + + + + + + + + + +
+

Declared In

+

TVISampleBufferVideoView.h

+
+ + +
+
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

A delegate which receives callbacks when important view rendering events occur.

+
+ + + +
@property (nonatomic, weak, nullable) id<TVISampleBufferVideoViewDelegate> delegate
+ + + + + + + + + +
+

Discussion

+

Note: The delegate is always called on the main thread in order to synchronize with UIKit.

+
+ + + + + + + +
+

Declared In

+

TVISampleBufferVideoView.h

+
+ + +
+
+
+ +

  videoDimensions +

+ +
+
+ +
+ + +
+

The dimensions of incoming video frames (without rotations applied). Use this to layout TVISampleBufferVideoView.

+
+ + + +
@property (nonatomic, assign, readonly) CMVideoDimensions videoDimensions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVISampleBufferVideoView.h

+
+ + +
+
+
+ +

  hasVideoData +

+ +
+
+ +
+ + +
+

Indicates that at least one frame of video data has been received.

+
+ + + +
@property (nonatomic, assign, readonly) BOOL hasVideoData
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVISampleBufferVideoView.h

+
+ + +
+
+
+ +

  mirror +

+ +
+
+ +
+ + +
+

Determines whether the view should be mirrored.

+
+ + + +
@property (nonatomic, assign, getter=shouldMirror) BOOL mirror
+ + + + + + + + + +
+

Discussion

+

This is useful when rendering the local feed from the front camera. The default is NO.

+
+ + + + + + + +
+

Declared In

+

TVISampleBufferVideoView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIStatsReport.html b/docs/5.8.0/Classes/TVIStatsReport.html new file mode 100644 index 00000000..c118ca98 --- /dev/null +++ b/docs/5.8.0/Classes/TVIStatsReport.html @@ -0,0 +1,503 @@ + + + + + + TVIStatsReport Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIStatsReport Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIStatsReport.h
+ + + + +
+ +

Overview

+

TVIStatsReport contains stats for all tracks associated with a single peer connection.

+
+ + + + + +
+ + + + + + +
+
+ +

  peerConnectionId +

+ +
+
+ +
+ + +
+

The id of peer connection related to this report.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *peerConnectionId
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIStatsReport.h

+
+ + +
+
+
+ +

  localAudioTrackStats +

+ +
+
+ +
+ + +
+

The stats for all local audio tracks in the peer connection.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) NSArray<TVILocalAudioTrackStats*> *localAudioTrackStats
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIStatsReport.h

+
+ + +
+
+
+ +

  localVideoTrackStats +

+ +
+
+ +
+ + +
+

The stats for all local video tracks in the peer connection.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) NSArray<TVILocalVideoTrackStats*> *localVideoTrackStats
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIStatsReport.h

+
+ + +
+
+
+ +

  remoteAudioTrackStats +

+ +
+
+ +
+ + +
+

The stats for all remote audio tracks in the peer connection.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) NSArray<TVIRemoteAudioTrackStats*> *remoteAudioTrackStats
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIStatsReport.h

+
+ + +
+
+
+ +

  remoteVideoTrackStats +

+ +
+
+ +
+ + +
+

The stats for all remote video tracks in the peer connection.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) NSArray<TVIRemoteVideoTrackStats*> *remoteVideoTrackStats
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIStatsReport.h

+
+ + +
+
+
+ +

  iceCandidateStats +

+ +
+
+ +
+ + +
+

The stats for all Ice candidates.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) NSArray<TVIIceCandidateStats*> *iceCandidateStats
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIStatsReport.h

+
+ + +
+
+
+ +

  iceCandidatePairStats +

+ +
+
+ +
+ + +
+

The stats for all Ice candidates pairs.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) NSArray<TVIIceCandidatePairStats*> *iceCandidatePairStats
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIStatsReport.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Stats report cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIStatsReport.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVITrack.html b/docs/5.8.0/Classes/TVITrack.html new file mode 100644 index 00000000..296c277e --- /dev/null +++ b/docs/5.8.0/Classes/TVITrack.html @@ -0,0 +1,331 @@ + + + + + + TVITrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVITrack Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVITrack.h
+ + + + +
+ +

Overview

+

TVITrack is the base class from which all other Track types are derived.

+
+ + + + + +
+ + + + + + +
+
+ +

  enabled +

+ +
+
+ +
+ + +
+

Indicates if the Track is enabled or not.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isEnabled) BOOL enabled
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVITrack.h

+
+ + +
+
+
+ +

  name +

+ +
+
+ +
+ + +
+

The Track name.

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

Declared In

+

TVITrack.h

+
+ + +
+
+
+ +

  state +

+ +
+
+ +
+ + +
+

The current state of the Track.

+
+ + + +
@property (nonatomic, assign, readonly) TVITrackState state
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVITrack.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

TVITrack cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVITrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVITrackPublication.html b/docs/5.8.0/Classes/TVITrackPublication.html new file mode 100644 index 00000000..f5ded495 --- /dev/null +++ b/docs/5.8.0/Classes/TVITrackPublication.html @@ -0,0 +1,374 @@ + + + + + + TVITrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVITrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVITrackPublication.h
+ + + + +
+ +

Overview

+

TVITrackPublication contains the mapping between a local track and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  track +

+ +
+
+ +
+ + +
+

The track associated with the track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVITrack *track
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVITrackPublication.h

+
+ + +
+
+
+ +

  trackEnabled +

+ +
+
+ +
+ + +
+

Indicates if the Track is enabled or not.

+
+ + + +
@property (nonatomic, assign, readonly, getter=isTrackEnabled) BOOL trackEnabled
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVITrackPublication.h

+
+ + +
+
+
+ +

  trackName +

+ +
+
+ +
+ + +
+

The Track name.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *trackName
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVITrackPublication.h

+
+ + +
+
+
+ +

  trackSid +

+ +
+
+ +
+ + +
+

The Local Tracks’s server identifier. This value uniquely identifies the Local Track within the scope of a Room.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) NSString *trackSid
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVITrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Published tracks cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVITrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIUserInterfaceTracker.html b/docs/5.8.0/Classes/TVIUserInterfaceTracker.html new file mode 100644 index 00000000..9d7470e6 --- /dev/null +++ b/docs/5.8.0/Classes/TVIUserInterfaceTracker.html @@ -0,0 +1,434 @@ + + + + + + TVIUserInterfaceTracker Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIUserInterfaceTracker Class Reference

+ + +
+ + + + + + + + + + +
Inherits fromNSObject
Conforms toTVICameraSourceOrientationTracker
Declared inTVICameraSourceOrientationTracker.h
+ + + + +
+ +

Overview

+

It is recommended that this class be constructed on the main thread.

+
+ + + + + +
+ + + + + + +
+
+ +

  orientation +

+ +
+
+ +
+ + +
+

The currently observed orientation based upon the UIApplication or UIScene.

+
+ + + +
@property (nonatomic, assign, readonly) AVCaptureVideoOrientation orientation
+ + + + + + + + + +
+

Discussion

+

It is highly recommended to construct this class on the main thread. +When the tracker is constructed off the main thread, this property is eventually consistent with the state of the user interface, otherwise it is updated immediately. +UInterfaceOrientation is mapped directly to AVCaptureVideoOrientation except for UIIntefaceOrientationUnknown which is translated to AVCaptureVideoOrientationLandscapeRight.

+
+ + + + + + + +
+

Declared In

+

TVICameraSourceOrientationTracker.h

+
+ + +
+
+
+ +

  scene +

+ +
+
+ +
+ + +
+

The scene that is being monitored for orientation changes.

+
+ + + +
@property (nonatomic, weak, readonly, nullable) UIWindowScene *scene
+ + + + + + + + + +
+

Discussion

+

If +[TVIUserInterfaceTracker sceneInterfaceOrientationDidChange:] is called, and the scene provided matches this property, then the Tracker +will read an updated orientation from the scene.

+
+ + + + + + + +
+

Declared In

+

TVICameraSourceOrientationTracker.h

+
+ + +
+
+
+ +

+ tracker +

+ +
+
+ +
+ + +
+

Creates a default TVIUserInterfaceTracker that monitors UIApplication for orientation changes.

+
+ + + +
+ (nonnull instancetype)tracker
+ + + + + +
+

Return Value

+

An instance of TVIUserInterfaceTracker.

+
+ + + + + + + + + + + +
+

Declared In

+

TVICameraSourceOrientationTracker.h

+
+ + +
+
+
+ +

+ trackerWithScene: +

+ +
+
+ +
+ + +
+

Creates a TVIUserInterfaceTracker that monitors a UIWindowScene for orientation changes.

+
+ + + +
+ (nonnull instancetype)trackerWithScene:(nonnull UIWindowScene *)scene
+ + + +
+

Parameters

+ + + + + + + +
scene

The scene that should be monitored for orientation changes.

+
+ + + +
+

Return Value

+

An instance of TVIUserInterfaceTracker.

+
+ + + + + + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVICameraSourceOrientationTracker.h

+
+ + +
+
+
+ +

+ sceneInterfaceOrientationDidChange: +

+ +
+
+ +
+ + +
+

Informs interested TVIUserInterfaceTracker instances that the orientation of a UIWindowScene has changed.

+
+ + + +
+ (void)sceneInterfaceOrientationDidChange:(nonnull UIWindowScene *)scene
+ + + +
+

Parameters

+ + + + + + + +
scene

The scene that has changed.

+
+ + + + + + + +
+

Discussion

+

If you created a tracker using +[TVIUserInterfaceTracker trackerWithScene:] then you should call this method within +-[UIWindowSceneDelegate windowScene:didUpdateCoordinateSpace:interfaceOrientation:traitCollection:]

+
+ + + + + + + +
+

Declared In

+

TVICameraSourceOrientationTracker.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoBandwidthProfileOptions.html b/docs/5.8.0/Classes/TVIVideoBandwidthProfileOptions.html new file mode 100644 index 00000000..3c108f09 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoBandwidthProfileOptions.html @@ -0,0 +1,648 @@ + + + + + + TVIVideoBandwidthProfileOptions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoBandwidthProfileOptions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoBandwidthProfileOptions.h
+ + + + +
+ +

Overview

+

VideoBandwidthProfileOptions enables you to configure how available bandwidth is shared among the +TVIRemoteVideoTrack(s) in a Group Room.

+
+ + + + + +
+ + + + + + +
+
+ +

  clientTrackSwitchOffControl +

+ +
+
+ +
+ + +
+

Optional parameter to configure the mode for switching off/on subscribed RemoteVideoTracks based on the subscriber’s rendering environment. +Switching off a RemoteVideoTrack means no media is sent by the media server to the client for that track even though it has been subscribed to by the client. +This feature helps in conserving network bandwidth and CPU resources by avoiding unnecessary transmission and decoding of remote tracks. +This feature supersedes the maxTracks parameter.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) TVIClientTrackSwitchOffControl clientTrackSwitchOffControl
+ + + + + + + + + +
+

Discussion

+

The default value is TVIClientTrackSwitchOffControlAuto.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  contentPreferencesMode +

+ +
+
+ +
+ + +
+

Optional parameter to configure the mode for specifying content preferences for the TVIRemoteVideoTrack. When set to TVIVideoContentPreferencesModeAuto +the SDK determines the render dimensions by inspecting the attached TVIVideoViews. TVIRemoteVideoTracks rendered in smaller TVIVideoViews will receive a +lower resolution stream compared to the video rendered in larger TVIVideoViews. When set to TVIVideoContentPreferencesModeManual you can set the dimensions +programmatically by calling TVIRemoteVideoTrack.setContentPreferences(). This feature supersedes the renderDimensions parameter.

+
+ + + +
@property (nonatomic, copy, readonly, nonnull) TVIVideoContentPreferencesMode contentPreferencesMode
+ + + + + + + + + +
+

Discussion

+

The default value is TVIVideoContentPreferencesModeAuto.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  dominantSpeakerPriority +

+ +
+
+ +
+ + +
+

Optional property to specify the default TrackPriority of the Dominant Speaker’s TVIRemoteVideoTrack(s).

+
+ + + +
@property (nonatomic, copy, readonly, nullable) TVITrackPriority dominantSpeakerPriority
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  maxSubscriptionBitrate +

+ +
+
+ +
+ + +
+

Optional property to specify the maximum downlink video bandwidth in Kilobits per second (Kbps).

+
+ + + +
@property (nonatomic, strong, readonly, nullable) NSNumber *maxSubscriptionBitrate
+ + + + + + + + + +
+

Discussion

+

The maximum bitrate for subscribed TVIRemoteVideoTracks, or none to allow +the maximum possible in the Room. The default is 2,400 Kbps.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  maxTracks +

+ +
+
+ +
+ + +
+

Optional property to specify the maximum number of visible TVIRemoteVideoTracks selected +first using TrackPriority and second using an N-Loudest policy.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) NSNumber *maxTracks
+ + + + + + + + + +
+

Discussion

+

The maximum number of video tracks. By default there are no limits on the number of +visible TVIRemoteVideoTracks. This property is deprecated in favor of clientTrackSwitchOffControl.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  mode +

+ +
+
+ +
+ + +
+

Optional property to specify how TVIRemoteVideoTracks TrackPriority values are mapped to bandwidth +allocation in Group Rooms.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) TVIBandwidthProfileMode mode
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  renderDimensions +

+ +
+
+ +
+ + +
+

VideoRenderDimensions allows you to specify the desired render dimensions of TVIRemoteVideoTracks +based on TrackPriority and the TVIRemoteVideoTracks of the Dominant Speaker. The bandwidth allocation algorithm +will distribute the available downlink bandwidth proportional to the requested render dimensions.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIVideoRenderDimensions *renderDimensions
+ + + + + + + + + +
+

Discussion

+

This property is deprecated in favor of contentPreferencesMode.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  trackSwitchOffMode +

+ +
+
+ +
+ + +
+

Optional property to configure how TVIRemoteVideoTrack(s) are switched off.

+
+ + + +
@property (nonatomic, copy, readonly, nullable) TVITrackSwitchOffMode trackSwitchOffMode
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

+ optionsWithBlock: +

+ +
+
+ +
+ + +
+

Creates an instance of TVIVideoBandwidthProfileOptions using a builder block.

+
+ + + +
+ (nonnull instancetype)optionsWithBlock:(nonnull TVIVideoBandwidthProfileOptionsBuilderBlock)block
+ + + +
+

Parameters

+ + + + + + + +
block

The builder block which will be used to configure the TVIVideoBandwidthProfileOptions instance.

+
+ + + +
+

Return Value

+

An instance of TVIVideoBandwidthProfileOptions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use the class methods optionsWithBlock: instead.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoBandwidthProfileOptionsBuilder.html b/docs/5.8.0/Classes/TVIVideoBandwidthProfileOptionsBuilder.html new file mode 100644 index 00000000..1072d8a9 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoBandwidthProfileOptionsBuilder.html @@ -0,0 +1,581 @@ + + + + + + TVIVideoBandwidthProfileOptionsBuilder Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoBandwidthProfileOptionsBuilder Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoBandwidthProfileOptions.h
+ + + + +
+ +

Overview

+

TVIVideoBandwidthProfileOptionsBuilder is a builder for TVIVideoBandwidthProfileOptions.

+
+ + + + + +
+ + + + + + +
+
+ +

  clientTrackSwitchOffControl +

+ +
+
+ +
+ + +
+

Optional parameter to configure the mode for switching off/on subscribed RemoteVideoTracks based on the subscriber’s rendering environment. +Switching off a RemoteVideoTrack means no media is sent by the media server to the client for that track even though it has been subscribed to by the client. +This feature helps in conserving network bandwidth and CPU resources by avoiding unnecessary transmission and decoding of remote tracks. +This feature supersedes the maxTracks parameter. Attempting to set clientTrackSwitchOffControl when maxTracks is already set will throw an exception.

+
+ + + +
@property (nonatomic, copy, nullable) TVIClientTrackSwitchOffControl clientTrackSwitchOffControl
+ + + + + + + + + +
+

Discussion

+

The default value is TVIClientTrackSwitchOffControlAuto.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  contentPreferencesMode +

+ +
+
+ +
+ + +
+

Optional parameter to configure the mode for specifying content preferences for the TVIRemoteVideoTrack. When set to TVIVideoContentPreferencesModeAuto +the SDK determines the render dimensions by inspecting the attached TVIVideoViews. TVIRemoteVideoTracks rendered in smaller TVIVideoViews will receive a +lower resolution stream compared to the video rendered in larger TVIVideoViews. When set to TVIVideoContentPreferencesModeManual you can set the dimensions +programmatically by calling TVIRemoteVideoTrack.setContentPreferences(). This feature supersedes the renderDimensions parameter. Attempting to set +contentPreferencesMode when renderDimensions is already set will throw an exception.

+
+ + + +
@property (nonatomic, copy, nullable) TVIVideoContentPreferencesMode contentPreferencesMode
+ + + + + + + + + +
+

Discussion

+

The default value is TVIVideoContentPreferencesModeAuto

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  dominantSpeakerPriority +

+ +
+
+ +
+ + +
+

Optional property to specify the default TrackPriority of the Dominant Speaker’s TVIRemoteVideoTrack(s).

+
+ + + +
@property (nonatomic, copy, nullable) TVITrackPriority dominantSpeakerPriority
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  maxSubscriptionBitrate +

+ +
+
+ +
+ + +
+

Optional property to specify the maximum downlink video bandwidth in Kilobits per second (Kbps).

+
+ + + +
@property (nonatomic, strong, nullable) NSNumber *maxSubscriptionBitrate
+ + + + + + + + + +
+

Discussion

+

The maximum bitrate for subscribed TVIRemoteVideoTracks, or none to allow +the maximum possible in the Room. The default is 2,400 Kbps.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  maxTracks +

+ +
+
+ +
+ + +
+

Optional property to specify the maximum number of visible TVIRemoteVideoTracks selected +first using TrackPriority and second using an N-Loudest policy.

+
+ + + +
@property (nonatomic, strong, nullable) NSNumber *maxTracks
+ + + + + + + + + +
+

Discussion

+

The maximum number of video tracks. By default there are no limits on the number of +visible TVIRemoteVideoTracks. This property is deprecated in favor of clientTrackSwitchOffControl. +Attempting to set maxTracks when clientTrackSwitchOffControl is already set will throw an exception.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  mode +

+ +
+
+ +
+ + +
+

Optional property to specify how TVIRemoteVideoTracks TrackPriority values are mapped to bandwidth +allocation in Group Rooms.

+
+ + + +
@property (nonatomic, copy, nullable) TVIBandwidthProfileMode mode
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  renderDimensions +

+ +
+
+ +
+ + +
+

VideoRenderDimensions allows you to specify the desired render dimensions of TVIRemoteVideoTracks +based on TrackPriority and the TVIRemoteVideoTracks of the Dominant Speaker. The bandwidth allocation algorithm +will distribute the available downlink bandwidth proportional to the requested render dimensions.

+
+ + + +
@property (nonatomic, strong, nullable) TVIVideoRenderDimensions *renderDimensions
+ + + + + + + + + +
+

Discussion

+

This property is deprecated in favor of contentPreferencesMode. Attempting to set renderDimensions +when contentPreferencesMode is already set will throw an exception.

+
+ + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  trackSwitchOffMode +

+ +
+
+ +
+ + +
+

Optional property to configure how TVIRemoteVideoTrack(s) are switched off.

+
+ + + +
@property (nonatomic, copy, nullable) TVITrackSwitchOffMode trackSwitchOffMode
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

You should not initialize TVIVideoBandwidthProfileOptionsBuilder directly, use a TVIVideoBandwidthProfileOptionsBuilderBlock instead.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoCodec.html b/docs/5.8.0/Classes/TVIVideoCodec.html new file mode 100644 index 00000000..6284abb2 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoCodec.html @@ -0,0 +1,245 @@ + + + + + + TVIVideoCodec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoCodec Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoCodec.h
+ + + + +
+ +

Overview

+

TVIVideoCodec is the base class for all supported video codecs.

+
+ + + + + +
+ + + + + + +
+
+ +

  name +

+ +
+
+ +
+ + +
+

The name of the video codec.

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

Declared In

+

TVIVideoCodec.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

TVIVideoCodec can not be created with init. To use an video codec, use one of the TVIVideoCodec subclasses.

+
+ + + + + + + +
+

Declared In

+

TVIVideoCodec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoContentPreferences.html b/docs/5.8.0/Classes/TVIVideoContentPreferences.html new file mode 100644 index 00000000..b71e1e73 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoContentPreferences.html @@ -0,0 +1,309 @@ + + + + + + TVIVideoContentPreferences Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoContentPreferences Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoContentPreferences.h
+ + + + +
+ +

Overview

+

TVIVideoContentPreferences represents the subscriber’s preferences for a TVIRemoveVideoTrack.

+
+ + + + + +
+ + + + + + +
+
+ +

  renderDimensions +

+ +
+
+ +
+ + +
+

Indicates the render dimensions for a TVIRemoteVideoTrack represented as TVIVideoDimensions.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIVideoDimensions *renderDimensions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoContentPreferences.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use the class method preferencesWithBlock: instead.

+
+ + + + + + + +
+

Declared In

+

TVIVideoContentPreferences.h

+
+ + +
+
+
+ +

+ preferencesWithBlock: +

+ +
+
+ +
+ + +
+

Constructs TVIVideoContentPreferences using the builder pattern.

+
+ + + +
+ (null_unspecified instancetype)preferencesWithBlock:(nonnull TVIVideoContentPreferencesBuilderBlock)block
+ + + +
+

Parameters

+ + + + + + + +
block

The builder block which will be used to configure the TVIVideoContentPreferences instance.

+
+ + + +
+

Return Value

+

An instance of TVIVideoContentPreferences.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIVideoContentPreferences.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoContentPreferencesBuilder.html b/docs/5.8.0/Classes/TVIVideoContentPreferencesBuilder.html new file mode 100644 index 00000000..976c45b7 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoContentPreferencesBuilder.html @@ -0,0 +1,240 @@ + + + + + + TVIVideoContentPreferencesBuilder Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoContentPreferencesBuilder Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoContentPreferences.h
+ + + + +
+ +

Overview

+

TVIVideoContentPreferencesBuilder is a builder class for TVIVideoContentPreferences.

+
+ + + + + +
+ + + + + + +
+
+ +

  renderDimensions +

+ +
+
+ +
+ + +
+

Indicates the render dimensions for a TVIRemoteVideoTrack represented as TVIVideoDimensions.

+
+ + + +
@property (nonatomic, strong, nullable) TVIVideoDimensions *renderDimensions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoContentPreferences.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

You should not initialize TVIVideoContentPreferencesBuilder directly, use a TVIVideoContentPreferencesBuilderBlock instead.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoContentPreferences.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoDimensions.html b/docs/5.8.0/Classes/TVIVideoDimensions.html new file mode 100644 index 00000000..8868232e --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoDimensions.html @@ -0,0 +1,357 @@ + + + + + + TVIVideoDimensions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoDimensions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoDimensions.h
+ + + + +
+ +

Overview

+

TVIVideoDimensions represents dimensions for a VideoTrack.

+
+ + + + + +
+ + + + + + +
+
+ +

  width +

+ +
+
+ +
+ + +
+

The video width.

+
+ + + +
@property (nonatomic, assign) NSUInteger width
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoDimensions.h

+
+ + +
+
+
+ +

  height +

+ +
+
+ +
+ + +
+

The video height.

+
+ + + +
@property (nonatomic, assign) NSUInteger height
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoDimensions.h

+
+ + +
+
+
+ +

+ dimensionsWithWidth:height: +

+ +
+
+ +
+ + +
+

Creates an instance of TVIVideoDimensions.

+
+ + + +
+ (nonnull instancetype)dimensionsWithWidth:(NSUInteger)width height:(NSUInteger)height
+ + + +
+

Parameters

+ + + + + + + + + + + + +
width

The video width.

height

The video height.

+
+ + + +
+

Return Value

+

An instance of TVIVideoDimensions.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIVideoDimensions.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Use the class methods dimensionsWithWidth:height: instead.

+
+ + + + + + + +
+

Declared In

+

TVIVideoDimensions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoFormat.html b/docs/5.8.0/Classes/TVIVideoFormat.html new file mode 100644 index 00000000..86f8f604 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoFormat.html @@ -0,0 +1,295 @@ + + + + + + TVIVideoFormat Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoFormat Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoFormat.h
+ + + + +
+ +

Overview

+

TVIVideoFormat describes the properties of video content which a TVIVideoSource produces. +A capturer can support many formats, but only one will be selected when capture is started.

+
+ + + + + +
+ + + + + + +
+
+ +

  dimensions +

+ +
+
+ +
+ + +
+

The size of the video content.

+
+ + + +
@property (nonatomic, assign) CMVideoDimensions dimensions
+ + + + + + + + + +
+

Discussion

+

Dimensions should be in the native coordinate system of your capturer (before rotations are applied).

+
+ + + + + + + +
+

Declared In

+

TVIVideoFormat.h

+
+ + +
+
+
+ +

  frameRate +

+ +
+
+ +
+ + +
+

The frame rate of the video content.

+
+ + + +
@property (nonatomic, assign) NSUInteger frameRate
+ + + + + + + + + +
+

Discussion

+

This value should be greater than zero.

+
+ + + + + + + +
+

Declared In

+

TVIVideoFormat.h

+
+ + +
+
+
+ +

  pixelFormat +

+ +
+
+ +
+ + +
+

The pixel format of the video content.

+
+ + + +
@property (nonatomic, assign) TVIPixelFormat pixelFormat
+ + + + + + + + + +
+

Discussion

+

This should be set to one of the supported values defined in TVIPixelFormat.

+
+ + + + + + + +
+

Declared In

+

TVIVideoFormat.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoFrame.html b/docs/5.8.0/Classes/TVIVideoFrame.html new file mode 100644 index 00000000..0045aa35 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoFrame.html @@ -0,0 +1,586 @@ + + + + + + TVIVideoFrame Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoFrame Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoFrame.h
+ + + + +
+ +

Overview

+

A video frame which has been captured or decoded.

TVIVideoFrame represents a CoreVideo buffer, along with metadata important for rendering and encoding.

+
+ + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t use this initializer.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Create using initWithTimestamp:buffer:orientation: instead.

+
+ + + + + + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + +
+
+
+ +

– initWithTimestamp:buffer:orientation: +

+ +
+
+ +
+ + +
+

Initialize a video frame that has been captured.

+
+ + + +
- (nullable instancetype)initWithTimestamp:(CMTime)timestamp buffer:(nonnull CVImageBufferRef)imageBuffer orientation:(TVIVideoOrientation)orientation
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
timestamp

A CMTime struct which represents the time at which this frame was captured.

imageBuffer

A CVImageBufferRef which conforms to one of the pixel formats defined by TVIPixelFormat. +This buffer is retained for the lifetime of TVIVideoFrame.

orientation

The orientation at which this frame was captured.

+
+ + + + + + + +
+

Discussion

+

Use this initializer if you already have a CMTime representation of your capture timestamp. Please note +that this timestamp may be internally translated after being delivered to the TVIVideoSink and before +being raised to your renderer(s).

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + +
+
+
+ +

– initWithTimeInterval:buffer:orientation: +

+ +
+
+ +
+ + +
+

Initialize a video frame that has been captured.

+
+ + + +
- (nullable instancetype)initWithTimeInterval:(CFTimeInterval)timeInterval buffer:(nonnull CVImageBufferRef)imageBuffer orientation:(TVIVideoOrientation)orientation
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
timeInterval

A CFTimeInterval which represents the time when this frame was captured.

imageBuffer

A CVImageBufferRef which conforms to one of the pixel formats defined by TVIPixelFormat. +This buffer is retained for the lifetime of TVIVideoFrame.

orientation

The orientation at which this frame was captured.

+
+ + + + + + + +
+

Discussion

+

This convenience initializer will convert a CFTimeInterval into a CMTime using a timescale appropriate +for the underlying media engine.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + +
+
+
+ +

  timestamp +

+ +
+
+ +
+ + +
+

The timestamp at which this frame was captured, or should be rendered.

+
+ + + +
@property (nonatomic, assign, readonly) CMTime timestamp
+ + + + + + + + + +
+

Discussion

+

For decoded frames this is the display time measured using the system monotonic clock. +For captured frames this should be the capture time measured using the timebase of the capturer.

+
+ + + + + + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + +
+
+
+ +

  width +

+ +
+
+ +
+ + +
+

A convenience getter which returns the width of imageBuffer.

+
+ + + +
@property (nonatomic, assign, readonly) size_t width
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + +
+
+
+ +

  height +

+ +
+
+ +
+ + +
+

A convenience getter which returns the height of imageBuffer.

+
+ + + +
@property (nonatomic, assign, readonly) size_t height
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + +
+
+
+ +

  imageBuffer +

+ +
+
+ +
+ + +
+

A CVImageBuffer which contains the image data for the frame.

+
+ + + +
@property (nonatomic, assign, readonly, nonnull) CVImageBufferRef imageBuffer
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + +
+
+
+ +

  orientation +

+ +
+
+ +
+ + +
+

The orientation metadata for the frame.

+
+ + + +
@property (nonatomic, assign, readonly) TVIVideoOrientation orientation
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoRenderDimensions.html b/docs/5.8.0/Classes/TVIVideoRenderDimensions.html new file mode 100644 index 00000000..ca6b7c06 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoRenderDimensions.html @@ -0,0 +1,281 @@ + + + + + + TVIVideoRenderDimensions Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoRenderDimensions Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTVIVideoBandwidthProfileOptions.h
+ + + + +
+ +

Overview

+

TVIVideoRenderDimensions represents dimensions for a VideoTrack.

TVIVideoRenderDimensions allows you to specify the desired render dimensions +of TVIRemoteVideoTracks based on TrackPriority and the TVIRemoteVideoTracks of the Dominant Speaker. The bandwidth +allocation algorithm will distribute the available downlink bandwidth proportional to the requested render dimensions.

+
+ + + + + +
+ + + + + + +
+
+ +

  low +

+ +
+
+ +
+ + +
+

VideoDimensions for low priority Tracks.

+
+ + + +
@property (nonatomic, strong, nullable) TVIVideoDimensions *low
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  standard +

+ +
+
+ +
+ + +
+

VideoDimensions for track priority standard.

+
+ + + +
@property (nonatomic, strong, nullable) TVIVideoDimensions *standard
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+ +

  high +

+ +
+
+ +
+ + +
+

VideoDimensions for track priority high.

+
+ + + +
@property (nonatomic, strong, nullable) TVIVideoDimensions *high
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoBandwidthProfileOptions.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoTrack.html b/docs/5.8.0/Classes/TVIVideoTrack.html new file mode 100644 index 00000000..8efd466c --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoTrack.html @@ -0,0 +1,365 @@ + + + + + + TVIVideoTrack Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoTrack Class Reference

+ + +
+ + + + + + + +
Inherits fromTVITrack : NSObject
Declared inTVIVideoTrack.h
+ + + + +
+ +

Overview

+

TVIVideoTrack represents video, and provides an interface to render frames from the track.

+
+ + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Tracks cannot be created explicitly.

+
+ + + + + + + +
+

Declared In

+

TVIVideoTrack.h

+
+ + +
+
+
+ +

  renderers +

+ +
+
+ +
+ + +
+

An array of renderers that are currently attached to the video track.

+
+ + + +
@property (nonatomic, strong, readonly, nonnull) NSArray<id<TVIVideoRenderer> > *renderers
+ + + + + + + + + +
+

Discussion

+

Note: Use the ‘addRenderer:’ and ‘removeRenderer:’ methods to manipulate this collection.

+
+ + + + + + + +
+

Declared In

+

TVIVideoTrack.h

+
+ + +
+
+
+ +

– addRenderer: +

+ +
+
+ +
+ + +
+

Adds a renderer to the video track. Renderers provide fine control over how video is displayed.

+
+ + + +
- (void)addRenderer:(nonnull id<TVIVideoRenderer>)renderer
+ + + +
+

Parameters

+ + + + + + + +
renderer

An object or swift struct that implements the TVIVideoRenderer protocol.

+
+ + + + + + + +
+

Discussion

+

Calling addRenderer multiple times with the same renderer will result in an NSInvalidArgumentException.

+
+ + + + + + + +
+

Declared In

+

TVIVideoTrack.h

+
+ + +
+
+
+ +

– removeRenderer: +

+ +
+
+ +
+ + +
+

Removes a renderer from the video track.

+
+ + + +
- (void)removeRenderer:(nonnull id<TVIVideoRenderer>)renderer
+ + + +
+

Parameters

+ + + + + + + +
renderer

An object or swift struct that implements the TVIVideoRenderer protocol.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIVideoTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoTrackPublication.html b/docs/5.8.0/Classes/TVIVideoTrackPublication.html new file mode 100644 index 00000000..63842a3e --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoTrackPublication.html @@ -0,0 +1,245 @@ + + + + + + TVIVideoTrackPublication Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoTrackPublication Class Reference

+ + +
+ + + + + + + +
Inherits fromTVITrackPublication : NSObject
Declared inTVIVideoTrackPublication.h
+ + + + +
+ +

Overview

+

TVIVideoTrackPublication contains the mapping between a video track and its server generated sid.

+
+ + + + + +
+ + + + + + +
+
+ +

  videoTrack +

+ +
+
+ +
+ + +
+

The video track associated with the video track publication.

+
+ + + +
@property (nonatomic, strong, readonly, nullable) TVIVideoTrack *videoTrack
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoTrackPublication.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Developers shouldn’t initialize this class directly.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Published tracks cannot be created explicitly

+
+ + + + + + + +
+

Declared In

+

TVIVideoTrackPublication.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoTrackStoringSampleBufferVideoView.html b/docs/5.8.0/Classes/TVIVideoTrackStoringSampleBufferVideoView.html new file mode 100644 index 00000000..4d810f87 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoTrackStoringSampleBufferVideoView.html @@ -0,0 +1,194 @@ + + + + + + TVIVideoTrackStoringSampleBufferVideoView Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoTrackStoringSampleBufferVideoView Class Reference

+ + +
+ + + + + + + +
Inherits fromTVISampleBufferVideoView : UIView
Declared inTVIVideoTrackStoringSampleBufferVideoView.h
+ + + + +
+ +

Overview

+

TVIVideoTrackStoringSampleBufferVideoView stores and manages a video track which is associated with a video view. +This class can be used to simplify the implementation of Picture in Picture.

+
+ + + + + +
+ + + + + + +
+
+ +

  videoTrack +

+ +
+
+ +
+ + +
+

Use this property to set or retrieve the TVIVideoTrack.

+
+ + + +
@property (nonatomic, strong, nullable) TVIVideoTrack *videoTrack
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoTrackStoringSampleBufferVideoView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVideoView.html b/docs/5.8.0/Classes/TVIVideoView.html new file mode 100644 index 00000000..2ef19441 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVideoView.html @@ -0,0 +1,505 @@ + + + + + + TVIVideoView Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoView Class Reference

+ + +
+ + + + + + + + + + +
Inherits fromUIView
Conforms toTVIVideoRenderer
Declared inTVIVideoView.h
+ + + + +
+ +

Overview

+

A TVIVideoView draws video frames from a TVIVideoTrack. +TVIVideoView should only be used on the application’s main thread. Subclassing TVIVideoView is not supported. +UIViewContentModeScaleToFill, UIViewContentModeScaleAspectFill and UIViewContentModeScaleAspectFit are the +supported content modes.

+ +

When TVIVideoView is contained within a UIWindowScene on iOS 13.0+, it registers for lifecycle notifications from the scene. When the view is used on +earlier versions of iOS or added to a UIWindow without a UIWindowScene, it registers for UIApplication lifecycle notifications instead.

+ +

Since the TVIVideoView uses metal, video rendering on iOS 11.x simulators is not supported.

+
+ + + + + +
+ + + + + + +
+
+ +

– initWithFrame:delegate: +

+ +
+
+ +
+ + +
+

Creates a video view with a frame and delegate.

+
+ + + +
- (null_unspecified instancetype)initWithFrame:(CGRect)frame delegate:(nullable id<TVIVideoViewDelegate>)delegate
+ + + +
+

Parameters

+ + + + + + + + + + + + +
frame

The frame rectangle for the view.

delegate

An object implementing the TVIVideoViewDelegate protocol (often a UIViewController).

+
+ + + +
+

Return Value

+

A renderer.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+ +

  delegate +

+ +
+
+ +
+ + +
+

A delegate which receives callbacks when important view rendering events occur.

+
+ + + +
@property (nonatomic, weak, nullable) id<TVIVideoViewDelegate> delegate
+ + + + + + + + + +
+

Discussion

+

Note: The delegate is always called on the main thread in order to synchronize with UIKit.

+
+ + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+ +

  viewShouldRotateContent +

+ +
+
+ +
+ + +
+

Specify if the video view or the application will handle rotated video content.

+
+ + + +
@property (nonatomic, assign) BOOL viewShouldRotateContent
+ + + + + + + + + +
+

Discussion

+

Handling rotations at the application level is more complex, but allows you to smoothly animate +transitions. By default, video frame rotation is performed by TVIVideoView. Set this property to NO if +you want to handle rotations in your own layout using `[TVIVideoViewDelegate videoView:videoOrientationDidChange:].

+
+ + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+ +

  videoDimensions +

+ +
+
+ +
+ + +
+

The dimensions of incoming video frames (without rotations applied). Use this to layout TVIVideoView.

+
+ + + +
@property (nonatomic, assign, readonly) CMVideoDimensions videoDimensions
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+ +

  videoOrientation +

+ +
+
+ +
+ + +
+

The orientation of incoming video frames. Use this to layout TVIVideoView.

+
+ + + +
@property (nonatomic, assign, readonly) TVIVideoOrientation videoOrientation
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+ +

  hasVideoData +

+ +
+
+ +
+ + +
+

Indicates that at least one frame of video data has been received.

+
+ + + +
@property (atomic, assign, readonly) BOOL hasVideoData
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+ +

  mirror +

+ +
+
+ +
+ + +
+

Determines whether the view should be mirrored.

+
+ + + +
@property (nonatomic, assign, getter=shouldMirror) BOOL mirror
+ + + + + + + + + +
+

Discussion

+

This is useful when rendering the local feed from the front camera. The default is NO.

+
+ + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVp8Codec.html b/docs/5.8.0/Classes/TVIVp8Codec.html new file mode 100644 index 00000000..5086cdb4 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVp8Codec.html @@ -0,0 +1,306 @@ + + + + + + TVIVp8Codec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVp8Codec Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIVideoCodec : NSObject
Declared inTVIVp8Codec.h
+ + + + + + + + +
+ + + + + + +
+
+ +

  simulcast +

+ +
+
+ +
+ + +
+

Whether simulcast is enabled.

+
+ + + +
@property (nonatomic, readonly, getter=isSimulcast) BOOL simulcast
+ + + + + + + + + +
+

Discussion

+

Enabling simulcast causes the encoder to generate multiple spatial and temporal +layers for the video that is published. This feature should only be enabled in a Group Room. +Simulcast is disabled by default.

+
+ + + + + + + +
+

Declared In

+

TVIVp8Codec.h

+
+ + +
+
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initialzes an instance of the TVIVp8Codec codec.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Initialzes an instance of the TVIVp8Codec codec.

+
+ + + + + + + +
+

Declared In

+

TVIVp8Codec.h

+
+ + +
+
+
+ +

– initWithSimulcast: +

+ +
+
+ +
+ + +
+

Initialzes an instance of the TVIVp8Codec codec.

+
+ + + +
- (nonnull instancetype)initWithSimulcast:(BOOL)simulcast
+ + + +
+

Parameters

+ + + + + + + +
simulcast

A boolean to indicate if simulcast is enabled.

+
+ + + +
+

Return Value

+

A TVIVp8Codec object.

+
+ + + + + + + + + + + +
+

Declared In

+

TVIVp8Codec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TVIVp9Codec.html b/docs/5.8.0/Classes/TVIVp9Codec.html new file mode 100644 index 00000000..b7cd0094 --- /dev/null +++ b/docs/5.8.0/Classes/TVIVp9Codec.html @@ -0,0 +1,192 @@ + + + + + + TVIVp9Codec Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVp9Codec Class Reference

+ + +
+ + + + + + + +
Inherits fromTVIVideoCodec : NSObject
Declared inTVIVp9Codec.h
+ + + + + + + + +
+ + + + + + +
+
+ +

– init +

+ +
+
+ +
+ + +
+

Initialzes an instance of the TVIVp9Codec codec.

+
+ + + +
- (null_unspecified instancetype)init
+ + + + + + + + + +
+

Discussion

+

Initialzes an instance of the TVIVp9Codec codec.

+
+ + + + + + + +
+

Declared In

+

TVIVp9Codec.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Classes/TwilioVideoSDK.html b/docs/5.8.0/Classes/TwilioVideoSDK.html new file mode 100644 index 00000000..6acb4d24 --- /dev/null +++ b/docs/5.8.0/Classes/TwilioVideoSDK.html @@ -0,0 +1,601 @@ + + + + + + TwilioVideoSDK Class Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TwilioVideoSDK Class Reference

+ + +
+ + + + + + + +
Inherits fromNSObject
Declared inTwilioVideo.h
+ + + + +
+ +

Overview

+

TwilioVideoSDK 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.

+
+ + + + + + + + + + + +
+

Declared In

+

TwilioVideo.h

+
+ + +
+
+
+ +

+ sdkVersion +

+ +
+
+ +
+ + +
+

Returns the SDK version.

+
+ + + +
+ (nonnull NSString *)sdkVersion
+ + + + + +
+

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

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVICameraSourceError.html b/docs/5.8.0/Constants/TVICameraSourceError.html new file mode 100644 index 00000000..47a436d4 --- /dev/null +++ b/docs/5.8.0/Constants/TVICameraSourceError.html @@ -0,0 +1,204 @@ + + + + + + TVICameraSourceError Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceError Constants Reference

+ + +
+ + + + +
Declared inTVICameraSource.h
+ + + + + + + +

TVICameraSourceError

+ + +
+

Enumeration indicating the errors raised by TVICameraSource.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVICameraSourceError ) {
+ +    kTVICameraSourceErrorNone = 0,
+ +    kTVICameraSourceErrorAlreadyRunning,
+ +    kTVICameraSourceErrorCameraPermissionDenied,
+ + }; + +
+ +
+

Constants

+
+ +
kTVICameraSourceErrorNone
+
+ + +

Capture session already setup.

+ + + + + + +

+ Declared In TVICameraSource.h. +

+ +
+ +
kTVICameraSourceErrorAlreadyRunning
+
+ + +

The source was already started, and has not been stopped.

+ + + + + + +

+ Declared In TVICameraSource.h. +

+ +
+ +
kTVICameraSourceErrorCameraPermissionDenied
+
+ + +

The user has declined camera permissions.

+ + + + + + +

+ Declared In TVICameraSource.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVICameraSourceOptionsRotationTags.html b/docs/5.8.0/Constants/TVICameraSourceOptionsRotationTags.html new file mode 100644 index 00000000..232c6b2e --- /dev/null +++ b/docs/5.8.0/Constants/TVICameraSourceOptionsRotationTags.html @@ -0,0 +1,192 @@ + + + + + + TVICameraSourceOptionsRotationTags Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceOptionsRotationTags Constants Reference

+ + +
+ + + + +
Declared inTVICameraSourceOptions.h
+ + + + + + + +

TVICameraSourceOptionsRotationTags

+ + +
+

TVICameraSourceOptionsRotationTags specifies how TVICameraSource should handle rotation tags.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVICameraSourceOptionsRotationTags ) {
+ +    TVICameraSourceOptionsRotationTagsKeep = 0,
+ +    TVICameraSourceOptionsRotationTagsRemove,
+ + }; + +
+ +
+

Constants

+
+ +
TVICameraSourceOptionsRotationTagsKeep
+
+ + +

Capture video in the natural orientation of the device and use rotation tags to describe the delivered orientation. +If one or more subscribers does not support rotation tags then the tags will be physically removed using the CPU before encoding the frames.

+ + + + + + +

+ Declared In TVICameraSourceOptions.h. +

+ +
+ +
TVICameraSourceOptionsRotationTagsRemove
+
+ + +

Capture frames in the natural orientation of the device, and use hardware acceleration to physically remove any tags. This option is uesful in some scenarios: +1. To save energy in a Group Room where rotation tags are not supported. +2. When recording local video with AVAssetWriter, so that recordings do not need to include transforms. +3. For image processing with Computer Vision & Machine Learning algorithms. +However, there are disadvantages such as: +1. On older devices (< iPhone 8), the output from the camera might be interrupted momentarily after a rotation occurs. +2. The dimensions of the video are not consistent before/after a rotation (since width and height become swapped).

+ + + + + + +

+ Declared In TVICameraSourceOptions.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVICameraSourceOptions.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVIIceCandidatePairState.html b/docs/5.8.0/Constants/TVIIceCandidatePairState.html new file mode 100644 index 00000000..df446495 --- /dev/null +++ b/docs/5.8.0/Constants/TVIIceCandidatePairState.html @@ -0,0 +1,280 @@ + + + + + + TVIIceCandidatePairState Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIIceCandidatePairState Constants Reference

+ + +
+ + + + +
Declared inTVIIceCandidatePairStats.h
+ + + + + + + +

TVIIceCandidatePairState

+ + +
+

Specifies the type of the Ice candidate pair state.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVIIceCandidatePairState ) {
+ +    TVIIceCandidatePairStateSucceeded,
+ +    TVIIceCandidatePairStateFrozen,
+ +    TVIIceCandidatePairStateWaiting,
+ +    TVIIceCandidatePairStateInProgress,
+ +    TVIIceCandidatePairStateFailed,
+ +    TVIIceCandidatePairStateCancelled,
+ +    TVIIceCandidatePairStateUnknown,
+ + }; + +
+ +
+

Constants

+
+ +
TVIIceCandidatePairStateSucceeded
+
+ + +

Ice candidate pair state Succeeded

+ + + + + + +

+ Declared In TVIIceCandidatePairStats.h. +

+ +
+ +
TVIIceCandidatePairStateFrozen
+
+ + +

Ice candidate pair state Frozen

+ + + + + + +

+ Declared In TVIIceCandidatePairStats.h. +

+ +
+ +
TVIIceCandidatePairStateWaiting
+
+ + +

Ice candidate pair state Waiting

+ + + + + + +

+ Declared In TVIIceCandidatePairStats.h. +

+ +
+ +
TVIIceCandidatePairStateInProgress
+
+ + +

Ice candidate pair state in progress

+ + + + + + +

+ Declared In TVIIceCandidatePairStats.h. +

+ +
+ +
TVIIceCandidatePairStateFailed
+
+ + +

Ice candidate pair state state Failed

+ + + + + + +

+ Declared In TVIIceCandidatePairStats.h. +

+ +
+ +
TVIIceCandidatePairStateCancelled
+
+ + +

Ice candidate pair state state Cancelled

+ + + + + + +

+ Declared In TVIIceCandidatePairStats.h. +

+ +
+ +
TVIIceCandidatePairStateUnknown
+
+ + +

Unknown Ice candidate pair state

+ + + + + + +

+ Declared In TVIIceCandidatePairStats.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVIIceCandidatePairStats.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVIIceTransportPolicy.html b/docs/5.8.0/Constants/TVIIceTransportPolicy.html new file mode 100644 index 00000000..ffedddc6 --- /dev/null +++ b/docs/5.8.0/Constants/TVIIceTransportPolicy.html @@ -0,0 +1,185 @@ + + + + + + TVIIceTransportPolicy Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIIceTransportPolicy Constants Reference

+ + +
+ + + + +
Declared inTVIIceOptions.h
+ + + + + + + +

TVIIceTransportPolicy

+ + +
+

TVIIceTransportPolicy specifies which ICE transports to allow.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVIIceTransportPolicy ) {
+ +    TVIIceTransportPolicyAll = 0,
+ +    TVIIceTransportPolicyRelay = 1,
+ + }; + +
+ +
+

Constants

+
+ +
TVIIceTransportPolicyAll
+
+ + +

All transports will be used.

+ + + + + + +

+ Declared In TVIIceOptions.h. +

+ +
+ +
TVIIceTransportPolicyRelay
+
+ + +

Only TURN relay transports will be used.

+ + + + + + +

+ Declared In TVIIceOptions.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVIIceOptions.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVILocalNetworkPrivacyPolicy.html b/docs/5.8.0/Constants/TVILocalNetworkPrivacyPolicy.html new file mode 100644 index 00000000..9e6c5223 --- /dev/null +++ b/docs/5.8.0/Constants/TVILocalNetworkPrivacyPolicy.html @@ -0,0 +1,191 @@ + + + + + + TVILocalNetworkPrivacyPolicy Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalNetworkPrivacyPolicy Constants Reference

+ + +
+ + + + +
Declared inTVILocalNetworkPrivacyPolicy.h
+ + + + + + + +

TVILocalNetworkPrivacyPolicy

+ + +
+

TVILocalNetworkPrivacyPolicy restricts which communication routes can be used to send and receive media with other Participants. +Local addresses that are allowed by the policy are shared with other Participants. Remote addresses that are allowed by the policy +are used for connectivity checks.

+ +

In order to ensure that end user privacy is respected the privacy policy is always applied equally to local and remote addresses. +As a result, the Participant with the most restrictive privacy policy determines which routes are allowed in a Peer-to-Peer Room.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVILocalNetworkPrivacyPolicy ) {
+ +    TVILocalNetworkPrivacyPolicyAllowAll = 0,
+ +    TVILocalNetworkPrivacyPolicyBlockLocal = 1,
+ + }; + +
+ +
+

Constants

+
+ +
TVILocalNetworkPrivacyPolicyAllowAll
+
+ + +

Allow local network addresses. Select this policy if you have consent to send and receive media using the local network.

+ + + + + + +

+ Declared In TVILocalNetworkPrivacyPolicy.h. +

+ +
+ +
TVILocalNetworkPrivacyPolicyBlockLocal
+
+ + +

Block the gathering and use of local network addresses. Unicast and multicast DNS resolution of remote hostnames is disabled. +Select this policy if you do not want to take any actions that might result in a local network permissions request.

+ + + + + + +

+ Declared In TVILocalNetworkPrivacyPolicy.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVILocalNetworkPrivacyPolicy.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVILogLevel.html b/docs/5.8.0/Constants/TVILogLevel.html new file mode 100644 index 00000000..31e3d4cd --- /dev/null +++ b/docs/5.8.0/Constants/TVILogLevel.html @@ -0,0 +1,299 @@ + + + + + + TVILogLevel Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILogLevel Constants Reference

+ + +
+ + + + +
Declared inTwilioVideo.h
+ + + + + + + +

TVILogLevel

+ + +
+

Different logging levels.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVILogLevel ) {
+ +    TVILogLevelOff = 0,
+ +    TVILogLevelFatal,
+ +    TVILogLevelError,
+ +    TVILogLevelWarning,
+ +    TVILogLevelInfo,
+ +    TVILogLevelDebug,
+ +    TVILogLevelTrace,
+ +    TVILogLevelAll,
+ + }; + +
+ +
+

Constants

+
+ +
TVILogLevelOff
+
+ + +

Turn off logging.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogLevelFatal
+
+ + +

Log very severe error events that will presumably lead the application to abort.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogLevelError
+
+ + +

Log error events that might still allow the application to continue running.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogLevelWarning
+
+ + +

Log warning events that may indicate potentially harmful situations.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogLevelInfo
+
+ + +

Log the progress of the application at coarse-grained level.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogLevelDebug
+
+ + +

Log fine-grained informational events that are most useful to debug an application.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogLevelTrace
+
+ + +

Log finer-grained informational events than the debug.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogLevelAll
+
+ + +

Turn on all logging.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TwilioVideo.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVILogModule.html b/docs/5.8.0/Constants/TVILogModule.html new file mode 100644 index 00000000..2e799b5b --- /dev/null +++ b/docs/5.8.0/Constants/TVILogModule.html @@ -0,0 +1,223 @@ + + + + + + TVILogModule Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILogModule Constants Reference

+ + +
+ + + + +
Declared inTwilioVideo.h
+ + + + + + + +

TVILogModule

+ + +
+

Different logging modules.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVILogModule ) {
+ +    TVILogModuleCore = 0,
+ +    TVILogModulePlatform,
+ +    TVILogModuleSignaling,
+ +    TVILogModuleWebRTC,
+ + }; + +
+ +
+

Constants

+
+ +
TVILogModuleCore
+
+ + +

Video Core SDK.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogModulePlatform
+
+ + +

Video iOS SDK.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogModuleSignaling
+
+ + +

Signaling Module.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
TVILogModuleWebRTC
+
+ + +

Webrtc Module.

+ + + + + + +

+ Declared In TwilioVideo.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TwilioVideo.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVINetworkQualityLevel.html b/docs/5.8.0/Constants/TVINetworkQualityLevel.html new file mode 100644 index 00000000..8d58d93c --- /dev/null +++ b/docs/5.8.0/Constants/TVINetworkQualityLevel.html @@ -0,0 +1,290 @@ + + + + + + TVINetworkQualityLevel Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVINetworkQualityLevel Constants Reference

+ + +
+ + + + +
Declared inTVIParticipant.h
+ + + + + + + +

TVINetworkQualityLevel

+ + +
+

Twilio’s Video SDKs, where possible, attempt to calculate a singular Network Quality Level describing +the quality of a Participant’s connection to a Room. This value ranges from -1 to 5, with -1 representing that the +Network Quality Level can not be determined, 0 representing a failed network connection, 1 representing a poor +network connection, and 5 representing an excellent network connection. The SDK calculates this metric only when +connected to Group Rooms. In case of a connection to Peer-to-Peer Room the value is expected to be -1 at all times.

+ +

Note that the Network Quality Level is not an absolute metric but a score relative to the demand being placed on +the network. For example, the NQ score might be a 5 while on a good network and publishing only an AudioTrack. +Later, if a HD VideoTrack is added, the score might come down to 2. This also means that when the network is not +being used at all (i.e. the Client is neither publishing nor subscribing to any tracks) the Network Quality Level +will always be 5 given that any network will be capable of complying with a zero communications demand.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSInteger, TVINetworkQualityLevel ) {
+ +    TVINetworkQualityLevelUnknown = -1,
+ +    TVINetworkQualityLevelZero = 0,
+ +    TVINetworkQualityLevelOne,
+ +    TVINetworkQualityLevelTwo,
+ +    TVINetworkQualityLevelThree,
+ +    TVINetworkQualityLevelFour,
+ +    TVINetworkQualityLevelFive,
+ + }; + +
+ +
+

Constants

+
+ +
TVINetworkQualityLevelUnknown
+
+ + +

The Network Quality Level cannot be determined or the Network Quality API has not been enabled.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
TVINetworkQualityLevelZero
+
+ + +

The network connection has failed.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
TVINetworkQualityLevelOne
+
+ + +

The Network Quality is Very Bad.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
TVINetworkQualityLevelTwo
+
+ + +

The Network Quality is Bad.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
TVINetworkQualityLevelThree
+
+ + +

The Network Quality is Good.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
TVINetworkQualityLevelFour
+
+ + +

The Network Quality is Very Good.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
TVINetworkQualityLevelFive
+
+ + +

The Network Quality is Excellent.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVIParticipant.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVINetworkQualityVerbosity.html b/docs/5.8.0/Constants/TVINetworkQualityVerbosity.html new file mode 100644 index 00000000..e1272146 --- /dev/null +++ b/docs/5.8.0/Constants/TVINetworkQualityVerbosity.html @@ -0,0 +1,181 @@ + + + + + + TVINetworkQualityVerbosity Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVINetworkQualityVerbosity Constants Reference

+ + +
+ + + + +
Declared inTVINetworkQualityConfiguration.h
+ + + + + + + +

TVINetworkQualityVerbosity

+ + + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVINetworkQualityVerbosity ) {
+ +    TVINetworkQualityVerbosityNone = 0,
+ +    TVINetworkQualityVerbosityMinimal,
+ + }; + +
+ +
+

Constants

+
+ +
TVINetworkQualityVerbosityNone
+
+ + +

Nothing is reported for the Participant. This is not a valid option for the LocalParticipant.

+ + + + + + +

+ Declared In TVINetworkQualityConfiguration.h. +

+ +
+ +
TVINetworkQualityVerbosityMinimal
+
+ + +

Reports only the NetworkQualityLevel for the Participant.

+ + + + + + +

+ Declared In TVINetworkQualityConfiguration.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVINetworkQualityConfiguration.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVIParticipantState.html b/docs/5.8.0/Constants/TVIParticipantState.html new file mode 100644 index 00000000..7cf220e9 --- /dev/null +++ b/docs/5.8.0/Constants/TVIParticipantState.html @@ -0,0 +1,204 @@ + + + + + + TVIParticipantState Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIParticipantState Constants Reference

+ + +
+ + + + +
Declared inTVIParticipant.h
+ + + + + + + +

TVIParticipantState

+ + +
+

Enumeration indicating the state of the signaling connection for a TVIParticipant.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVIParticipantState ) {
+ +    TVIParticipantStateConnected = 0,
+ +    TVIParticipantStateReconnecting,
+ +    TVIParticipantStateDisconnected,
+ + }; + +
+ +
+

Constants

+
+ +
TVIParticipantStateConnected
+
+ + +

The Participant has connected to signaling.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
TVIParticipantStateReconnecting
+
+ + +

The Participant is attempting to reconnect to signaling.

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
TVIParticipantStateDisconnected
+
+ + +

The Participant has disconnected from signaling

+ + + + + + +

+ Declared In TVIParticipant.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVIParticipant.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVIPixelFormat.html b/docs/5.8.0/Constants/TVIPixelFormat.html new file mode 100644 index 00000000..ca9317fd --- /dev/null +++ b/docs/5.8.0/Constants/TVIPixelFormat.html @@ -0,0 +1,261 @@ + + + + + + TVIPixelFormat Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIPixelFormat Constants Reference

+ + +
+ + + + +
Declared inTVIVideoFormat.h
+ + + + + + + +

TVIPixelFormat

+ + +
+

The subset of Core Video pixel formats which are supported by TVIVideoSink.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(OSType, TVIPixelFormat ) {
+ +    TVIPixelFormat32ARGB = kCVPixelFormatType_32ARGB,
+ +    TVIPixelFormat32BGRA = kCVPixelFormatType_32BGRA,
+ +    TVIPixelFormatYUV420BiPlanarVideoRange = kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange,
+ +    TVIPixelFormatYUV420BiPlanarFullRange = kCVPixelFormatType_420YpCbCr8BiPlanarFullRange,
+ +    TVIPixelFormatYUV420PlanarVideoRange = kCVPixelFormatType_420YpCbCr8Planar,
+ +    TVIPixelFormatYUV420PlanarFullRange = kCVPixelFormatType_420YpCbCr8PlanarFullRange,
+ + }; + +
+ +
+

Constants

+
+ +
TVIPixelFormat32ARGB
+
+ + +

32-bit ARGB.

+ + + + + + +

+ Declared In TVIVideoFormat.h. +

+ +
+ +
TVIPixelFormat32BGRA
+
+ + +

32-bit BGRA.

+ + + + + + +

+ Declared In TVIVideoFormat.h. +

+ +
+ +
TVIPixelFormatYUV420BiPlanarVideoRange
+
+ + +

Bi-Planar Component Y'CbCr 8-bit 4:2:0, video-range (luma=[16,235] chroma=[16,240]). baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrBiPlanar struct.

+ + + + + + +

+ Declared In TVIVideoFormat.h. +

+ +
+ +
TVIPixelFormatYUV420BiPlanarFullRange
+
+ + +

Bi-Planar Component Y'CbCr 8-bit 4:2:0, full-range (luma=[0,255] chroma=[1,255]). baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrBiPlanar struct.

+ + + + + + +

+ Declared In TVIVideoFormat.h. +

+ +
+ +
TVIPixelFormatYUV420PlanarVideoRange
+
+ + +

Planar Component Y'CbCr 8-bit 4:2:0. baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrPlanar struct.

+ + + + + + +

+ Declared In TVIVideoFormat.h. +

+ +
+ +
TVIPixelFormatYUV420PlanarFullRange
+
+ + +

Planar Component Y'CbCr 8-bit 4:2:0, full range. baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrPlanar struct.

+ + + + + + +

+ Declared In TVIVideoFormat.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVIVideoFormat.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVIRoomState.html b/docs/5.8.0/Constants/TVIRoomState.html new file mode 100644 index 00000000..92d913ac --- /dev/null +++ b/docs/5.8.0/Constants/TVIRoomState.html @@ -0,0 +1,224 @@ + + + + + + TVIRoomState Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRoomState Constants Reference

+ + +
+ + + + +
Declared inTVIRoom.h
+ + + + + + + +

TVIRoomState

+ + +
+

TVIRoomState represents the current state of a TVIRoom.

All TVIRoom instances start in TVIRoomStateConnecting, before transitioning to TVIRoomStateConnected or +TVIRoomStateDisconnected.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVIRoomState ) {
+ +    TVIRoomStateConnecting = 0,
+ +    TVIRoomStateConnected,
+ +    TVIRoomStateDisconnected,
+ +    TVIRoomStateReconnecting,
+ + }; + +
+ +
+

Constants

+
+ +
TVIRoomStateConnecting
+
+ + +

The TVIRoom is attempting a connection based upon the TVIConnectOptions provided.

+ + + + + + +

+ Declared In TVIRoom.h. +

+ +
+ +
TVIRoomStateConnected
+
+ + +

The TVIRoom is connected, and ready to interact with other Participants.

+ + + + + + +

+ Declared In TVIRoom.h. +

+ +
+ +
TVIRoomStateDisconnected
+
+ + +

The TVIRoom has been disconnected, and interaction with other Participants is no longer possible.

+ + + + + + +

+ Declared In TVIRoom.h. +

+ +
+ +
TVIRoomStateReconnecting
+
+ + +

The TVIRoom is attempting to reconnect following a network disruption.

+ + + + + + +

+ Declared In TVIRoom.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVIScreenContent.html b/docs/5.8.0/Constants/TVIScreenContent.html new file mode 100644 index 00000000..b0781439 --- /dev/null +++ b/docs/5.8.0/Constants/TVIScreenContent.html @@ -0,0 +1,185 @@ + + + + + + TVIScreenContent Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIScreenContent Constants Reference

+ + +
+ + + + +
Declared inTVIScreenContent.h
+ + + + + + + +

TVIScreenContent

+ + +
+

TVIScreenContent specifies how TVIAppScreenSource should optimize the video format.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVIScreenContent ) {
+ +    TVIScreenContentDefault = 0,
+ +    TVIScreenContentVideo,
+ + }; + +
+ +
+

Constants

+
+ +
TVIScreenContentDefault
+
+ + +

Optimize video format for image sharpness and quality.

+ + + + + + +

+ Declared In TVIScreenContent.h. +

+ +
+ +
TVIScreenContentVideo
+
+ + +

Optimize video format for fluid motion.

+ + + + + + +

+ Declared In TVIScreenContent.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVIScreenContent.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVITrackState.html b/docs/5.8.0/Constants/TVITrackState.html new file mode 100644 index 00000000..eb4359a1 --- /dev/null +++ b/docs/5.8.0/Constants/TVITrackState.html @@ -0,0 +1,185 @@ + + + + + + TVITrackState Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVITrackState Constants Reference

+ + +
+ + + + +
Declared inTVITrack.h
+ + + + + + + +

TVITrackState

+ + +
+

TVITrackState is an enum defines the possible states of a track.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVITrackState ) {
+ +    TVITrackStateEnded = 0,
+ +    TVITrackStateLive,
+ + }; + +
+ +
+

Constants

+
+ +
TVITrackStateEnded
+
+ + +

Track ended.

+ + + + + + +

+ Declared In TVITrack.h. +

+ +
+ +
TVITrackStateLive
+
+ + +

Track live.

+ + + + + + +

+ Declared In TVITrack.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVITrack.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Constants/TVIVideoOrientation.html b/docs/5.8.0/Constants/TVIVideoOrientation.html new file mode 100644 index 00000000..f9876128 --- /dev/null +++ b/docs/5.8.0/Constants/TVIVideoOrientation.html @@ -0,0 +1,223 @@ + + + + + + TVIVideoOrientation Constants Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoOrientation Constants Reference

+ + +
+ + + + +
Declared inTVIVideoFrame.h
+ + + + + + + +

TVIVideoOrientation

+ + +
+

Specifies the orientation of video content.

+
+ + +
+ + +

Definition

+ typedef NS_ENUM(NSUInteger, TVIVideoOrientation ) {
+ +    TVIVideoOrientationUp = 0,
+ +    TVIVideoOrientationLeft,
+ +    TVIVideoOrientationDown,
+ +    TVIVideoOrientationRight,
+ + }; + +
+ +
+

Constants

+
+ +
TVIVideoOrientationUp
+
+ + +

The video is rotated 0 degrees, oriented with its top side up.

+ + + + + + +

+ Declared In TVIVideoFrame.h. +

+ +
+ +
TVIVideoOrientationLeft
+
+ + +

The video is rotated 90 degrees, oriented with its top side to the left.

+ + + + + + +

+ Declared In TVIVideoFrame.h. +

+ +
+ +
TVIVideoOrientationDown
+
+ + +

The video is rotated 180 degrees, oriented with its top side to bottom.

+ + + + + + +

+ Declared In TVIVideoFrame.h. +

+ +
+ +
TVIVideoOrientationRight
+
+ + +

The video is rotated 270 degrees, oriented with its top side to the right.

+ + + + + + +

+ Declared In TVIVideoFrame.h. +

+ +
+ +
+
+ + + + + + + + +
+

Declared In

+

TVIVideoFrame.h

+
+ + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIAppScreenSourceDelegate.html b/docs/5.8.0/Protocols/TVIAppScreenSourceDelegate.html new file mode 100644 index 00000000..2bc35613 --- /dev/null +++ b/docs/5.8.0/Protocols/TVIAppScreenSourceDelegate.html @@ -0,0 +1,391 @@ + + + + + + TVIAppScreenSourceDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAppScreenSourceDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIAppScreenSource.h
+ + + + +
+ +

Overview

+

TVIAppScreenSourceDelegate receives important lifecycle events related to TVIAppScreenSource. +By implementing these methods you can handle state changes and errors that may occur.

+
+ + + + + +
+ + + + + + +
+
+ +

– appScreenSourceDidBecomeAvailable: +

+ +
+
+ +
+ + +
+

Screen capture has become available.

+
+ + + +
- (void)appScreenSourceDidBecomeAvailable:(nonnull TVIAppScreenSource *)source
+ + + +
+

Parameters

+ + + + + + + +
source

The source that has become available.

+
+ + + + + + + +
+

Discussion

+

You may wish to enable your TVILocalVideoTrack if you disabled it when the the source was unavailable.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– appScreenSourceDidBecomeUnavailable: +

+ +
+
+ +
+ + +
+

Screen capture has become unavailable.

+
+ + + +
- (void)appScreenSourceDidBecomeUnavailable:(nonnull TVIAppScreenSource *)source
+ + + +
+

Parameters

+ + + + + + + +
source

The source that has become unavailable.

+
+ + + + + + + +
+

Discussion

+

You may wish to disable your TVILocalVideoTrack, and update your UI when screen capture is unavailable.

+
+ + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– appScreenSource:didReceiveCaptureError: +

+ +
+
+ +
+ + +
+

The source received an error while capturing.

+
+ + + +
- (void)appScreenSource:(nonnull TVIAppScreenSource *)source didReceiveCaptureError:(nonnull NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + +
source

The source which received the error.

error

The error received.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+ +

– appScreenSource:didStopCapturingWithError: +

+ +
+
+ +
+ + +
+

The source unexpectedly stopped capturing.

+
+ + + +
- (void)appScreenSource:(nonnull TVIAppScreenSource *)source didStopCapturingWithError:(nullable NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + +
source

The source which stopped.

error

The error which caused the source to stop.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIAppScreenSource.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIAudioDevice.html b/docs/5.8.0/Protocols/TVIAudioDevice.html new file mode 100644 index 00000000..3cd4f2b1 --- /dev/null +++ b/docs/5.8.0/Protocols/TVIAudioDevice.html @@ -0,0 +1,132 @@ + + + + + + TVIAudioDevice Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioDevice Protocol Reference

+ + +
+ + + + + + + +
Conforms toTVIAudioDeviceCapturer
TVIAudioDeviceRenderer
Declared inTVIAudioDevice.h
+ + + + +
+ +

Overview

+

TVIAudioDevice represents full duplex audio capturing and rendering capabilities. By implementing this +protocol you can replace the mechanism by which audio is used by the media engine.

+
+ + + + + + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIAudioDeviceCapturer.html b/docs/5.8.0/Protocols/TVIAudioDeviceCapturer.html new file mode 100644 index 00000000..d37a21a9 --- /dev/null +++ b/docs/5.8.0/Protocols/TVIAudioDeviceCapturer.html @@ -0,0 +1,383 @@ + + + + + + TVIAudioDeviceCapturer Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioDeviceCapturer Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIAudioDevice.h
+ + + + +
+ +

Overview

+

TVIAudioDeviceCapturer defines the capturing half of TVIAudioDevice. An audio capturer produces samples by +repeatedly calling TVIAudioDeviceWriteCaptureData() when it needs to deliver new data. A capturer need not record +audio from the device microphone, it could perform other operations such as reading audio samples from disk instead.

+
+ + + + + +
+ + + + + + +
+
+ +

– captureFormat +required method

+ +
+
+ +
+ + +
+

Provides the format to be used for capturing audio.

+
+ + + +
- (nullable TVIAudioFormat *)captureFormat
+ + + + + +
+

Return Value

+

A TVIAudioFormat instance which describes the audio which will be captured. Returning nil indicates +that audio capture is not supported.

+
+ + + + + +
+

Discussion

+

This method is called once before capture starts. If you wish to change the format after you’ve started +capturing audio then you should call TVIAudioDeviceReinitialize() and prepare for this method to be queried again.

+
+ + + + + + + +
+

Declared In

+

TVIAudioDevice.h

+
+ + +
+
+
+ +

– initializeCapturer +required method

+ +
+
+ +
+ + +
+

Initializes the capturer.

+
+ + + +
- (BOOL)initializeCapturer
+ + + + + +
+

Return Value

+

YES if initialization succeeded, or NO if it did not.

+
+ + + + + +
+

Discussion

+

This method is called before startCapturing:. You should use this opportunity to pre-allocate any +fixed size buffers or other resources that you need for audio processing.

+
+ + + + + + + +
+

Declared In

+

TVIAudioDevice.h

+
+ + +
+
+
+ +

– startCapturing: +required method

+ +
+
+ +
+ + +
+

Starts the capturer.

+
+ + + +
- (BOOL)startCapturing:(nonnull TVIAudioDeviceContext)context
+ + + +
+

Parameters

+ + + + + + + +
context

A context pointer to be used with the audio capture function callbacks +TVIAudioDeviceFormatChanged(), TVIAudioDeviceReinitialize(), TVIAudioDeviceWriteCaptureData() and TVIAudioDeviceExecuteWorkerBlock().

+
+ + + +
+

Return Value

+

YES if capturing started, or NO if it did not.

+
+ + + + + +
+

Discussion

+

This method is called after initializeCapturer. Before your implementation returns it should have +started your audio capturing pipeline. This may involve spinning up audio threads via CoreAudio or starting your own +high priority capture thread.

+
+ + + + + + + +
+

Declared In

+

TVIAudioDevice.h

+
+ + +
+
+
+ +

– stopCapturing +required method

+ +
+
+ +
+ + +
+

Stops the capturer.

+
+ + + +
- (BOOL)stopCapturing
+ + + + + +
+

Return Value

+

YES if capturing stopped, or NO if it did not.

+
+ + + + + +
+

Discussion

+

This method is called some time after startCapturing when audio capturing is no longer needed by the +media engine. Before your implementation returns it should have stopped your audio capturing pipeline.

+
+ + + + + + + +
+

Declared In

+

TVIAudioDevice.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIAudioDeviceRenderer.html b/docs/5.8.0/Protocols/TVIAudioDeviceRenderer.html new file mode 100644 index 00000000..33753e48 --- /dev/null +++ b/docs/5.8.0/Protocols/TVIAudioDeviceRenderer.html @@ -0,0 +1,383 @@ + + + + + + TVIAudioDeviceRenderer Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioDeviceRenderer Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIAudioDevice.h
+ + + + +
+ +

Overview

+

TVIAudioDeviceRenderer defines the rendering half of TVIAudioDevice. An audio renderer consumes samples by +repeatedly calling TVIAudioDeviceReadRenderData() when it needs new data. A renderer need not playback audio +through the device loudspeaker, it could perform other operations such as writing audio samples to disk instead.

+
+ + + + + +
+ + + + + + +
+
+ +

– renderFormat +required method

+ +
+
+ +
+ + +
+

Provides the format to be used for rendering audio.

+
+ + + +
- (nullable TVIAudioFormat *)renderFormat
+ + + + + +
+

Return Value

+

A TVIAudioFormat instance which describes the audio which will be rendered. Returning nil indicates +that audio rendering is not supported.

+
+ + + + + +
+

Discussion

+

This method is called once before rendering starts. If you wish to change the format after you’ve started +rendering audio then you should call TVIAudioDeviceReinitialize() and prepare for this method to be queried again.

+
+ + + + + + + +
+

Declared In

+

TVIAudioDevice.h

+
+ + +
+
+
+ +

– initializeRenderer +required method

+ +
+
+ +
+ + +
+

Initializes the renderer.

+
+ + + +
- (BOOL)initializeRenderer
+ + + + + +
+

Return Value

+

YES if initialization succeeded, or NO if it did not.

+
+ + + + + +
+

Discussion

+

This method is called before startRendering:. You should use this opportunity to pre-allocate any +fixed size buffers or other resources that you need for audio processing.

+
+ + + + + + + +
+

Declared In

+

TVIAudioDevice.h

+
+ + +
+
+
+ +

– startRendering: +required method

+ +
+
+ +
+ + +
+

Starts the renderer.

+
+ + + +
- (BOOL)startRendering:(nonnull TVIAudioDeviceContext)context
+ + + +
+

Parameters

+ + + + + + + +
context

A context pointer to be used with the audio renderer function callbacks +TVIAudioDeviceFormatChanged(), TVIAudioDeviceReinitialize(), TVIAudioDeviceReadRenderData() and TVIAudioDeviceExecuteWorkerBlock().

+
+ + + +
+

Return Value

+

YES if rendering started, or NO if it did not.

+
+ + + + + +
+

Discussion

+

This method is called after initializeRenderer. Before your implementation returns it should have +started your audio rendering pipeline. This may involve spinning up audio threads via CoreAudio or starting your own +high priority rendering thread.

+
+ + + + + + + +
+

Declared In

+

TVIAudioDevice.h

+
+ + +
+
+
+ +

– stopRendering +required method

+ +
+
+ +
+ + +
+

Stops the renderer.

+
+ + + +
- (BOOL)stopRendering
+ + + + + +
+

Return Value

+

YES if rendering stopped, or NO if it did not.

+
+ + + + + +
+

Discussion

+

This method is called some time after startRendering when audio rendering is no longer needed by the +media engine. Before your implementation returns it should have stopped your audio rendering pipeline.

+
+ + + + + + + +
+

Declared In

+

TVIAudioDevice.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIAudioSink.html b/docs/5.8.0/Protocols/TVIAudioSink.html new file mode 100644 index 00000000..9aa885ca --- /dev/null +++ b/docs/5.8.0/Protocols/TVIAudioSink.html @@ -0,0 +1,216 @@ + + + + + + TVIAudioSink Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIAudioSink Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIAudioSink.h
+ + + + +
+ +

Overview

+

TVIAudioSink consumes raw audio content from a TVIAudioTrack.

+
+ + + + + +
+ + + + + + +
+
+ +

– renderSample: +required method

+ +
+
+ +
+ + +
+

Render a single audio sample.

+
+ + + +
- (void)renderSample:(CMSampleBufferRef)audioSample
+ + + +
+

Parameters

+ + + + + + + +
audioSample

A CMSampleBufferRef which is being delivered to the sink. You should retain this if you need it +outside of the scope of this method call.

+
+ + + + + + + +
+

Discussion

+

Samples are delivered in a CMSampleBuffer which fully describes the format and timings of the audio. +Please note that many audio frames are contained within a single CMSampleBuffer. +Callbacks are raised at presentation time with an interval of 10 milliseconds. +The CMSampleBuffers are suitable to pass to Apple APIs like AVAssetWriterInput, or SFSpeechAudioBufferRecognitionRequest. +However, you should ensure that you process each sample in a real-time fashion. Holding on to seconds worth of audio +will result in future samples being dropped.

+
+ + + + + + + +
+

Declared In

+

TVIAudioSink.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVICameraSourceDelegate.html b/docs/5.8.0/Protocols/TVICameraSourceDelegate.html new file mode 100644 index 00000000..0c1de1f7 --- /dev/null +++ b/docs/5.8.0/Protocols/TVICameraSourceDelegate.html @@ -0,0 +1,396 @@ + + + + + + TVICameraSourceDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVICameraSource.h
+ + + + +
+ +

Overview

+

TVICameraSourceDelegate receives important lifecycle events related to TVICameraSource. +By implementing these methods you can override default behavior, or handle errors that may occur.

+
+ + + + + +
+ + + + + + +
+
+ +

– cameraSourceInterruptionEnded: +

+ +
+
+ +
+ + +
+

The camera source interruption has now ended.

+
+ + + +
- (void)cameraSourceInterruptionEnded:(nonnull TVICameraSource *)source
+ + + +
+

Parameters

+ + + + + + + +
source

The source which started.

+
+ + + + + + + +
+

Discussion

+

You might wish to enable your TVILocalVideoTrack if you disabled it when the interruption began.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– cameraSourceWasInterrupted:reason: +

+ +
+
+ +
+ + +
+

The source was interrupted, and will not produce any more frames until the interruption ends.

+
+ + + +
- (void)cameraSourceWasInterrupted:(nonnull TVICameraSource *)source reason:(AVCaptureSessionInterruptionReason)reason
+ + + +
+

Parameters

+ + + + + + + + + + + + +
source

The source which was interrupted.

reason

The reason why the source was interrupted.

+
+ + + + + + + +
+

Discussion

+

You may wish to disable your TVILocalVideoTrack, and update your UI in response to an interruption.

+
+ + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– cameraSource:didFailWithError: +

+ +
+
+ +
+ + +
+

The source stopped running with a fatal error.

+
+ + + +
- (void)cameraSource:(nonnull TVICameraSource *)source didFailWithError:(nonnull NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + +
source

The source which stopped.

error

The error which caused the source to stop.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+ +

– cameraSource:isReportingSystemPressure: +

+ +
+
+ +
+ + +
+

The system is reporting system pressure due to the camera source

+
+ + + +
- (void)cameraSource:(nonnull TVICameraSource *)source isReportingSystemPressure:(nonnull AVCaptureSystemPressureLevel)level
+ + + +
+

Parameters

+ + + + + + + + + + + + +
source

The source which is causing the pressure.

level

The pressure level.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVICameraSource.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVICameraSourceOrientationDelegate.html b/docs/5.8.0/Protocols/TVICameraSourceOrientationDelegate.html new file mode 100644 index 00000000..32030339 --- /dev/null +++ b/docs/5.8.0/Protocols/TVICameraSourceOrientationDelegate.html @@ -0,0 +1,205 @@ + + + + + + TVICameraSourceOrientationDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceOrientationDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVICameraSourceOrientationTracker.h
+ + + + + + + + +
+ + + + + + +
+
+ +

– trackerOrientationDidChange: +required method

+ +
+
+ +
+ + +
+

A callback that should be fired whenever the tracker’s orientation changes.

+
+ + + +
- (void)trackerOrientationDidChange:(AVCaptureVideoOrientation)orientation
+ + + +
+

Parameters

+ + + + + + + +
orientation

The updated orientation value.

+
+ + + + + + + +
+

Discussion

+

This method should be called on the main thread. Calling the delegate causes TVICameraSource to enqueue an update task on its +internal AVCaptureVideoDataOutput queue, and to update the TVICameraPreviewView orientation, if present.

+
+ + + + + + + +
+

Declared In

+

TVICameraSourceOrientationTracker.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVICameraSourceOrientationTracker.html b/docs/5.8.0/Protocols/TVICameraSourceOrientationTracker.html new file mode 100644 index 00000000..221e3cfd --- /dev/null +++ b/docs/5.8.0/Protocols/TVICameraSourceOrientationTracker.html @@ -0,0 +1,236 @@ + + + + + + TVICameraSourceOrientationTracker Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVICameraSourceOrientationTracker Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVICameraSourceOrientationTracker.h
+ + + + + + + + +
+ + + + + + +
+
+ +

  delegate +required method

+ +
+
+ +
+ + +
+

The tracker’s delegate, conforming to TVICameraSourceOrientationDelegate.

+
+ + + +
@property (nonatomic, weak, nullable) id<TVICameraSourceOrientationDelegate> delegate
+ + + + + + + + + +
+

Discussion

+

This property is set on the calling thread as part of the invocation for -[TVICameraSource startCaptureWithDevice:].

+
+ + + + + + + +
+

Declared In

+

TVICameraSourceOrientationTracker.h

+
+ + +
+
+
+ +

  orientation +required method

+ +
+
+ +
+ + +
+

The currently observed orientation, in the form of AVCaptureVideoOrientation. +The value is used by TVICameraSource to configure its internal AVCaptureVideoDataOutput and AVCaptureVideoPreviewLayer connections.

+
+ + + +
@property (nonatomic, assign, readonly) AVCaptureVideoOrientation orientation
+ + + + + + + + + + + + + + + +
+

Declared In

+

TVICameraSourceOrientationTracker.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVILocalParticipantDelegate.html b/docs/5.8.0/Protocols/TVILocalParticipantDelegate.html new file mode 100644 index 00000000..b4dc9bdc --- /dev/null +++ b/docs/5.8.0/Protocols/TVILocalParticipantDelegate.html @@ -0,0 +1,591 @@ + + + + + + TVILocalParticipantDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVILocalParticipantDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVILocalParticipant.h
+ + + + +
+ +

Overview

+

TVILocalParticipantDelegate provides callbacks when important events happen to a TVILocalParticipant.

+
+ + + + + +
+ + + + + + +
+
+ +

– localParticipant:didPublishAudioTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Local Participant successfully publishes an audio track.

+
+ + + +
- (void)localParticipant:(nonnull TVILocalParticipant *)participant didPublishAudioTrack:(nonnull TVILocalAudioTrackPublication *)audioTrackPublication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The local participant.

audioTrackPublication

The TVILocalAudioTrackPublication object.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– localParticipant:didFailToPublishAudioTrack:withError: +

+ +
+
+ +
+ + +
+

Delegate method called when the publication of an audio track fails.

+
+ + + +
- (void)localParticipant:(nonnull TVILocalParticipant *)participant didFailToPublishAudioTrack:(nonnull TVILocalAudioTrack *)audioTrack withError:(nonnull NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
participant

The local participant.

audioTrack

The audio track that failed publication.

error

An NSError object describing the reason for the failure.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– localParticipant:didPublishDataTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Local Participant successfully publishes a data track.

+
+ + + +
- (void)localParticipant:(nonnull TVILocalParticipant *)participant didPublishDataTrack:(nonnull TVILocalDataTrackPublication *)dataTrackPublication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The local participant.

dataTrackPublication

The TVILocalDataTrackPublication object.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– localParticipant:didFailToPublishDataTrack:withError: +

+ +
+
+ +
+ + +
+

Delegate method called when the publication of a data track fails.

+
+ + + +
- (void)localParticipant:(nonnull TVILocalParticipant *)participant didFailToPublishDataTrack:(nonnull TVILocalDataTrack *)dataTrack withError:(nonnull NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
participant

The local participant.

dataTrack

The data track that failed publication.

error

An NSError object describing the reason for the failure.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– localParticipant:didPublishVideoTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Local Participant successfully publishes a video track.

+
+ + + +
- (void)localParticipant:(nonnull TVILocalParticipant *)participant didPublishVideoTrack:(nonnull TVILocalVideoTrackPublication *)videoTrackPublication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The local participant.

videoTrackPublication

The TVILocalVideoTrackPublication object.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– localParticipant:didFailToPublishVideoTrack:withError: +

+ +
+
+ +
+ + +
+

Delegate method called when the publication of a video track fails.

+
+ + + +
- (void)localParticipant:(nonnull TVILocalParticipant *)participant didFailToPublishVideoTrack:(nonnull TVILocalVideoTrack *)videoTrack withError:(nonnull NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
participant

The local participant.

videoTrack

The video track that failed publication.

error

An NSError object describing the reason for the failure.

+
+ + + + + + + +
+

Discussion

+

Please note that for P2P and GO rooms, this callback is not raised for +TVILocalVideoTracks added in TVIConnectOptionsBuilder.videoTracks or auto-created within.

+
+ + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+ +

– localParticipant:networkQualityLevelDidChange: +

+ +
+
+ +
+ + +
+

Delegate method called when the Local Participant’s networkQualityLevel has changed.

+
+ + + +
- (void)localParticipant:(nonnull TVILocalParticipant *)participant networkQualityLevelDidChange:(TVINetworkQualityLevel)networkQualityLevel
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The local participant.

networkQualityLevel

The new Network Quality Level.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVILocalParticipant.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIRemoteDataTrackDelegate.html b/docs/5.8.0/Protocols/TVIRemoteDataTrackDelegate.html new file mode 100644 index 00000000..03356042 --- /dev/null +++ b/docs/5.8.0/Protocols/TVIRemoteDataTrackDelegate.html @@ -0,0 +1,277 @@ + + + + + + TVIRemoteDataTrackDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteDataTrackDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIRemoteDataTrack.h
+ + + + +
+ +

Overview

+

TVIRemoteDataTrackDelegate provides callbacks when data is received on a remote data track.

+
+ + + + + +
+ + + + + + +
+
+ +

– remoteDataTrack:didReceiveString: +

+ +
+
+ +
+ + +
+

Delegate method called when data is received in string format.

+
+ + + +
- (void)remoteDataTrack:(nonnull TVIRemoteDataTrack *)remoteDataTrack didReceiveString:(nonnull NSString *)message
+ + + +
+

Parameters

+ + + + + + + + + + + + +
remoteDataTrack

The remote data track.

message

The message.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteDataTrack.h

+
+ + +
+
+
+ +

– remoteDataTrack:didReceiveData: +

+ +
+
+ +
+ + +
+

A delegate method which is called when opaque data is received.

+
+ + + +
- (void)remoteDataTrack:(nonnull TVIRemoteDataTrack *)remoteDataTrack didReceiveData:(nonnull NSData *)message
+ + + +
+

Parameters

+ + + + + + + + + + + + +
remoteDataTrack

The remote data track.

message

The message.

+
+ + + + + + + +
+

Discussion

+

It’s up to your application to define a wire format for the data which Participants send and receive. +For example you could use Universal Binary JSON for higher efficiency than +just exchanging JSON encoded strings.

+
+ + + + + + + +
+

Declared In

+

TVIRemoteDataTrack.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIRemoteParticipantDelegate.html b/docs/5.8.0/Protocols/TVIRemoteParticipantDelegate.html new file mode 100644 index 00000000..a2353d4f --- /dev/null +++ b/docs/5.8.0/Protocols/TVIRemoteParticipantDelegate.html @@ -0,0 +1,1714 @@ + + + + + + TVIRemoteParticipantDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRemoteParticipantDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIRemoteParticipant.h
+ + + + +
+ +

Overview

+

TVIRemoteParticipantDelegate provides callbacks when important changes to a TVIRemoteParticipant occur.

+
+ + + + + +
+ + + + + + +
+
+ +

– remoteParticipant:didPublishVideoTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant publishes a video track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didPublishVideoTrack:(nonnull TVIRemoteVideoTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote video track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didUnpublishVideoTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant unpublishes a video track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didUnpublishVideoTrack:(nonnull TVIRemoteVideoTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote video track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didPublishAudioTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant publishes an audio track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didPublishAudioTrack:(nonnull TVIRemoteAudioTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote audio track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didUnpublishAudioTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant unpublishes an audio track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didUnpublishAudioTrack:(nonnull TVIRemoteAudioTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote audio track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didPublishDataTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant publishes a data track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didPublishDataTrack:(nonnull TVIRemoteDataTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote data track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didUnpublishDataTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant unpublishes a data track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didUnpublishDataTrack:(nonnull TVIRemoteDataTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote data track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didEnableVideoTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant enables a video track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didEnableVideoTrack:(nonnull TVIRemoteVideoTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote video track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didDisableVideoTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant disables a video track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didDisableVideoTrack:(nonnull TVIRemoteVideoTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote video track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didEnableAudioTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant enables an audio track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didEnableAudioTrack:(nonnull TVIRemoteAudioTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote audio track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didDisableAudioTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when the Participant disables an audio track.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didDisableAudioTrack:(nonnull TVIRemoteAudioTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote Participant.

publication

The remote audio track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didSubscribeToVideoTrack:publication:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has succesfully subscribed to the Participant’s remote video track.

+
+ + + +
- (void)didSubscribeToVideoTrack:(nonnull TVIRemoteVideoTrack *)videoTrack publication:(nonnull TVIRemoteVideoTrackPublication *)publication forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
videoTrack

The remote video track.

publication

The remote video track publication.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didFailToSubscribeToVideoTrack:error:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has failed to subscribe to the Participant’s remote video track publication.

+
+ + + +
- (void)didFailToSubscribeToVideoTrack:(nonnull TVIRemoteVideoTrackPublication *)publication error:(nonnull NSError *)error forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
publication

The remote video track publication.

error

The error which indicates why the subscription failed.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didUnsubscribeFromVideoTrack:publication:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has succesfully unsubscribed from the Participant’s remote video track.

+
+ + + +
- (void)didUnsubscribeFromVideoTrack:(nonnull TVIRemoteVideoTrack *)videoTrack publication:(nonnull TVIRemoteVideoTrackPublication *)publication forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
videoTrack

The remote video track.

publication

The remote video track publication.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didSubscribeToAudioTrack:publication:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has succesfully subscribed to the Participant’s remote audio track.

+
+ + + +
- (void)didSubscribeToAudioTrack:(nonnull TVIRemoteAudioTrack *)audioTrack publication:(nonnull TVIRemoteAudioTrackPublication *)publication forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
audioTrack

The remote audio track.

publication

The remote audio track publication.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didFailToSubscribeToAudioTrack:error:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has failed to subscribe to the Participant’s remote audio track publication.

+
+ + + +
- (void)didFailToSubscribeToAudioTrack:(nonnull TVIRemoteAudioTrackPublication *)publication error:(nonnull NSError *)error forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
publication

The remote audio track publication.

error

The error which indicates why the subscription failed.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didUnsubscribeFromAudioTrack:publication:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has succesfully unsubscribed from the Participant’s remote audio track.

+
+ + + +
- (void)didUnsubscribeFromAudioTrack:(nonnull TVIRemoteAudioTrack *)audioTrack publication:(nonnull TVIRemoteAudioTrackPublication *)publication forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
audioTrack

The remote audio track.

publication

The remote audio track publication.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didSubscribeToDataTrack:publication:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has succesfully subscribed to the Participant’s remote data track.

+
+ + + +
- (void)didSubscribeToDataTrack:(nonnull TVIRemoteDataTrack *)dataTrack publication:(nonnull TVIRemoteDataTrackPublication *)publication forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
dataTrack

The remote data track.

publication

The remote data track publication.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didFailToSubscribeToDataTrack:error:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has failed to subscribe to the Participant’s remote data track publication.

+
+ + + +
- (void)didFailToSubscribeToDataTrack:(nonnull TVIRemoteDataTrackPublication *)publication error:(nonnull NSError *)error forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
publication

The remote data track publication.

error

The error which indicates why the subscription failed.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– didUnsubscribeFromDataTrack:publication:forParticipant: +

+ +
+
+ +
+ + +
+

Delegate method called when the local Participant has succesfully unsubscribed from the Participant’s remote data track.

+
+ + + +
- (void)didUnsubscribeFromDataTrack:(nonnull TVIRemoteDataTrack *)dataTrack publication:(nonnull TVIRemoteDataTrackPublication *)publication forParticipant:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
dataTrack

The remote data track.

publication

The remote data track publication.

participant

The remote Participant.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:networkQualityLevelDidChange: +

+ +
+
+ +
+ + +
+

Delegate method called when the Remote Participant’s networkQualityLevel has changed.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant networkQualityLevelDidChange:(TVINetworkQualityLevel)networkQualityLevel
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The remote participant.

networkQualityLevel

The new Network Quality Level.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:switchedOffVideoTrack: +

+ +
+
+ +
+ + +
+

Delegate method called when a subscribed TVIRemoteVideoTrack is switched off based on the +bandwidth allocation algorithm. Video will not be received for the TVIRemoteVideoTrack until it is switched +back on.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant switchedOffVideoTrack:(nonnull TVIRemoteVideoTrack *)track
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The TVIRemoteParticipant connected to the TVIRoom.

track

The subscribed TVIRemoteVideoTrack.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:switchedOnVideoTrack: +

+ +
+
+ +
+ + +
+

Emitted when a subscribed TVIRemoteVideoTrack that was switched off is now switched back on based +on the bandwidth allocation algorithm. Video will be received for the TVIRemoteVideoTrack until it is +switched off.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant switchedOnVideoTrack:(nonnull TVIRemoteVideoTrack *)track
+ + + +
+

Parameters

+ + + + + + + + + + + + +
participant

The TVIRemoteParticipant connected to the TVIRoom.

track

The remote video track.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didChangePublishPriority:forAudioTrack: +

+ +
+
+ +
+ + +
+

Emitted when the TVIRemoteParticipant changes the published priority of one of their TVIRemoteAudioTracks.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didChangePublishPriority:(nonnull TVITrackPriority)priority forAudioTrack:(nonnull TVIRemoteAudioTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
participant

The remote participant.

priority

The publish priority.

publication

The remote audio track publication

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didChangePublishPriority:forVideoTrack: +

+ +
+
+ +
+ + +
+

Emitted when the TVIRemoteParticipant changes the published priority of one of their TVIRemoteVideoTracks.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didChangePublishPriority:(nonnull TVITrackPriority)priority forVideoTrack:(nonnull TVIRemoteVideoTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
participant

The remote participant.

priority

The publish priority.

publication

The remote video track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+ +

– remoteParticipant:didChangePublishPriority:forDataTrack: +

+ +
+
+ +
+ + +
+

Emitted when the TVIRemoteParticipant changes the published priority of one of their TVIRemoteDataTracks.

+
+ + + +
- (void)remoteParticipant:(nonnull TVIRemoteParticipant *)participant didChangePublishPriority:(nonnull TVITrackPriority)priority forDataTrack:(nonnull TVIRemoteDataTrackPublication *)publication
+ + + +
+

Parameters

+ + + + + + + + + + + + + + + + + +
participant

The remote participant.

priority

The publish priority

publication

The remote data track publication.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRemoteParticipant.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIRoomDelegate.html b/docs/5.8.0/Protocols/TVIRoomDelegate.html new file mode 100644 index 00000000..7574c8fd --- /dev/null +++ b/docs/5.8.0/Protocols/TVIRoomDelegate.html @@ -0,0 +1,894 @@ + + + + + + TVIRoomDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIRoomDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIRoom.h
+ + + + +
+ +

Overview

+

TVIRoomDelegate provides callbacks when important changes to a TVIRoom occur.

+
+ + + + + +
+ + + + + + +
+
+ +

– didConnectToRoom: +

+ +
+
+ +
+ + +
+

This method is invoked when connecting to the Room succeeds.

+
+ + + +
- (void)didConnectToRoom:(nonnull TVIRoom *)room
+ + + +
+

Parameters

+ + + + + + + +
room

The Room for which connection succeeded.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– room:didFailToConnectWithError: +

+ +
+
+ +
+ + +
+

This method is invoked when connecting to the Room fails.

+
+ + + +
- (void)room:(nonnull TVIRoom *)room didFailToConnectWithError:(nonnull NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + +
room

The Room for which connection failed.

error

The error encountered during the connection attempt.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– room:didDisconnectWithError: +

+ +
+
+ +
+ + +
+

This method is invoked when the Client disconnects from a Room.

+
+ + + +
- (void)room:(nonnull TVIRoom *)room didDisconnectWithError:(nullable NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + +
room

The Room from which the Client disconnected.

error

An NSError describing why disconnect occurred, or nil if the disconnect was initiated locally.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– room:isReconnectingWithError: +

+ +
+
+ +
+ + +
+

This method is invoked when the Client is attempting to reconnect to a Room due to a network disruption.

+
+ + + +
- (void)room:(nonnull TVIRoom *)room isReconnectingWithError:(nonnull NSError *)error
+ + + +
+

Parameters

+ + + + + + + + + + + + +
room

The Room for which the Client is attempting to reconnect.

error

An NSError describing why the Client is reconnecting.

+
+ + + + + + + +
+

Discussion

+

This method is invoked when the Client is attempting to reconnect to a Room due to a network disruption. +The possible errors which could occur are TVIErrorSignalingConnectionDisconnectedError and +TVIErrorMediaConnectionError. During a media reconnection signaling related methods may continue to be +invoked.

+ +

There are certain instances when an application is put into the background that both the signaling and media +connection are closed which will cause this delegate method to be invoked.

+ +
    +
  • When connected to a Peer-to-Peer Room with no Remote Participants.
    • +
  • When connected to a Peer-to-Peer Room with other Remote Participants and no shared audio tracks.
    • +
  • When connected to a Group Room with no shared audio tracks.
    • +
+ +
+ + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– didReconnectToRoom: +

+ +
+
+ +
+ + +
+

This method is invoked after the Client has reconnected to a Room following a network disruption.

+
+ + + +
- (void)didReconnectToRoom:(nonnull TVIRoom *)room
+ + + +
+

Parameters

+ + + + + + + +
room

The Room which the Client has been reconnected.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– room:participantDidConnect: +

+ +
+
+ +
+ + +
+

This method is invoked when a Remote Participant connects to the Room.

+
+ + + +
- (void)room:(nonnull TVIRoom *)room participantDidConnect:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + +
room

The Room to which a Remote Participant connected.

participant

The Remote Participant who connected to the Room.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– room:participantDidDisconnect: +

+ +
+
+ +
+ + +
+

This method is invoked when a Remote Participant disconnects from the Room.

+
+ + + +
- (void)room:(nonnull TVIRoom *)room participantDidDisconnect:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + +
room

The Room from which a Remote Participant got disconnected.

participant

The Remote Participant who disconnected from the Room.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– room:participantIsReconnecting: +

+ +
+
+ +
+ + +
+

This method is invoked when a Remote Participant is reconnecting to the Room after a signaling connection disruption.

+
+ + + +
- (void)room:(nonnull TVIRoom *)room participantIsReconnecting:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + +
room

The Room to which a Remote Participant is reconnecting.

participant

The Remote Participant who is reconnecting to the Room.

+
+ + + + + + + +
+

Discussion

+

It can take up to 15 seconds for our signaling backend to detect that a RemoteParticipant’s connection has been +disrupted due to a network degradation or handoff.

+
+ + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– room:participantDidReconnect: +

+ +
+
+ +
+ + +
+

This method is invoked when a Remote Participant has reconnected to the Room after a signaling connection disruption.

+
+ + + +
- (void)room:(nonnull TVIRoom *)room participantDidReconnect:(nonnull TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + +
room

The Room to which a Remote Participant has reconnected.

participant

The Remote Participant who has reconnected to the Room.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– roomDidStartRecording: +

+ +
+
+ +
+ + +
+

This method is invoked when recording of media being shared to a Room has started.

+
+ + + +
- (void)roomDidStartRecording:(nonnull TVIRoom *)room
+ + + +
+

Parameters

+ + + + + + + +
room

The Room for which recording has been started.

+
+ + + + + + + +
+

Discussion

+

This method is only called when a Room which was not previously recording starts recording. If you’ve +joined a Room which is already recording this event will not be fired.

+
+ + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– roomDidStopRecording: +

+ +
+
+ +
+ + +
+

This method is invoked when the recording of media shared to a Room has stopped.

+
+ + + +
- (void)roomDidStopRecording:(nonnull TVIRoom *)room
+ + + +
+

Parameters

+ + + + + + + +
room

The Room for which recording has been stopped.

+
+ + + + + + + +
+

Discussion

+

This method is only called when a Room which was previously recording stops recording. If you’ve joined +a Room which is not recording this event will not be fired.

+
+ + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+ +

– room:dominantSpeakerDidChange: +

+ +
+
+ +
+ + +
+

This method is invoked when the dominant speaker in the Room changes.

+
+ + + +
- (void)room:(nonnull TVIRoom *)room dominantSpeakerDidChange:(nullable TVIRemoteParticipant *)participant
+ + + +
+

Parameters

+ + + + + + + + + + + + +
room

The Room in which the dominant speaker changed.

participant

The Remote Participant who is now the dominant speaker. If there is currently no dominant +speaker, nil will be sent.

+
+ + + + + + + +
+

Discussion

+

This method is invoked when the dominant speaker in the Room changes. Either there is a new dominant +speaker, in which case the Room’s dominantSpeaker property equals the RemoteParticipant included in the event; +or, there is no longer a dominant speaker, in which case the Room’s dominantSpeaker property equals nil.

+
+ + + + + + + +
+

Declared In

+

TVIRoom.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVISampleBufferVideoViewDelegate.html b/docs/5.8.0/Protocols/TVISampleBufferVideoViewDelegate.html new file mode 100644 index 00000000..afd20eee --- /dev/null +++ b/docs/5.8.0/Protocols/TVISampleBufferVideoViewDelegate.html @@ -0,0 +1,267 @@ + + + + + + TVISampleBufferVideoViewDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVISampleBufferVideoViewDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVISampleBufferVideoView.h
+ + + + +
+ +

Overview

+

TVISampleBufferVideoViewDelegate allows you to respond to, and customize the behavior of TVISampleBufferVideoView.

+
+ + + + + +
+ + + + + + +
+
+ +

– videoViewDidReceiveData: +

+ +
+
+ +
+ + +
+

This method is called once, and only once after the first frame is received. +Use it to drive user interface animations. +@note: Querying hasVideoData will return ‘YES’ within, and after this call.

+
+ + + +
- (void)videoViewDidReceiveData:(nonnull TVISampleBufferVideoView *)view
+ + + +
+

Parameters

+ + + + + + + +
view

The video view which became ready.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVISampleBufferVideoView.h

+
+ + +
+
+
+ +

– videoView:videoDimensionsDidChange: +

+ +
+
+ +
+ + +
+

This method is called every time the video track’s dimensions change.

+
+ + + +
- (void)videoView:(nonnull TVISampleBufferVideoView *)view videoDimensionsDidChange:(CMVideoDimensions)dimensions
+ + + +
+

Parameters

+ + + + + + + + + + + + +
view

The video view.

dimensions

The new dimensions of the video stream.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVISampleBufferVideoView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIVideoRenderer.html b/docs/5.8.0/Protocols/TVIVideoRenderer.html new file mode 100644 index 00000000..fc133bae --- /dev/null +++ b/docs/5.8.0/Protocols/TVIVideoRenderer.html @@ -0,0 +1,331 @@ + + + + + + TVIVideoRenderer Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoRenderer Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIVideoRenderer.h
+ + + + +
+ +

Overview

+

TVIVideoRenderers render frames from video tracks.

+
+ + + + + +
+ + + + + + +
+
+ +

– renderFrame: +required method

+ +
+
+ +
+ + +
+

Render an individual frame.

+
+ + + +
- (void)renderFrame:(nonnull TVIVideoFrame *)frame
+ + + +
+

Parameters

+ + + + + + + +
frame

The frame to be rendered.

+
+ + + + + + + +
+

Discussion

+

A TVIVideoRenderer is expected to support any valid TVIPixelFormat or drop incoming frames if it +cannot process them. You should strongly reference (retain) the TVIVideoFrame before this call returns if you +want to render it later. Frames are delivered to your renderer at or near their presentation timestamps.

+
+ + + + + + + +
+

Declared In

+

TVIVideoRenderer.h

+
+ + +
+
+
+ +

– updateVideoSize:orientation: +required method

+ +
+
+ +
+ + +
+

Informs your renderer that the size and/or orientation of the video stream is about to change.

+
+ + + +
- (void)updateVideoSize:(CMVideoDimensions)videoSize orientation:(TVIVideoOrientation)orientation
+ + + +
+

Parameters

+ + + + + + + + + + + + +
videoSize

The new dimensions for the video stream.

orientation

The new orientation of the video stream. +Always TVIVideoOrientationUp unless you opt into orientation support.

+
+ + + + + + + +
+

Discussion

+

Expect the next delivered frame to have the new size and/or orientation.

+
+ + + + + + + +
+

Declared In

+

TVIVideoRenderer.h

+
+ + +
+
+
+ +

– invalidateRenderer +

+ +
+
+ +
+ + +
+

Informs your renderer that it is no longer being used and allows you to perform any cleanup necessary if +you wish to reuse the renderer with another video track.

+
+ + + +
- (void)invalidateRenderer
+ + + + + + + + + +
+

Discussion

+

If implemented, this method will be called when removing the renderer during the invocation of +[TVIVideoTrack removeRenderer:]. This method will be invoked on the thread in which [TVIVideoTrack removeRenderer:] +was called. When your Client is unsubscribed from a TVIRemoteVideoTrack you are given the opportunity to remove your +renderer. If the rendered is not removed manually, this method will automatically be called after the +didUnsubscribeFromVideoTrack:publication:forParticipant: delegate method has been invoked.

+
+ + + + + + + +
+

Declared In

+

TVIVideoRenderer.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIVideoSink.html b/docs/5.8.0/Protocols/TVIVideoSink.html new file mode 100644 index 00000000..85249ed2 --- /dev/null +++ b/docs/5.8.0/Protocols/TVIVideoSink.html @@ -0,0 +1,327 @@ + + + + + + TVIVideoSink Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoSink Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIVideoSource.h
+ + + + +
+ +

Overview

+

A source delivers video to a sink. Sources and sinks each provide requirements which must be satisfied.

+
+ + + + + +
+ + + + + + +
+
+ +

  sourceRequirements +required method

+ +
+
+ +
+ + +
+

The source’s current requirements, delivered via onVideoFormatRequest:. A nil value indicates that the developer has +made no specific request to modify the format that the source is delivering.

+
+ + + +
@property (nonatomic, copy, nullable, readonly) TVIVideoFormat *sourceRequirements
+ + + + + + + + + +
+

Discussion

+

The source’s current requirements, delivered via onVideoFormatRequest:. A nil value indicates that the developer has +made no specific request to modify the format that the source is delivering.

+
+ + + + + + + +
+

Declared In

+

TVIVideoSource.h

+
+ + +
+
+
+ +

– onVideoFrame: +required method

+ +
+
+ +
+ + +
+

Deliver a frame to the sink.

+
+ + + +
- (void)onVideoFrame:(nonnull TVIVideoFrame *)frame
+ + + +
+

Parameters

+ + + + + + + +
frame

A TVIVideoFrame to be delivered.

+
+ + + + + + + +
+

Discussion

+

Frames delivered to a TVIVideoSink will be broadcasted to attached TVIVideoRenderers, as well as +any video encoders that might exist in the media engine. If cropping is required, either due to source requirements +or internal sink (encoder) requirements, then the sink will add an attachment (kCVImageBufferCleanApertureKey) +to the underlying CVPixelBuffer.

+
+ + + + + + + +
+

Declared In

+

TVIVideoSource.h

+
+ + +
+
+
+ +

– onVideoFormatRequest: +required method

+ +
+
+ +
+ + +
+

Request that the source output in a specific format.

+
+ + + +
- (void)onVideoFormatRequest:(nullable TVIVideoFormat *)format
+ + + +
+

Parameters

+ + + + + + + +
format

A TVIVideoFormat object which describes the desired output format.

+
+ + + + + + + +
+

Discussion

+

Developers who are using a TVIVideoSource should call [TVIVideoSource requestOutputFormat:] instead.

+
+ + + + + + + +
+

Declared In

+

TVIVideoSource.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIVideoSource.html b/docs/5.8.0/Protocols/TVIVideoSource.html new file mode 100644 index 00000000..5157f9fc --- /dev/null +++ b/docs/5.8.0/Protocols/TVIVideoSource.html @@ -0,0 +1,327 @@ + + + + + + TVIVideoSource Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoSource Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIVideoSource.h
+ + + + +
+ +

Overview

+

A source produces video content and delivers it to a single TVIVideoSink. The output produced by a source may be +modified by using a format request.

+
+ + + + + +
+ + + + + + +
+
+ +

  sink +required method

+ +
+
+ +
+ + +
+

The sink where video frames and format requests will be delivered.

+
+ + + +
@property (nonatomic, weak, nullable) id<TVIVideoSink> sink
+ + + + + + + + + +
+

Discussion

+

This property is automatically set when a TVILocalVideoTrack is created with your source. +This property is unset when the TVILocalVideoTrack is destroyed.

+
+ + + + + +
+

See Also

+ +
+ + + +
+

Declared In

+

TVIVideoSource.h

+
+ + +
+
+
+ +

  screencast +required method

+ +
+
+ +
+ + +
+

Indicates that the content from this source is a screenshare. When a source produces screen content, encoders downstream +from the source optimize for detail (spatial resolution) over frame rate (temporal resolution).

+
+ + + +
@property (nonatomic, assign, readonly, getter=isScreencast) BOOL screencast
+ + + + + + + + + +
+

Discussion

+

Indicates that the content from this source is a screenshare. When a source produces screen content, encoders downstream +from the source optimize for detail (spatial resolution) over frame rate (temporal resolution).

+
+ + + + + + + +
+

Declared In

+

TVIVideoSource.h

+
+ + +
+
+
+ +

– requestOutputFormat: +required method

+ +
+
+ +
+ + +
+

Requests that the source deliver frames in a specific format, which may have scaling and/or cropping applied.

+
+ + + +
- (void)requestOutputFormat:(nonnull TVIVideoFormat *)outputFormat
+ + + +
+

Parameters

+ + + + + + + +
outputFormat

A TVIVideoFormat instance which specifies the desired output size. A combination of scaling/cropping will +be used to achieve the output dimensions. If a frame rate is specified then the sink will drop frames to achieve it.

+
+ + + + + + + +
+

Discussion

+

Output format requests are useful when you have a source that is restricted to capturing in certain formats, +but you want to publish in another format. For example, capture in 640x480 from the camera, and crop to square 480x480. +If you are implementing your own TVIVideoSource, you should respond to this method by forwarding the request to your +sink via [TVIVideoSink onVideoFormatRequest:].

+
+ + + + + + + +
+

Declared In

+

TVIVideoSource.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/Protocols/TVIVideoViewDelegate.html b/docs/5.8.0/Protocols/TVIVideoViewDelegate.html new file mode 100644 index 00000000..c725861e --- /dev/null +++ b/docs/5.8.0/Protocols/TVIVideoViewDelegate.html @@ -0,0 +1,332 @@ + + + + + + TVIVideoViewDelegate Protocol Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

TVIVideoViewDelegate Protocol Reference

+ + +
+ + + + + + + +
Conforms toNSObject
Declared inTVIVideoView.h
+ + + + +
+ +

Overview

+

TVIVideoViewDelegate allows you to respond to, and customize the behavior of TVIVideoView.

+
+ + + + + +
+ + + + + + +
+
+ +

– videoViewDidReceiveData: +

+ +
+
+ +
+ + +
+

This method is called once, and only once after the first frame is received. +Use it to drive user interface animations. +@note: Querying hasVideoData will return ‘YES’ within, and after this call.

+
+ + + +
- (void)videoViewDidReceiveData:(nonnull TVIVideoView *)view
+ + + +
+

Parameters

+ + + + + + + +
view

The video view which became ready.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+ +

– videoView:videoDimensionsDidChange: +

+ +
+
+ +
+ + +
+

This method is called every time the video track’s dimensions change.

+
+ + + +
- (void)videoView:(nonnull TVIVideoView *)view videoDimensionsDidChange:(CMVideoDimensions)dimensions
+ + + +
+

Parameters

+ + + + + + + + + + + + +
view

The video view.

dimensions

The new dimensions of the video stream.

+
+ + + + + + + + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+ +

– videoView:videoOrientationDidChange: +

+ +
+
+ +
+ + +
+

This method is called when the video track’s orientation changes, and your app is handling content rotation.

+
+ + + +
- (void)videoView:(nonnull TVIVideoView *)view videoOrientationDidChange:(TVIVideoOrientation)orientation
+ + + +
+

Parameters

+ + + + + + + + + + + + +
view

The video view.

orientation

The new orientation of the video stream.

+
+ + + + + + + +
+

Discussion

+

This method will only be called when TVIVideoView.viewShouldRotateContent is set to NO.

+
+ + + + + + + +
+

Declared In

+

TVIVideoView.h

+
+ + +
+
+
+
+ +
+ + + + + + +
+ + +
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/css/scss/_index.scss b/docs/5.8.0/css/scss/_index.scss new file mode 100644 index 00000000..6a57ec5d --- /dev/null +++ b/docs/5.8.0/css/scss/_index.scss @@ -0,0 +1,17 @@ +.index-container { + -webkit-flex-direction: column; + flex-direction: column; + + @media (min-width: $desktop-min-width) { + display: flex; + -webkit-flex-direction: row; + flex-direction: row; + -webkit-flex-wrap: wrap; + flex-wrap: wrap; + } + + .index-column { + -webkit-flex: 1 1 33%; + flex: 1 1 33%; + } +} diff --git a/docs/5.8.0/css/scss/_layout.scss b/docs/5.8.0/css/scss/_layout.scss new file mode 100644 index 00000000..da46aef0 --- /dev/null +++ b/docs/5.8.0/css/scss/_layout.scss @@ -0,0 +1,302 @@ +* { + box-sizing: border-box; +} + +.clear { + clear: both; +} + +.clearfix { + &:before, &:after { + clear: both; + display: table; + content: ""; + } +} + +.xcode .hide-in-xcode { + display: none; +} + +body { + font: 62.5% $body-font; + background: $body-background; + + @media (max-width: $mobile-max-width) { + background-color: $content-background; + } +} + +h1, h2, h3 { + font-weight: 300; + color: #808080; +} + +h1 { + font-size: 2em; + color: #000; +} + +h4 { + font-size: 13px; + line-height: 1.5; + margin: 21px 0 0 0; +} + +a { + color: $tint-color; + text-decoration: none; +} + +pre, code { + font-family: $code-font; + word-wrap: break-word; +} + +pre > code, .method-declaration code { + display: inline-block; + font-size: .85em; + padding: 4px 0 4px 10px; + border-left: 5px solid rgba(0, 155, 51, .2); + + &:before { + content: "Objective-C"; + display: block; + + font: 9px/1 $body-font; + color: #009b33; + text-transform: uppercase; + letter-spacing: 2px; + padding-bottom: 6px; + } +} + +pre > code { + font-size: inherit; +} + +table, th, td { + border: 1px solid #e9e9e9; +} + +table { + width: 100%; +} + +th, td { + padding: 7px; + + > :first-child { + margin-top: 0; + } + + > :last-child { + margin-bottom: 0; + } +} + +.container { + @extend .clearfix; + + max-width: 980px; + padding: 0 10px; + margin: 0 auto; + + @media (max-width: $mobile-max-width) { + padding: 0; + } +} + +header { + position: fixed; + top: 0; + left: 0; + width: 100%; + z-index: 2; + + background: #414141; + color: #fff; + font-size: 1.1em; + line-height: 25px; + letter-spacing: .05em; + + #library-title { + float: left; + } + + #developer-home { + float: right; + } + + h1 { + font-size: inherit; + font-weight: inherit; + margin: 0; + } + + p { + margin: 0; + } + + h1, a { + color: inherit; + } + + @media (max-width: $mobile-max-width) { + .container { + padding: 0 10px; + } + } +} + +aside { + position: fixed; + top: 25px; + left: 0; + width: 100%; + height: 25px; + z-index: 2; + + font-size: 1.1em; + + #header-buttons { + background: rgba(255, 255, 255, .8); + margin: 0 1px; + padding: 0; + list-style: none; + text-align: right; + line-height: 32px; + + li { + display: inline-block; + cursor: pointer; + padding: 0 10px; + } + + label, select { + cursor: inherit; + } + + #on-this-page { + position: relative; + + .chevron { + display: inline-block; + width: 14px; + height: 4px; + position: relative; + + .chevy { + background: #878787; + height: 2px; + position: absolute; + width: 10px; + + &.chevron-left { + left: 0; + transform: rotateZ(45deg) scale(0.6); + } + + &.chevron-right { + right: 0; + transform: rotateZ(-45deg) scale(0.6); + } + } + } + + #jump-to { + opacity: 0; + font-size: 16px; + + position: absolute; + top: 5px; + left: 0; + width: 100%; + height: 100%; + } + } + } +} + +article { + margin-top: 25px; + + #content { + @extend .clearfix; + + background: $content-background; + border: 1px solid $content-border; + padding: 15px 25px 30px 25px; + + font-size: 1.4em; + line-height: 1.45; + + position: relative; + + @media (max-width: $mobile-max-width) { + padding: 15px 10px 20px 10px; + border: none; + } + + .navigation-top { + position: absolute; + top: 15px; + right: 25px; + } + + .title { + margin: 21px 0 0 0; + padding: 15px 0; + } + + p { + color: #414141; + margin: 0 0 15px 0; + } + + th, td { + p:last-child { + margin-bottom: 0; + } + } + + main { + ul { + list-style: none; + margin-left: 24px; + margin-bottom: 12px; + padding: 0; + + li { + position: relative; + padding-left: 1.3em; + + &:before { + content: "\02022"; + + color: #414141; + font-size: 1.08em; + line-height: 1; + + position: absolute; + left: 0; + padding-top: 2px; + } + } + } + } + + footer { + @extend .clearfix; + + .footer-copyright { + margin: 70px 25px 10px 0; + } + + p { + font-size: .71em; + color: #a0a0a0; + } + } + } +} diff --git a/docs/5.8.0/css/scss/_normalize.scss b/docs/5.8.0/css/scss/_normalize.scss new file mode 100644 index 00000000..9b8848a5 --- /dev/null +++ b/docs/5.8.0/css/scss/_normalize.scss @@ -0,0 +1,581 @@ +/* ========================================================================== + Normalize.scss settings + ========================================================================== */ +/** + * Includes legacy browser support IE6/7 + * + * Set to false if you want to drop support for IE6 and IE7 + */ + +$legacy_browser_support: false !default; + +/* Base + ========================================================================== */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + * 3. Corrects text resizing oddly in IE 6/7 when body `font-size` is set using + * `em` units. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ + @if $legacy_browser_support { + *font-size: 100%; /* 3 */ + } +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ + @if $legacy_browser_support { + *display: inline; + *zoom: 1; + } +} + +/** + * Prevents modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a { + &:active, &:hover { + outline: 0; + }; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +@if $legacy_browser_support { + blockquote { + margin: 1em 40px; + } +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +@if $legacy_browser_support { + h2 { + font-size: 1.5em; + margin: 0.83em 0; + } + + h3 { + font-size: 1.17em; + margin: 1em 0; + } + + h4 { + font-size: 1em; + margin: 1.33em 0; + } + + h5 { + font-size: 0.83em; + margin: 1.67em 0; + } + + h6 { + font-size: 0.67em; + margin: 2.33em 0; + } +} + +/** + * Addresses styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +@if $legacy_browser_support { + + /** + * Addresses margins set differently in IE 6/7. + */ + + p, + pre { + *margin: 1em 0; + } + + /* + * Addresses CSS quotes not supported in IE 6/7. + */ + + q { + *quotes: none; + } + + /* + * Addresses `quotes` property not supported in Safari 4. + */ + + q:before, + q:after { + content: ''; + content: none; + } +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +@if $legacy_browser_support { + + /* ========================================================================== + Lists + ========================================================================== */ + + /* + * Addresses margins set differently in IE 6/7. + */ + + dl, + menu, + ol, + ul { + *margin: 1em 0; + } + + dd { + *margin: 0 0 0 40px; + } + + /* + * Addresses paddings set differently in IE 6/7. + */ + + menu, + ol, + ul { + *padding: 0 0 0 40px; + } + + /* + * Corrects list images handled incorrectly in IE 7. + */ + + nav ul, + nav ol { + *list-style: none; + *list-style-image: none; + } + +} + +/* Embedded content + ========================================================================== */ + +/** + * 1. Remove border when inside `a` element in IE 8/9/10. + * 2. Improves image quality when scaled in IE 7. + */ + +img { + border: 0; + @if $legacy_browser_support { + *-ms-interpolation-mode: bicubic; /* 2 */ + } +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + @if $legacy_browser_support { + _font-family: 'courier new', monospace; + } + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + * 4. Improves appearance and consistency in all browsers. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ + @if $legacy_browser_support { + vertical-align: baseline; /* 3 */ + *vertical-align: middle; /* 3 */ + } +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + * 4. Removes inner spacing in IE 7 without affecting normal text inputs. + * Known issue: inner spacing remains in IE 6. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ + @if $legacy_browser_support { + *overflow: visible; /* 4 */ + } +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + * Known issue: excess padding remains in IE 6. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ + @if $legacy_browser_support { + *height: 13px; /* 3 */ + *width: 13px; /* 3 */ + } +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + * 3. Corrects text not wrapping in Firefox 3. + * 4. Corrects alignment displayed oddly in IE 6/7. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ + @if $legacy_browser_support { + white-space: normal; /* 3 */ + *margin-left: -7px; /* 4 */ + } +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/docs/5.8.0/css/scss/_object.scss b/docs/5.8.0/css/scss/_object.scss new file mode 100644 index 00000000..22eebd87 --- /dev/null +++ b/docs/5.8.0/css/scss/_object.scss @@ -0,0 +1,89 @@ +.section-specification { + table { + width: auto; + + th { + text-align: left; + } + } +} + +.method-title { + margin-left: -15px; + margin-bottom: 8px; + transition: margin-left .3s ease-out; + + .section-method.hide & { + margin-left: 0; + } + + code { + font-weight: 400; + font-size: .85em; + } +} + +.method-info { + background: $object-background; + border-bottom: 1px solid $object-border; + margin: 0 -25px; + padding: 20px 25px 0 25px; + transition: height .3s ease-out; + + position: relative; + + .pointy-thing { + background: $content-background; + height: 10px; + border-bottom: 1px solid $object-border; + margin: -20px -25px 16px -25px; + + &:before { + display: inline-block; + content: ""; + + background: $object-background; + border: 1px solid $object-border; + border-bottom: 0; + border-right: 0; + + position: absolute; + left: 21px; + top: 3px; + width: 12px; + height: 12px; + transform: rotate(45deg); + } + } + + .method-subsection { + margin-bottom: 15px; + + .argument-name { + width: 1px; + text-align: right; + + code { + color: #808080; + font-style: italic; + font-weight: 400; + } + } + } +} + +.section-method { + &.hide .method-info { + height: 0 !important; + overflow: hidden; + display: none; + } + + &.hide.animating .method-info { + display: block; + } + + &.animating .method-info { + overflow: hidden; + } +} diff --git a/docs/5.8.0/css/scss/_print.scss b/docs/5.8.0/css/scss/_print.scss new file mode 100644 index 00000000..61bdf99f --- /dev/null +++ b/docs/5.8.0/css/scss/_print.scss @@ -0,0 +1,42 @@ +@media print { + body { + background: #fff; + padding: 8px; + } + + header { + position: static; + background: #fff; + color: #000; + } + + aside { + display: none; + } + + .container { + max-width: none; + padding: 0; + } + + article { + margin-top: 0; + + #content { + border: 0; + background: #fff; + padding: 15px 0 0 0; + + .title { + margin-top: 0; + padding-top: 0; + } + } + } + + .method-info { + &, & .pointy-thing { + background: #fff; + } + } +} diff --git a/docs/5.8.0/css/scss/_variables.scss b/docs/5.8.0/css/scss/_variables.scss new file mode 100644 index 00000000..38e072d3 --- /dev/null +++ b/docs/5.8.0/css/scss/_variables.scss @@ -0,0 +1,12 @@ +$body-font: -apple-system-font, "Helvetica Neue", Helvetica, sans-serif; +$code-font: "Source Code Pro", Monaco, Menlo, Consolas, monospace; + +$body-background: #f2f2f2; +$content-background: #fff; +$content-border: #e9e9e9; +$tint-color: #08c; +$object-background: #f9f9f9; +$object-border: #e9e9e9; + +$mobile-max-width: 650px; +$desktop-min-width: 768px; \ No newline at end of file diff --git a/docs/5.8.0/css/scss/_xcode.scss b/docs/5.8.0/css/scss/_xcode.scss new file mode 100644 index 00000000..340b1f6b --- /dev/null +++ b/docs/5.8.0/css/scss/_xcode.scss @@ -0,0 +1,29 @@ +.xcode { + header, aside { + display: none; + } + + .container { + padding: 0; + } + + article { + margin-top: 0; + + #content { + border: 0; + margin: 0; + } + } + + .method-info { + &, .section-method.hide & { + max-height: auto; + overflow: visible; + + &.hiding { + display: block; + } + } + } +} diff --git a/docs/5.8.0/css/scss/style.scss b/docs/5.8.0/css/scss/style.scss new file mode 100644 index 00000000..648a6086 --- /dev/null +++ b/docs/5.8.0/css/scss/style.scss @@ -0,0 +1 @@ +@import "variables", "normalize", "layout", "index", "object", "print", "xcode"; diff --git a/docs/5.8.0/css/style.css b/docs/5.8.0/css/style.css new file mode 100644 index 00000000..d9d59dd0 --- /dev/null +++ b/docs/5.8.0/css/style.css @@ -0,0 +1,2 @@ +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:0.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace, monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:0.35em 0.625em 0.75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}*{box-sizing:border-box}.clear{clear:both}.clearfix:before,.container:before,article #content:before,article #content footer:before,.clearfix:after,.container:after,article #content:after,article #content footer:after{clear:both;display:table;content:""}.xcode .hide-in-xcode{display:none}body{font:62.5% -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;background:#f2f2f2}@media (max-width: 650px){body{background-color:#fff}}h1,h2,h3{font-weight:300;color:#808080}h1{font-size:2em;color:#000}h4{font-size:13px;line-height:1.5;margin:21px 0 0 0}a{color:#08c;text-decoration:none}pre,code{font-family:"Source Code Pro",Monaco,Menlo,Consolas,monospace;word-wrap:break-word}pre>code,.method-declaration code{display:inline-block;font-size:.85em;padding:4px 0 4px 10px;border-left:5px solid rgba(0,155,51,0.2)}pre>code:before,.method-declaration code:before{content:"Objective-C";display:block;font:9px/1 -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;color:#009b33;text-transform:uppercase;letter-spacing:2px;padding-bottom:6px}pre>code{font-size:inherit}table,th,td{border:1px solid #e9e9e9}table{width:100%}th,td{padding:7px}th>:first-child,td>:first-child{margin-top:0}th>:last-child,td>:last-child{margin-bottom:0}.container{max-width:980px;padding:0 10px;margin:0 auto}@media (max-width: 650px){.container{padding:0}}header{position:fixed;top:0;left:0;width:100%;z-index:2;background:#414141;color:#fff;font-size:1.1em;line-height:25px;letter-spacing:.05em}header #library-title{float:left}header #developer-home{float:right}header h1{font-size:inherit;font-weight:inherit;margin:0}header p{margin:0}header h1,header a{color:inherit}@media (max-width: 650px){header .container{padding:0 10px}}aside{position:fixed;top:25px;left:0;width:100%;height:25px;z-index:2;font-size:1.1em}aside #header-buttons{background:rgba(255,255,255,0.8);margin:0 1px;padding:0;list-style:none;text-align:right;line-height:32px}aside #header-buttons li{display:inline-block;cursor:pointer;padding:0 10px}aside #header-buttons label,aside #header-buttons select{cursor:inherit}aside #header-buttons #on-this-page{position:relative}aside #header-buttons #on-this-page .chevron{display:inline-block;width:14px;height:4px;position:relative}aside #header-buttons #on-this-page .chevron .chevy{background:#878787;height:2px;position:absolute;width:10px}aside #header-buttons #on-this-page .chevron .chevy.chevron-left{left:0;transform:rotateZ(45deg) scale(0.6)}aside #header-buttons #on-this-page .chevron .chevy.chevron-right{right:0;transform:rotateZ(-45deg) scale(0.6)}aside #header-buttons #on-this-page #jump-to{opacity:0;font-size:16px;position:absolute;top:5px;left:0;width:100%;height:100%}article{margin-top:25px}article #content{background:#fff;border:1px solid #e9e9e9;padding:15px 25px 30px 25px;font-size:1.4em;line-height:1.45;position:relative}@media (max-width: 650px){article #content{padding:15px 10px 20px 10px;border:none}}article #content .navigation-top{position:absolute;top:15px;right:25px}article #content .title{margin:21px 0 0 0;padding:15px 0}article #content p{color:#414141;margin:0 0 15px 0}article #content th p:last-child,article #content td p:last-child{margin-bottom:0}article #content main ul{list-style:none;margin-left:24px;margin-bottom:12px;padding:0}article #content main ul li{position:relative;padding-left:1.3em}article #content main ul li:before{content:"\02022";color:#414141;font-size:1.08em;line-height:1;position:absolute;left:0;padding-top:2px}article #content footer .footer-copyright{margin:70px 25px 10px 0}article #content footer p{font-size:.71em;color:#a0a0a0}.index-container{-webkit-flex-direction:column;flex-direction:column}@media (min-width: 768px){.index-container{display:flex;-webkit-flex-direction:row;flex-direction:row;-webkit-flex-wrap:wrap;flex-wrap:wrap}}.index-container .index-column{-webkit-flex:1 1 33%;flex:1 1 33%}.section-specification table{width:auto}.section-specification table th{text-align:left}.method-title{margin-left:-15px;margin-bottom:8px;transition:margin-left .3s ease-out}.section-method.hide .method-title{margin-left:0}.method-title code{font-weight:400;font-size:.85em}.method-info{background:#f9f9f9;border-bottom:1px solid #e9e9e9;margin:0 -25px;padding:20px 25px 0 25px;transition:height .3s ease-out;position:relative}.method-info .pointy-thing{background:#fff;height:10px;border-bottom:1px solid #e9e9e9;margin:-20px -25px 16px -25px}.method-info .pointy-thing:before{display:inline-block;content:"";background:#f9f9f9;border:1px solid #e9e9e9;border-bottom:0;border-right:0;position:absolute;left:21px;top:3px;width:12px;height:12px;-webkit-transform:rotate(45deg);transform:rotate(45deg) }.method-info .method-subsection{margin-bottom:15px}.method-info .method-subsection .argument-name{width:1px;text-align:right}.method-info .method-subsection .argument-name code{color:#808080;font-style:italic;font-weight:400}.section-method.hide .method-info{height:0 !important;overflow:hidden;display:none}.section-method.hide.animating .method-info{display:block}.section-method.animating .method-info{overflow:hidden}@media print{body{background:#fff;padding:8px}header{position:static;background:#fff;color:#000}aside{display:none}.container{max-width:none;padding:0}article{margin-top:0}article #content{border:0;background:#fff;padding:15px 0 0 0}article #content .title{margin-top:0;padding-top:0}.method-info,.method-info .pointy-thing{background:#fff}}.xcode header,.xcode aside{display:none}.xcode .container{padding:0}.xcode article{margin-top:0}.xcode article #content{border:0;margin:0}.xcode .method-info,.section-method.hide .xcode .method-info{max-height:auto;overflow:visible}.xcode .method-info.hiding,.section-method.hide .xcode .method-info.hiding{display:block} + diff --git a/docs/5.8.0/hierarchy.html b/docs/5.8.0/hierarchy.html new file mode 100644 index 00000000..839be4ae --- /dev/null +++ b/docs/5.8.0/hierarchy.html @@ -0,0 +1,404 @@ + + + + + + Twilio Video Hierarchy + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

Twilio Video Hierarchy

+ + +
+

Class Hierarchy

+ + + +
+ + + +
+ +

Protocol References

+ + + +

Constant References

+ + + +

Category References

+ + +
+ + + +
+
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/img/button_bar_background.png b/docs/5.8.0/img/button_bar_background.png new file mode 100644 index 00000000..71d1019b Binary files /dev/null and b/docs/5.8.0/img/button_bar_background.png differ diff --git a/docs/5.8.0/img/disclosure.png b/docs/5.8.0/img/disclosure.png new file mode 100644 index 00000000..4c5cbf44 Binary files /dev/null and b/docs/5.8.0/img/disclosure.png differ diff --git a/docs/5.8.0/img/disclosure_open.png b/docs/5.8.0/img/disclosure_open.png new file mode 100644 index 00000000..82396fed Binary files /dev/null and b/docs/5.8.0/img/disclosure_open.png differ diff --git a/docs/5.8.0/img/library_background.png b/docs/5.8.0/img/library_background.png new file mode 100644 index 00000000..3006248a Binary files /dev/null and b/docs/5.8.0/img/library_background.png differ diff --git a/docs/5.8.0/img/title_background.png b/docs/5.8.0/img/title_background.png new file mode 100644 index 00000000..846e4968 Binary files /dev/null and b/docs/5.8.0/img/title_background.png differ diff --git a/docs/5.8.0/index.html b/docs/5.8.0/index.html new file mode 100644 index 00000000..5515c2c0 --- /dev/null +++ b/docs/5.8.0/index.html @@ -0,0 +1,338 @@ + + + + + + Twilio Video Reference + + + + + + +
+
+ +

+ Twilio Video +

+ +

+ Twilio Inc. +

+ +
+
+ + + +
+
+
+
+

Twilio Video Reference

+ + + +
+ + + +
+

Class References

+ +
+ + + +
+ +

Protocol References

+ + + + +

Constant References

+ + + + +

Category References

+ + +
+ +
+ + +
+
+
+
+ + + + + \ No newline at end of file diff --git a/docs/5.8.0/js/script.js b/docs/5.8.0/js/script.js new file mode 100644 index 00000000..4074361c --- /dev/null +++ b/docs/5.8.0/js/script.js @@ -0,0 +1,59 @@ +function $() { + return document.querySelector.apply(document, arguments); +} + +if (navigator.userAgent.indexOf("Xcode") != -1) { + document.documentElement.classList.add("xcode"); +} + +var jumpTo = $("#jump-to"); + +if (jumpTo) { + jumpTo.addEventListener("change", function(e) { + location.hash = this.options[this.selectedIndex].value; + }); +} + +function hashChanged() { + if (/^#\/\/api\//.test(location.hash)) { + var element = document.querySelector("a[name='" + location.hash.substring(1) + "']"); + + if (!element) { + return; + } + + element = element.parentNode; + + element.classList.remove("hide"); + fixScrollPosition(element); + } +} + +function fixScrollPosition(element) { + var scrollTop = element.offsetTop - 150; + document.documentElement.scrollTop = scrollTop; + document.body.scrollTop = scrollTop; +} + +[].forEach.call(document.querySelectorAll(".section-method"), function(element) { + element.classList.add("hide"); + + element.querySelector(".method-title a").addEventListener("click", function(e) { + var info = element.querySelector(".method-info"), + infoContainer = element.querySelector(".method-info-container"); + + element.classList.add("animating"); + info.style.height = (infoContainer.clientHeight + 40) + "px"; + fixScrollPosition(element); + element.classList.toggle("hide"); + if (element.classList.contains("hide")) { + e.preventDefault(); + } + setTimeout(function() { + element.classList.remove("animating"); + }, 300); + }); +}); + +window.addEventListener("hashchange", hashChanged); +hashChanged(); diff --git a/docs/latest b/docs/latest index 262122f6..edb1d397 120000 --- a/docs/latest +++ b/docs/latest @@ -1 +1 @@ -5.7.1 \ No newline at end of file +5.8.0 \ No newline at end of file diff --git a/docs/latest_5.x b/docs/latest_5.x index 262122f6..edb1d397 120000 --- a/docs/latest_5.x +++ b/docs/latest_5.x @@ -1 +1 @@ -5.7.1 \ No newline at end of file +5.8.0 \ No newline at end of file