One Logo Pool Ball
CreateMLComponents · IOS API REFERENCE

VideoReader.CameraConfiguration

struct · iOS 16.0+ · SDK 27.1

struct CameraConfiguration

The configuration of the camera to pass to the `readCamera` method.

Members (11)

get · iOS 16.0+

resolution

TypeScript
get resolution(): VideoReader_CameraConfiguration_Resolution
Swift declaration
var resolution: VideoReader.CameraConfiguration.Resolution

The camera resolution specifying the quality of the video output. The default values is `.high`

set · iOS 16.0+

resolution

TypeScript
set resolution(value: VideoReader_CameraConfiguration_Resolution)
Swift declaration
var resolution: VideoReader.CameraConfiguration.Resolution

The camera resolution specifying the quality of the video output. The default values is `.high`

get · iOS 16.0+

pixelFormat

TypeScript
get pixelFormat(): VideoReader_CameraConfiguration_PixelFormat
Swift declaration
var pixelFormat: VideoReader.CameraConfiguration.PixelFormat

The camera pixel format. The default is `.bgra32`.

set · iOS 16.0+

pixelFormat

TypeScript
set pixelFormat(value: VideoReader_CameraConfiguration_PixelFormat)
Swift declaration
var pixelFormat: VideoReader.CameraConfiguration.PixelFormat

The camera pixel format. The default is `.bgra32`.

get · iOS 16.0+ · Deprecated in iOS 17.0

cameraPosition

TypeScript
get cameraPosition(): VideoReader_CameraConfiguration_Position
Swift declaration
var cameraPosition: VideoReader.CameraConfiguration.Position { get }

The camera position. For an iOS device this can be either `.front` or `.rear`. For devices with just one camera this value is ignored. The default value is `.front`.

init · iOS 16.0+

init

TypeScript
static initPositionPixelFormatResolutionFrameRate(position?: VideoReader_CameraConfiguration_Position, pixelFormat?: VideoReader_CameraConfiguration_PixelFormat, resolution?: VideoReader_CameraConfiguration_Resolution, frameRate?: number): VideoReader_CameraConfiguration
Swift declaration
init(position: VideoReader.CameraConfiguration.Position = .front, pixelFormat: VideoReader.CameraConfiguration.PixelFormat = .bgra32, resolution: VideoReader.CameraConfiguration.Resolution = .high, frameRate: Double = 30.0)

Creates a camera configuration. - Parameters: - position: The position of the camera. The default value is `.front`. For devices with just one camera this value is ignored. - pixelFormat: The pixel format of the camera frames. The default is `.bgra32`. - resolution: The camera resolution. The default values is `.high`. - frameRate: The camera frame rate. The default value is 30.0 frames per second.

get · iOS 16.0+

position

TypeScript
get position(): VideoReader_CameraConfiguration_Position
Swift declaration
var position: VideoReader.CameraConfiguration.Position

The camera position. For an iOS device this can be either `.front` or `.rear`. For devices with just one camera this value is ignored. The default value is `.front`.

set · iOS 16.0+

position

TypeScript
set position(value: VideoReader_CameraConfiguration_Position)
Swift declaration
var position: VideoReader.CameraConfiguration.Position

The camera position. For an iOS device this can be either `.front` or `.rear`. For devices with just one camera this value is ignored. The default value is `.front`.

get · iOS 16.0+

frameRate

TypeScript
get frameRate(): number
Swift declaration
var frameRate: Double

The camera frame rate. The default value is 30.0 frames per second.

set · iOS 16.0+

frameRate

TypeScript
set frameRate(value: number)
Swift declaration
var frameRate: Double

The camera frame rate. The default value is 30.0 frames per second.

init · iOS 16.0+

init

TypeScript
static init(): VideoReader_CameraConfiguration
Swift declaration
init()

Creates a camera configuration.

Skipped declarations

No declarations were skipped in this snapshot.

All CreateMLComponents types →