ORKVideoCaptureStep Class Reference
|ORKStep : NSObject
ORKVideoCaptureStep class represents a step that captures a video through the device
camera. A template image can optionally be laid over the camera preview to assist in properly
capturing the video.
If implementing a video capture task like this one, remember that people will take your instructions literally. So be cautious. Make sure your template image is high contrast and very visible against a variety of backgrounds.
The recording length can be a max of 20 minutes. It defaults to 2 minutes.
An image to be displayed over the camera preview.
@property (nonatomic, strong) UIImage *templateImage
The image is stretched to fit the available space while retaining its aspect ratio. When choosing a size for this asset, be sure to take into account the variations in device form factors.
Insets to be used in positioning and sizing the
@property (nonatomic) UIEdgeInsets templateImageInsets
The insets are interpreted as percentages relative to the preview frame size. The left and right insets are relative to the width of the preview frame. The top and bottom insets are relative to the height of the preview frame.
The duration, in seconds, for the recording.
@property (nonatomic) NSNumber *duration
The maximum that this can be set to is 20.0 minutes (60*20 seconds). The minimum that this can be set to is 0.01 minutes (1 second).
The default value is 2.0 minutes (60*2 seconds).
A Boolean indicating whether the audio is recorded or not.
@property (nonatomic, getter=isAudioMute) BOOL audioMute
The default value is NO.
Constants indicating the mode of the flash on the receiver’s device, if it has one.
@property (nonatomic) AVCaptureFlashMode flashMode
The default value is
Constants indicating the physical position of an AVCaptureDevice’s hardware on the system.
@property (nonatomic) AVCaptureDevicePosition devicePosition
The default value is
AVCaptureDevicePositionUnspecified is set, then it defaults to
An accessibility hint of the capture preview.
@property (nonatomic, copy) NSString *accessibilityInstructions
This property can be used to specify accessible instructions for capturing the video. The
use of this property can assist when the
templateImage may not be visible
to the user.
For example, if you want to capture a video of the user’s right hand, you may use a template image that displays the outline of the right hand. You may also want to set this property to a string such as @“Extend your right hand, palm side down, one foot from your device. Tap the Capture Video button, or two finger tap on the preview, to capture a video of your extended right hand.”
An accessibility hint of the capture button.
@property (nonatomic, copy) NSString *accessibilityHint