LookbackRecordingOptions

Conforms to:
NSCopying
Superclass:
NSObject
Declared In:

Introduction

Model object for Lookback recording options.

Pass to the Lookback singleton after configuring various properties to customize recording & UI.



Methods

-init

init


- (instancetype)init; 
Discussion

Return a new LookbackRecordingOptions with all the defaults from the global options. Customize as you will, then start a recording with it.


Properties

afterRecording
allowResumeRecordingFromPreview
allowSavingPreviewsAsDrafts
automaticallyRecordViewControllerNames
cameraEnabled
cameraName
captureClicks
consoleRecordingEnabled
framerateLimit
microphoneEnabled
microphoneName
onStartedUpload
pixelDensity
projectId
screenCrop
screenId
showCameraPreviewWhileRecording
timeout
userIdentifier

afterRecording


@property(nonatomic) LookbackAfterRecordingOption afterRecording; 
Discussion

afterRecording controls the behavior of Lookback when the user stops recording, or recording times out (

See

timeout).

LookbackAfterRecordingReview will let the user manually preview a recording after it's been stopped, and decide wheter to upload or discard it; give it a name; and so on.

of a timeout, it will also start a new recording the next time the app is brought to the foreground.

is basically the 'diary study' mode, where the user is always recorded.


allowResumeRecordingFromPreview


@property(nonatomic) BOOL allowResumeRecordingFromPreview; 
Discussion

*


allowSavingPreviewsAsDrafts


@property(nonatomic) BOOL allowSavingPreviewsAsDrafts; 
Discussion

*


automaticallyRecordViewControllerNames


@property(nonatomic) BOOL automaticallyRecordViewControllerNames; 
Discussion

Default YES. With this setting, all the view controllers you visit during a recording will be recorded, and their names displayed on the timeline. Disable this to not record view names, or to manually track view names using enteredView: and exitedView:.

If you wish to customize the name that your view controller is logged as, you can implement +(NSString*)lookbackIdentifier in your view controller.


cameraEnabled


@property(nonatomic) BOOL cameraEnabled; 
Discussion

When doing a Lookback screen recording, should the user's face also be recorded through the device's front-facing camera?


cameraName


@property(nonatomic,
    copy) NSString *cameraName; 
Discussion

*


captureClicks


@property(nonatomic) BOOL captureClicks; 
Discussion

Whether we show the mouse clicks on the captured video

Default value: NO


consoleRecordingEnabled


@property(nonatomic) BOOL consoleRecordingEnabled; 
Discussion

When doing a Lookback screen recording, should the app's console log also be recorded?


framerateLimit


@property(nonatomic) int framerateLimit; 
Discussion

Set a specific upper limit on screen recording framerate. Note that Lookback adapts framerate dynamically based on available CPU.

Decreasing the framerate is the best way to fix performance problems with Lookback.

Default value: 60 (which means allowing fully dynamic framerate) Range: 1 to 60


microphoneEnabled


@property(nonatomic) BOOL microphoneEnabled; 
Discussion

When doing a Lookback screen recording, should the user's voice also be recorded through the device's microphone?


microphoneName


@property(nonatomic,
    copy) NSString *microphoneName; 
Discussion

*


onStartedUpload


@property(nonatomic,
    copy) void(^onStartedUpload)(NSURL *destinationURL,
    NSDate *sessionStartedAt); 
Discussion

*


pixelDensity


@property(nonatomic) float pixelDensity; 
Discussion

The pixel density of the screen that Lookback will use whilst recording. A one means standard pixel density.

Default value: 1.0


projectId


@property(nonatomic) NSString *projectId; 
Discussion

The ID of the project to assign this recording to once it has uploaded. nil by default, which will add the recording to the inbox.


screenCrop


@property(nonatomic) CGRect screenCrop; 
Discussion

The rectangle of the screen area that Lookback will record.

Default value: CGRectZero, which means record the whole screen.


screenId


@property(nonatomic) uint32_t screenId; 
Discussion

*


showCameraPreviewWhileRecording


@property(nonatomic) BOOL showCameraPreviewWhileRecording; 
Discussion

Whether the user should be shown a preview image of their face at the bottom-right of the screen while recording, to make sure that they are holding their device correctly and are well-framed.


timeout


@property(nonatomic) LookbackTimeoutOption timeout; 
Discussion

Controls the timeout option when the app becomes inactive. "Inactive" in this context means that the user exists the app, or locks the screen.

- Using 0 will stop a recording as soon as the app becomes inactive. - Using NSIntegerMax will never terminate a recording when the app becomes inactive. - Any value in between will timeout and end the recording after the app has been inactive for the specified duration.


userIdentifier


@property(nonatomic,
    copy) NSString *userIdentifier; 
Discussion

Identifier for the user who's currently using the app. You can filter on this property at lookback.io later. If your service has log in user names, you can use that here. Optional.

See Also

http://lookback.io/docs/log-username