api.md

CoordinatedCapture

Kind: global class

• CoordinatedCapture
  • new CoordinatedCapture()
  • .sendCommand(command, [parameter])
  • .sendCommandAndWaitForEvent(...var_args) ⇒ Promise
  • .getStatus() ⇒ Promise
  • .start([resolution]) ⇒ Promise
  • .pause() ⇒ Promise
  • .resume() ⇒ Promise
  • .stop() ⇒ Promise
  • .download() ⇒ Promise
  • .on(eventName, handler)
  • .off(eventName, handler)

new CoordinatedCapture()

Creates a new instance.

coordinatedCapture.sendCommand(command, [parameter])

Sends a command to the extension.

Kind: instance method of CoordinatedCapture
Access: protected

Param	Type	Description
command	string
[parameter]	string	a value to pass on

coordinatedCapture.sendCommandAndWaitForEvent(...var_args) ⇒ Promise

Sends a command to the extension and awaits for an event in response.

Kind: instance method of CoordinatedCapture
Access: protected

Param	Type	Description
...var_args	string	a mandatory command name followed by an optional parameter and mandatory event name

coordinatedCapture.getStatus() ⇒ Promise

Gets extension status.

Kind: instance method of CoordinatedCapture

coordinatedCapture.start([resolution]) ⇒ Promise

Starts recording.

Kind: instance method of CoordinatedCapture

Param	Type	Description
[resolution]	string	'WIDTHxHEIGHT'; if not specified, equals to the screen resolution

coordinatedCapture.pause() ⇒ Promise

Pauses recording.

Kind: instance method of CoordinatedCapture

coordinatedCapture.resume() ⇒ Promise

Resumes recording.

Kind: instance method of CoordinatedCapture

coordinatedCapture.stop() ⇒ Promise

Stops recording.

Kind: instance method of CoordinatedCapture

coordinatedCapture.download() ⇒ Promise

Downloads the result.

Kind: instance method of CoordinatedCapture

coordinatedCapture.on(eventName, handler)

Binds a hanler to an event fired by the extension.

Kind: instance method of CoordinatedCapture

Param	Type
eventName	'enabled' | 'disabled' | 'extensionStatus' | 'started' | 'stopped' | 'paused' | 'resumed'
handler	function

coordinatedCapture.off(eventName, handler)

Unbinds a previously bound handler.

Kind: instance method of CoordinatedCapture

Param	Type
eventName	'enabled' | 'disabled' | 'extensionStatus' | 'started' | 'stopped' | 'paused' | 'resumed'
handler	function