TVICameraSourceOptions Class Reference

Inherits from NSObject
Declared in TVICameraSourceOptions.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