VideoRecorder

This can helps recording videos from BabylonJS. This is based on the available WebRTC functionalities of the browser.

see

http://doc.babylonjs.com/how_to/render_scene_on_a_video

Hierarchy

  • VideoRecorder

Index

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: Nullable<VideoRecorderOptions>

      Defines options that can be used to customized the capture

    Returns VideoRecorder

Properties

isRecording

isRecording: boolean

True wether a recording is already in progress.

Methods

dispose

  • dispose(): void
  • Releases internal resources used during the recording.

    Returns void

startRecording

  • startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>
  • 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 default 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.

stopRecording

  • stopRecording(): void
  • Stops the current recording before the default capture timeout passed in the startRecording functions.

    Returns void

Static IsSupported

  • IsSupported(engine: Engine): boolean
  • Returns wehther or not the VideoRecorder is available in your browser.

    Parameters

    • engine: Engine

      Defines the Babylon Engine to check the support for

    Returns boolean

    true if supported otherwise false

Generated using TypeDoc