HoloplayRecorder.cs

(v1.4 or later) Windows and Mac only.
There is currently a known issue where OSX builds export videos that are tinted blue. We are targeting a fix for version 1.4.2 of the plugin.
This script allows you to record a quilt video with or without a Looking Glass connected to your device.
Fields
OutputPath
Type: string
The name of the recorded video file.
We add additional text at the end of the file name to specify details of the recording
You can preview the full file name in the Full name field in the inspector or access it with AutoCorrectPath via script. The auto-correction to the end of the final name is intended to work with HoloPlay Studio to automate the rendering process, and it also adds the correct extension based on the FFmpeg preset.
Note The format of the name of quilt videos should be [your video name]_qs[view colum]x[view row]a[aspect]. For example, a Looking Glass Portrait quilt video could be named "example_qs8x6a0.75.mp4". It will be read in HoloPlay Studio as a quilt video with 8 colums, 6 rows, and an aspect of 0.75. See more information on HoloPlay Studio here.
Preset
Type: FFmpegPreset
Allows you to choose an FFmpeg encoding preset. VP8 is our recommended format.
Specific encoder settings can be found in FFmpegPreset.cs - we recommend against customizing these settings unless you are very familiar with encoders and FFmpeg.
Note H264Nvidia and HevcNvidia are Windows-only.
FrameRate
Type: int
Allows you to change the frame rate of the video.
If a clip is referenced in Video Clip, the frame rate will change to the frame rate of the video referenced.
TargetBitrateInMegabits
Type: int
Bitrate used for encoding in FFmpeg.
Compression
Type: int
Compression value used for encoding in FFmpeg.
isOverwrite
Type: boolean
When true, the quilt settings specified in this script will overwrite the quiltPreset of HoloPlay instance while recording. When a recording is ended, the quilt preset of that HoloPlay instance will be set back to its origin. Allows you to have different rendering quilt at recording and non-recording period.
overwriteQuiltSettings
Type:Quilt.Settings
The settings that are used to overwrite the quilt settings of Holoplay instance.
quiltSettings
Type:Quilt.Settings
Return the quilt settings that is applied on recording. It returns Holoplay Instance if isOverwrite is true; otherwise, it return overwriteQuiltSettings.
overwriteNearClipFactor
Type: float
The value that are used to overwrite the nearClipFactor of Holoplay instance.
State
Type: RecorderState
An enum value shows current state of the recorder. There are 3 states: NotRecording, Recording, Pausing.
videoClip
Type: VideoPlayer
If you are recording a depth video with the Holoplay Recorder, reference the clip here so the FPS of the recorder can be synced to the FPS of the video.
recordOnStart
Type: Boolean
When true, the recording will begin when the play mode button is pressed.
matchRecordingDuration
Type: Boolean
When true, recording will automatically end when the referenced clip has ended.
exitPlayModeOnEnd
Type: Boolean
When true, play mode will exit when the recording has ended.
Functions
StartRecord()
Returns: void
Method to start recording. The output path will be AutoCorrectPath which is automatically generated based on outputPath.
StartRecordWithPath(string path)
return: void
Start a video recording that will be saved to a specific path.
EndRecord()
Returns: void
End current recording.
PauseRecord()
Returns: void
Pause recording.
ResumeRecord()
Returns: void
Resume recording.
OrbitControl.cs
SimpleDOF.cs
Last modified 1yr ago