API Docs for: 0.5.1
Show:

VideoRecorderObject Class

Defined in: addon/services/video-recorder.js:40
Module: services
Parent Module: 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.

Methods

destroy

()

Defined in addon/services/video-recorder.js:304

Uninstall the video recorder from the page

getTime

() Date | Null

Defined in addon/services/video-recorder.js:232

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

Returns:

Date | Null:

hide

()

Defined in addon/services/video-recorder.js:282

Hide the recorder from display. Useful if you would like to keep recording without extra UI elements to distract the user.

install

(
  • record
)
Promise

Defined in addon/services/video-recorder.js:82

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

Parameters:

Returns:

Promise:

Indicate whether widget was successfully installed and started

pause

(
  • skipIfMissing
)

Defined in addon/services/video-recorder.js:204

Pause the recorder. If optional skipIfMissing argument is provided (and true), don't raise an error if recording isn't ready yet.

Parameters:

record

() Promise

Defined in addon/services/video-recorder.js:170

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

Returns:

Promise:

resume

()

Defined in addon/services/video-recorder.js:219

Resume the recording

show

() Boolean

Defined in addon/services/video-recorder.js:292

Show the recorder to the user. Useful if you want to temporarily show a hidden recorder- eg to let the user fix a problem with video capture settings

Returns:

Boolean:

stop

(
  • destroy
)

Defined in addon/services/video-recorder.js:246

Stop recording and save the video to the server

Parameters: