Class VideoRecorder
Hierarchy
- VideoRecorder
Index
Constructors
Accessors
Methods
Constructors
constructor
-
Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
Parameters
-
engine: Engine
Defines the BabylonJS Engine you wish to record.
-
Optional options: Partial<VideoRecorderOptions>
Defines options that can be used to customize the capture.
Returns VideoRecorder
-
Accessors
is
-
True when a recording is already in progress.
Returns boolean
Methods
disposeSearch playground for dispose
-
Releases internal resources used during the recording.
Returns void
start
-
Starts recording the canvas for a max duration specified in parameters.
Parameters
-
Optional fileName: Nullable<string>
Defines the name of the file to be downloaded when the recording stop. If null no automatic download will start and you can rely on the promise to get the data back.
-
Optional maxDuration: number
Defines the maximum recording time in seconds. It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
Returns Promise<Blob>
A promise callback at the end of the recording with the video data in Blob.
-
stop
-
Stops the current recording before the default capture timeout passed in the startRecording function.
Returns void
Static Is
-
Returns whether or not the VideoRecorder is available in your browser.
Parameters
-
engine: Engine
Defines the Babylon Engine.
Returns boolean
true if supported otherwise false.
-
This can help with recording videos from BabylonJS. This is based on the available WebRTC functionalities of the browser.
https://doc.babylonjs.com/how_to/render_scene_on_a_video