openspace.sessionRecording
Functions overview
Name |
Documentation |
|---|---|
Used to disable that renderings are saved during playback |
|
Enables that rendered frames should be saved during playback |
|
Performs a conversion of the specified file to the most most recent file format, creating a copy of the recording file |
|
Returns true if session recording is currently playing back a recording |
|
Returns true if session recording is currently recording a recording |
|
Pauses or resumes the playback progression through keyframes |
|
Starts a playback session with keyframe times that are relative to the time since the recording was started (the same relative time applies to the playback) |
|
Starts a playback session with keyframe times that are relative to application time (seconds since OpenSpace application started) |
|
Starts a playback session with keyframe times that are relative to the time since the recording was started (the same relative time applies to the playback) |
|
Starts a playback session with keyframe times that are relative to the simulated date & time |
|
Starts a recording session |
|
Starts a recording session |
|
Stops a playback session before playback of all keyframes is complete |
|
Stops a recording session |
|
Toggles the pause function, i |
Functions
disableTakeScreenShotDuringPlayback
Used to disable that renderings are saved during playback.
Return type: void
openspace.sessionRecording.disableTakeScreenShotDuringPlayback()
enableTakeScreenShotDuringPlayback
Enables that rendered frames should be saved during playback. The parameter determines the number of frames that are exported per second if this value is not provided, 60 frames per second will be exported.
fps
Integer?- Default value:60
Return type: void
openspace.sessionRecording.enableTakeScreenShotDuringPlayback(fps)
fileFormatConversion
Performs a conversion of the specified file to the most most recent file format, creating a copy of the recording file.
convertFilePath
String
Return type: void
openspace.sessionRecording.fileFormatConversion(convertFilePath)
isPlayingBack
Returns true if session recording is currently playing back a recording.
Return type: Boolean
openspace.sessionRecording.isPlayingBack()
isRecording
Returns true if session recording is currently recording a recording.
Return type: Boolean
openspace.sessionRecording.isRecording()
setPlaybackPause
Pauses or resumes the playback progression through keyframes.
pause
Boolean
Return type: void
openspace.sessionRecording.setPlaybackPause(pause)
startPlayback
Starts a playback session with keyframe times that are relative to the time since the recording was started (the same relative time applies to the playback). When playback starts, the simulation time is automatically set to what it was at recording time. The string argument is the filename to pull playback keyframes from (the file path is relative to the RECORDINGS variable specified in the config file). If a second input value of true is given, then playback will continually loop until it is manually stopped.
file
Stringloop
Boolean?- Default value:falseshouldWaitForTiles
Boolean?- Default value:true
Return type: void
openspace.sessionRecording.startPlayback(file, loop, shouldWaitForTiles)
startPlaybackApplicationTime
Starts a playback session with keyframe times that are relative to application time (seconds since OpenSpace application started). The string argument is the filename to pull playback keyframes from (the file path is relative to the RECORDINGS variable specified in the config file).
file
String
Return type: void
openspace.sessionRecording.startPlaybackApplicationTime(file)
startPlaybackRecordedTime
Starts a playback session with keyframe times that are relative to the time since the recording was started (the same relative time applies to the playback). The string argument is the filename to pull playback keyframes from (the file path is relative to the RECORDINGS variable specified in the config file). If a second input value of true is given, then playback will continually loop until it is manually stopped.
file
Stringloop
Boolean?- Default value:false
Return type: void
openspace.sessionRecording.startPlaybackRecordedTime(file, loop)
startPlaybackSimulationTime
Starts a playback session with keyframe times that are relative to the simulated date & time. The string argument is the filename to pull playback keyframes from (the file path is relative to the RECORDINGS variable specified in the config file).
file
String
Return type: void
openspace.sessionRecording.startPlaybackSimulationTime(file)
startRecording
Starts a recording session. The string argument is the filename used for the file where the recorded keyframes are saved. The file data format is binary.
recordFilePath
String
Return type: void
openspace.sessionRecording.startRecording(recordFilePath)
startRecordingAscii
Starts a recording session. The string argument is the filename used for the file where the recorded keyframes are saved. The file data format is ASCII.
recordFilePath
String
Return type: void
openspace.sessionRecording.startRecordingAscii(recordFilePath)
stopPlayback
Stops a playback session before playback of all keyframes is complete.
Return type: void
openspace.sessionRecording.stopPlayback()
stopRecording
Stops a recording session.
Return type: void
openspace.sessionRecording.stopRecording()
togglePlaybackPause
Toggles the pause function, i.e. temporarily setting the delta time to 0 and restoring it afterwards.
Return type: void
openspace.sessionRecording.togglePlaybackPause()