The following API allows you to control when the session gets recorded.
Start recording
Starts the UXCam application to ping the server, get the settings configurations and start capturing the data according to the configuration.
Use startWithKey with appVariantIdentifier parameter to separate Debug and Release builds.
SDK 3.0.0 and above
+ (void) startWithKey:(NSString*) userAPIKey;
+ (void) startWithKey:(NSString*)userAPIKey
buildIdentifier:(NSString*)appVariant;
SDK below 3.0.0
+ (void) startWithKey:(NSString*) applicationKey;
+ (void) startWithKey:(NSString*)applicationKey appVariantIdentifier:(NSString*)appVariant;SDK 3.0.0 and above
UXCam.startWithKey (String userAPIKey)
SDK 3.0.0 and below
UXCam.startWithKey(UXCamKey);
UXCam.startWithKey(UXCamKey, buildIdentifier);
UXCam.StartWithKey(UXCamKey);
The API parameters are:
applicationKey / userAPIKey: App-key (found on UXCam dashboard)
appVariantIdentifier / buildIdentifier: nil by default, pass parameters appVariantIdentifier or buildIdentifier to separate Debug and Release builds
Stop recording
Stops the UXCam application and sends captured data to the server. Use this to start sending the data on UXCam server without the app going on background.
SDK 3.0.0 and above (void) stopSessionAndUploadData;
SDK below 3.0.0+ (void) stopApplicationAndUploadData;
SDK 3.0.0 and above
UXCam.stopApplicationAndUploadSession();
SDK 3.0.0 and below
UXCam.stopApplicationAndUploadData();
UXCam.StopApplicationAndUploadData();
Pause recording
Pauses the screen recording of the current session indefinitely. Call resumeRecording to start recording again.
Resume recording
Resumes recording of the screen video and gestures when video recording has been paused.
+(void) resumeScreenRecording();
UXCam.resume()UXCam.resume()
Allow short break for another app
Prevent a short trip to another app causing a break in a session
+(void) allowShortBreakForAnotherApp:(BOOL)continueSession;
UXCam.allowShortBreakForAnotherApp()
UXCam.resumeShortBreakForAnotherApp()UXCam.allowShortBreakForAnotherApp(continueSession)
The API parameters are:
continueSession: Set to TRUE to continue the current session after a short trip out to another app. Default is FALSE - stops the session as soon as the app enters the background.
Cancel recording
Cancels the recording of the current session and discards the data.
+ (void) cancelCurrentSession;
UXCam.cancelRecording()UXCam.cancelRecording()