Stay organized with collections
Save and categorize content based on your preferences.
ARCoreRecordingConfig
Configuration to record camera and sensor data from an ARCore session.
Summary
Inheritance
Inherits from:
UnityEngine::ScriptableObject
Public attributes
|
AutoStopOnPause = true
|
bool
Set to true to cause the recording to stop automatically when the session is paused, or set to false to allow the recording to continue until the session is destroyed or the recording is stopped manually.
|
Mp4DatasetUri
|
A URI where the MP4 recording (including video data from the camera and other device sensors) will be saved.
|
Tracks = new List()
|
The list of Track to add the recording config. |
Properties
|
Mp4DatasetFilepath
|
string
Deprecated.
Please use Mp4DatasetUri instead. Gets or sets the URI on the device where the MP4 recording will be saved as a file path. |
Public attributes
AutoStopOnPause
bool AutoStopOnPause = true
Set to true to cause the recording to stop automatically when the session is paused, or set to false to allow the recording to continue until the session is destroyed or the recording is stopped manually.
When set to false and the session is paused, recording of sensor data continues, but the camera feed will be recorded as a black screen until the session is resumed.
Mp4DatasetUri
Uri Mp4DatasetUri
A URI where the MP4 recording (including video data from the camera and other device sensors) will be saved.
If the resource already exists it will be overwritten. The AbsoluteUri property of the Uri will be passed to ARCore to create an android.net.Uri. The URI must point to a seekable resource.
Tracks
List< Track > Tracks = new List()
The list of Track to add the recording config.
This field is not available in the editor and should be set at runtime.
Properties
Mp4DatasetFilepath
string Mp4DatasetFilepath
Gets or sets the URI on the device where the MP4 recording will be saved as a file path.
The recording consists of video data from the camera along with data from the device sensors. If the file already exists it will be overwritten.
Deprecated.
Please use Mp4DatasetUri instead.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-14 UTC.
[null,null,["Last updated 2025-07-14 UTC."],[[["\u003cp\u003eARCoreRecordingConfig allows you to record camera and sensor data from an ARCore session and save it as an MP4 file.\u003c/p\u003e\n"],["\u003cp\u003eIt provides options to automatically stop recording when the session is paused (\u003ccode\u003eAutoStopOnPause\u003c/code\u003e) and to specify the save location using a URI (\u003ccode\u003eMp4DatasetUri\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eYou can configure which data tracks to include in the recording using the \u003ccode\u003eTracks\u003c/code\u003e property.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eMp4DatasetFilepath\u003c/code\u003e property is deprecated and \u003ccode\u003eMp4DatasetUri\u003c/code\u003e should be used instead for specifying the save location.\u003c/p\u003e\n"]]],["ARCoreRecordingConfig configures the recording of camera and sensor data. Key actions include setting `AutoStopOnPause` to control recording behavior during session pauses (defaulting to true) and specifying `Mp4DatasetUri`, the save location for the MP4 recording. The `Tracks` list allows customization of included data. `Mp4DatasetFilepath` is a deprecated property, replaced by `Mp4DatasetUri`. If a file already exists at the given file path or `Mp4DatasetUri` it will be overwritten.\n"],null,["# ARCoreRecordingConfig Class Reference\n\nARCoreRecordingConfig\n=====================\n\nConfiguration to record camera and sensor data from an ARCore session.\n\nSummary\n-------\n\n### Inheritance\n\nInherits from: [`UnityEngine::ScriptableObject`](https://docs.unity3d.com/ScriptReference/ScriptableObject.html)\n\n| ### Public attributes ||\n|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [AutoStopOnPause](#autostoponpause)` = true` | `bool` Set to `true` to cause the recording to stop automatically when the session is paused, or set to `false` to allow the recording to continue until the session is destroyed or the recording is stopped manually. |\n| [Mp4DatasetUri](#mp4dataseturi) | [Uri](https://docs.microsoft.com/en-us/dotnet/api/System.Uri) A URI where the MP4 recording (including video data from the camera and other device sensors) will be saved. |\n| [Tracks](#tracks)` = new List``()` | `List\u003c `[Track](/ar/reference/unity-arf/struct/Google/XR/ARCoreExtensions/Track#structGoogle_1_1XR_1_1ARCoreExtensions_1_1Track)` \u003e` The list of [Track](/ar/reference/unity-arf/struct/Google/XR/ARCoreExtensions/Track#structGoogle_1_1XR_1_1ARCoreExtensions_1_1Track) to add the recording config. |\n\n| ### Properties ||\n|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Mp4DatasetFilepath](#mp4datasetfilepath) | `string` **[Deprecated.](/ar/reference/unity-arf/deprecated/deprecated)** Please use Mp4DatasetUri instead. Gets or sets the URI on the device where the MP4 recording will be saved as a file path. |\n\nPublic attributes\n-----------------\n\n### AutoStopOnPause\n\n```c#\nbool AutoStopOnPause = true\n``` \nSet to `true` to cause the recording to stop automatically when the session is paused, or set to `false` to allow the recording to continue until the session is destroyed or the recording is stopped manually.\n\nWhen set to `false` and the session is paused, recording of sensor data continues, but the camera feed will be recorded as a black screen until the session is resumed. \n\n### Mp4DatasetUri\n\n```c#\nUri Mp4DatasetUri\n``` \nA URI where the MP4 recording (including video data from the camera and other device sensors) will be saved.\n\nIf the resource already exists it will be overwritten. The `AbsoluteUri` property of the Uri will be passed to ARCore to create an `android.net.Uri`. The URI must point to a seekable resource. \n\n### Tracks\n\n```c#\nList\u003c Track \u003e Tracks = new List()\n``` \nThe list of [Track](/ar/reference/unity-arf/struct/Google/XR/ARCoreExtensions/Track#structGoogle_1_1XR_1_1ARCoreExtensions_1_1Track) to add the recording config.\n\nThis field is not available in the editor and should be set at runtime.\n\nProperties\n----------\n\n### Mp4DatasetFilepath\n\n```c#\nstring Mp4DatasetFilepath\n``` \nGets or sets the URI on the device where the MP4 recording will be saved as a file path.\n\nThe recording consists of video data from the camera along with data from the device sensors. If the file already exists it will be overwritten.\n\n**[Deprecated.](/ar/reference/unity-arf/deprecated/deprecated)**Please use Mp4DatasetUri instead."]]
