openspace.sessionRecording

Functions overview

Name

Documentation

isPlayingBack

Returns true if session recording is currently playing back a recording

isRecording

Returns true if session recording is currently recording a recording

setPlaybackPause

Pauses or resumes the playback progression through keyframes

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)

startRecording

Starts a recording session

stopPlayback

Stops a playback session before playback of all keyframes is complete

stopRecording

Stops a recording session

togglePlaybackPause

Toggles the pause function, i

Functions

isPlayingBack

Returns true if session recording is currently playing back a recording.

Return type: Boolean

Signature
openspace.sessionRecording.isPlayingBack()

isRecording

Returns true if session recording is currently recording a recording.

Return type: Boolean

Signature
openspace.sessionRecording.isRecording()

setPlaybackPause

Pauses or resumes the playback progression through keyframes.

Parameters

  • pause Boolean

Return type: void

Signature
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.

Parameters

  • file String

  • loop Boolean? - Default value: false

  • shouldWaitForTiles Boolean? - Default value: true

  • screenshotFps Integer?? - Default value: std::nullopt

Return type: void

Signature
openspace.sessionRecording.startPlayback(file, loop, shouldWaitForTiles, screenshotFps)

startRecording

Starts a recording session. The string argument is the filename used for the file where the recorded keyframes are saved.

Return type: void

Signature
openspace.sessionRecording.startRecording()

stopPlayback

Stops a playback session before playback of all keyframes is complete.

Return type: void

Signature
openspace.sessionRecording.stopPlayback()

stopRecording

Stops a recording session. dataMode has to be “Ascii” or “Binary”. If overwrite is true, any existing session recording file will be overwritten, false by default.

Parameters

  • recordFilePath Path

  • dataMode String

  • overwrite Boolean?

Return type: void

Signature
openspace.sessionRecording.stopRecording(recordFilePath, dataMode, overwrite)

togglePlaybackPause

Toggles the pause function, i.e. temporarily setting the delta time to 0 and restoring it afterwards.

Return type: void

Signature
openspace.sessionRecording.togglePlaybackPause()