TVICameraSourceOptions Class Reference

Inherits from NSObject
Declared in TVICameraSourceOptions.h

Overview

Represents immutable configuration options for a TVICameraSource.

  enableManualOrientation

Allows you to override how frames produced by TVICameraSource are tagged. Defaults to NO.

@property (nonatomic, assign, readonly) BOOL enableManualOrientation

Discussion

This method is for advanced use cases. By default TVICameraSource derives orientation tags based upon listening to changes in the status bar’s orientation. However, you may wish to listen for UIDeviceOrientation or some other input source instead.

Note that the video data output connection will always be 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.

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

  orientation

The initial orientation tag to use. Only valid when enableManualOrientation is set to YES. Defaults to TVIVideoOrientationUp.

@property (nonatomic, assign, readonly) TVIVideoOrientation orientation

Discussion

If you’ve already determined the orientation you would like to tag frames with, then you can set it here. This ensures that the first frame produced by the source will have the tag that you expect.

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

– 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