All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
SessionRecorderController.h File Reference

Controller to access the session recording functionality in the Vuforia Engine. More...

Classes

struct  VuRecordingConfig
 Configuration options for a recording session. More...
 

Typedefs

typedef struct VuRecording_ VuRecording
 Recording instance.
 
typedef struct VuRecordingList_ VuRecordingList
 Recording list handle.
 
typedef VuFlags VuRecordingDataFlags
 Bitflag defining a collection of data flags.
 

Enumerations

enum  VuRecordingCreationError : int32_t {
  VU_RECORDING_CREATION_ERROR_NONE = 0x0 ,
  VU_RECORDING_CREATION_ERROR_DATA_FLAGS_NOT_SUPPORTED ,
  VU_RECORDING_CREATION_ERROR_AUTOSTART_FAILED = 0x2
}
 Recording creation error. More...
 
enum  VuRecordingStartError : int32_t {
  VU_RECORDING_START_ERROR_NONE = 0x0 ,
  VU_RECORDING_START_ERROR_INTERNAL ,
  VU_RECORDING_START_ERROR_ANOTHER_RECORDING_RUNNING = 0x2 ,
  VU_RECORDING_START_ERROR_ENGINE_NOT_RUNNING = 0x3 ,
  VU_RECORDING_START_ERROR_INVALID_STATUS ,
  VU_RECORDING_START_ERROR_FILE_CREATION = 0x5 ,
  VU_RECORDING_START_ERROR_UNKNOWN_ORIENTATION = 0x6 ,
  VU_RECORDING_START_ERROR_DATA_SOURCE ,
  VU_RECORDING_START_ERROR_INSUFFICIENT_FREE_SPACE
}
 Recording start error. More...
 
enum  VuRecordingStatus : int32_t {
  VU_RECORDING_STATUS_INITIALIZED = 0x1 ,
  VU_RECORDING_STATUS_RUNNING = 0x2 ,
  VU_RECORDING_STATUS_STOPPED = 0x3
}
 Session recording status. More...
 
enum  VuRecordingStatusInfo : int32_t {
  VU_RECORDING_STATUS_INFO_NORMAL = 0x0 ,
  VU_RECORDING_STATUS_INFO_SUCCESS = 0x1 ,
  VU_RECORDING_STATUS_INFO_ERROR_INTERNAL ,
  VU_RECORDING_STATUS_INFO_ERROR_ORIENTATION_CHANGED = 0x3 ,
  VU_RECORDING_STATUS_INFO_ERROR_DATA_SOURCE = 0x4 ,
  VU_RECORDING_STATUS_INFO_ERROR_INSUFFICIENT_FREE_SPACE
}
 Session recording status info. More...
 
enum  VuRecordingDataFlagBits : int32_t {
  VU_RECORDING_DATA_VIDEO_BIT = 0x01 ,
  VU_RECORDING_DATA_CAMERA_METADATA_BIT = 0x02 ,
  VU_RECORDING_DATA_SENSORS_BIT = 0x04 ,
  VU_RECORDING_DATA_DEVICE_POSE_BIT = 0x08 ,
  VU_RECORDING_DATA_AUDIO_BIT = 0x10
}
 Flags that specify which data should be recorded. More...
 
enum  VuRecordingFrameRate : int32_t {
  VU_RECORDING_FRAME_RATE_AUTO = 0x1 ,
  VU_RECORDING_FRAME_RATE_FULL = 0x2 ,
  VU_RECORDING_FRAME_RATE_HALF = 0x3
}
 The frame rate at which camera images are recorded. More...
 
enum  VuRecordingImageScale : int32_t {
  VU_RECORDING_IMAGE_SCALE_AUTO = 0x1 ,
  VU_RECORDING_IMAGE_SCALE_FULL = 0x2 ,
  VU_RECORDING_IMAGE_SCALE_HALF = 0x3
}
 The scale factor to be applied to camera images before recording. More...
 
enum  VuRecordingVideoEncodingQuality : int32_t {
  VU_RECORDING_VIDEO_ENCODING_QUALITY_HIGH = 0x1 ,
  VU_RECORDING_VIDEO_ENCODING_QUALITY_MEDIUM = 0x2
}
 Quality settings used for encoding the recorded video. More...
 
enum  VuRecordingFormat : int32_t { VU_RECORDING_FORMAT_DEFAULT = 0x1 }
 Session recording format. More...
 

Functions

VuRecordingConfig vuRecordingConfigDefault ()
 Default configuration for a recording session.
 
VuResult vuEngineGetSessionRecorderController (const VuEngine *engine, VuController **controller)
 Retrieve Session Recorder Controller to get access to session recording-specific functionality in Engine.
 
VuResult vuSessionRecorderControllerGetDefaultRecordingDataFlags (const VuController *controller, VuRecordingDataFlags *dataFlags)
 Get the default recording data flags that are appropriate for the current device.
 
VuResult vuSessionRecorderControllerGetSupportedRecordingDataFlags (const VuController *controller, VuRecordingDataFlags *dataFlags)
 Get all recording data flags that are supported by the current device.
 
VuResult vuSessionRecorderControllerGetDefaultRecordingFrameRate (const VuController *controller, VuRecordingFrameRate *frameRate)
 Get the default camera recording frame rate.
 
VuResult vuSessionRecorderControllerGetDefaultRecordingImageScale (const VuController *controller, VuRecordingImageScale *scale)
 Get the default recording image scale.
 
VuResult vuSessionRecorderControllerCreateRecording (VuController *controller, const VuRecordingConfig *config, VuRecording **recording, VuRecordingCreationError *error)
 Create a new recording with the specified configuration.
 
VuResult vuSessionRecorderControllerGetRecordings (const VuController *controller, VuRecordingList *recordingList)
 Get a list of all recordings from the controller.
 
VuResult vuSessionRecorderControllerDestroyRecordings (VuController *controller, VuBool deleteData)
 Destroy all recordings.
 
VuResult vuSessionRecorderControllerCleanRecordedData (VuController *controller)
 Remove all previously recorded sequences from the device storage.
 
VuResult vuRecordingStart (VuRecording *recording, VuRecordingStartError *error)
 Start the recording.
 
VuResult vuRecordingStop (VuRecording *recording)
 Stop the current recording.
 
VuResult vuRecordingGetPath (const VuRecording *recording, const char **path)
 Get the path where the data for this recording is stored.
 
VuResult vuRecordingGetStatus (const VuRecording *recording, VuRecordingStatus *status)
 Get the status of a recording.
 
VuResult vuRecordingGetStatusInfo (const VuRecording *recording, VuRecordingStatusInfo *statusInfo)
 Get additional status info about a recording.
 
VuResult vuRecordingDestroy (VuRecording *recording, VuBool deleteData)
 Destroy a recording instance.
 
VuResult vuRecordingListCreate (VuRecordingList **list)
 Create a recording list.
 
VuResult vuRecordingListGetSize (const VuRecordingList *list, int32_t *listSize)
 Get the number of elements in a recording list.
 
VuResult vuRecordingListGetElement (const VuRecordingList *list, int32_t element, VuRecording **recording)
 Get an element in a recording list.
 
VuResult vuRecordingListDestroy (VuRecordingList *list)
 Destroy a recording list.
 

Detailed Description

Controller to access the session recording functionality in the Vuforia Engine.