Show:

video-recorder Class

Defined in: app/services/video-recorder.js:76
Collection: exp-player

An instance of a video recorder tied to or used by one specific page. A given experiment may use more than one video recorder depending on the number of video capture frames.

Item Index

Methods

Methods

destroy

()

Defined in app/services/video-recorder.js:303

Destroy video recorder

getTime

() Date | Null

Defined in app/services/video-recorder.js:253

Get a timestamp based on the current recording position. Useful to ensure that tracked timing events line up with the video.

Returns:

Date | Null:

install

(
  • videoFilename
  • pipeKey
  • pipeEnv
  • maxRecordingTime
  • autosave
  • audioOnly
)
Promise

Defined in app/services/video-recorder.js:135

Install a recorder onto the page and optionally begin recording immediately.

Parameters:

  • videoFilename Object

    desired filename for video (will be set after saving with Pipe name) ['']

  • pipeKey Object

    Pipe account hash ['']

  • pipeEnv Object

    which Pipe environment [1]

  • maxRecordingTime Object

    recording length limit in s [100000000]

  • autosave Object

    whether to autosave - 1 or 0 [1]

  • audioOnly Object

    whether to do audio only recording - 1 or 0 [0]

Returns:

Promise:

Resolves when widget successfully installed and started

record

() Promise

Defined in app/services/video-recorder.js:213

Start recording a video, and allow the state of the recording to be accessed for later usage

Returns:

Promise:

stop

()

Defined in app/services/video-recorder.js:267

Stop recording and save the video to the server