Skip to content

AVCaptureDeviceInput ​

AVCaptureDeviceInput represents an input that connects a camera to an AVCaptureSession. It is created from an AVCaptureDevice; once added with the session's addInput(), the session takes its picture from this camera.

Creating it uses the camera: if the user hasn't been asked yet, the system shows the authorization alert at that moment; if the user hasn't granted authorization, it can't be created. See AVCaptureDevice.

It belongs to the @nacrejs/av-capture package; for installation, see AVCaptureSession.

Inheritance: EventTarget → NSObject → AVCaptureInput → AVCaptureDeviceInput

Constructor ​

AVCaptureDeviceInput()

Wraps a camera as a session input. Throws NSError without authorization.

Instance properties ​

Also inherits properties from NSObject.

PropertyDescription
device read-onlyWhich camera it connects

Instance methods ​

It has no methods of its own.

Examples ​

js
const session = new AVCaptureSession();
const camera = AVCaptureDevice.defaultDeviceWithMediaType('video');
if (camera !== null) {
  try {
    const input = new AVCaptureDeviceInput(camera);
    if (session.canAddInput(input)) session.addInput(input);
    console.log('Connected ' + input.device.localizedName);
  } catch (err) {
    console.log('Could not connect the camera: ' + (err instanceof Error ? err.message : String(err)));
  }
}

Effect

  • When the user has already agreed, the console prints Connected Back Camera (the name on an iPhone 14).
  • When the user hasn't been asked yet, new AVCaptureDeviceInput(camera) shows the authorization alert at that moment.
  • When the user has declined, the console prints Could not connect the camera: followed by the system's reason.

Corresponding iOS API ​

ObjCJS
[AVCaptureDeviceInput deviceInputWithDevice:device error:&error], which returns nil on failurenew AVCaptureDeviceInput(device), which throws an NSError on failure, whose domain is an empty string and code is 0, with the system's reason in message
input.deviceinput.device

See also ​