AVCaptureInputPort Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/AVFoundation.framework
Availability
Available in iOS 4.0 and later.
Declared in
AVCaptureInput.h

Overview

An AVCaptureInputPort represents a stream of data from a capture input.

Instances of AVCaptureInput have one or more input ports, one for each data stream they can produce. For example, an AVCaptureDeviceInput object presenting one video data stream has one port.

Tasks

Properties

Properties

clock

An object representing the capture device’s own clock. (read-only)

@property(nonatomic, readonly) CMClockRef clock
Discussion

The returned CMClock object is read-only and may not reflect the actual clock in the capture device.

Availability
  • Available in iOS 7.0 and later.
Declared In
AVCaptureInput.h

enabled

Indicates whether the port is enabled.

@property(nonatomic, getter=isEnabled) BOOL enabled
Discussion

The value of this property defaults to YES. If you want to capture only a subset of the media streams provided by an AVCaptureInput object, use this property to selectively disable streams.

Availability
  • Available in iOS 4.0 and later.
Declared In
AVCaptureInput.h

formatDescription

A description of the port format. (read-only)

@property(nonatomic, readonly) CMFormatDescriptionRef formatDescription
Discussion

The returned object describes the format of the media currently provided by the port. To be notified of format changes, subscribe to the AVCaptureInputPortFormatDescriptionDidChangeNotification notification.

Availability
  • Available in iOS 4.0 and later.
Declared In
AVCaptureInput.h

input

The input object that owns the port. (read-only)

@property(nonatomic, readonly) AVCaptureInput *input
Availability
  • Available in iOS 4.0 and later.
Declared In
AVCaptureInput.h

mediaType

The port’s media type. (read-only)

@property(nonatomic, readonly) NSString *mediaType
Availability
  • Available in iOS 4.0 and later.
See Also
Declared In
AVCaptureInput.h

Notifications

AVCaptureInputPortFormatDescriptionDidChangeNotification

Posted if the value of the capture input port’sformatDescription property changes.
Availability
Declared In
AVCaptureInput.h