mcopy/app/lib/cmd

lib/cmd

• lib/cmd
  • [~Assign all connected devices and mock devices as private classes.](#module_lib/cmd..Assign all connected devices and mock devices as private classes.)
    • [new Assign all connected devices and mock devices as private classes.(cfg, proj, cam, light, alert, cam2, proj2, capper)](#new_module_lib/cmd..Assign all connected devices and mock devices as private classes._new)
  • ~Commands
    • .projector_forward() ⇒ integer
    • .projector_backward() ⇒ integer
    • .camera_forward(cmd) ⇒ integer
    • .black_forward() ⇒ integer
    • .camera_backward(cmd) ⇒ integer
    • .black_backward() ⇒ integer
    • .camera_second_forward(cmd) ⇒ integer
    • .camera_second_backward(cmd) ⇒ integer
    • .cameras_forward(cmd) ⇒ integer
    • .cameras_backward(cmd) ⇒ integer
    • .camera_forward_camera_second_backward(cmd) ⇒ integer
    • .camera_backward_camera_second_forward(cmd) ⇒ integer
    • .projector_second_forward() ⇒ integer
    • .projector_second_backward() ⇒ integer
    • .projectors_forward() ⇒ integer
    • .projectors_backward() ⇒ integer
    • .projector_forward_projector_second_backward() ⇒ integer
    • .projector_backward_projector_second_forward() ⇒ integer
    • .alert() ⇒ integer
    • .pause() ⇒ integer
    • .camera_exposure()

lib/cmd~Assign all connected devices and mock devices as private classes.

Kind: inner class of lib/cmd

new Assign all connected devices and mock devices as private classes.(cfg, proj, cam, light, alert, cam2, proj2, capper)

Param	Type	Description
cfg	object	Configuration object
proj	object	Projector 1
cam	object	Camera 1
light	object	Light source
alert	object	Alert object
cam2	object	(optional) Camera 2
proj2	object	(optional) Projector 2
capper	object	Capper object

lib/cmd~Commands

Class representing all commands bundled into methods.

Kind: inner class of lib/cmd

• ~Commands
  • .projector_forward() ⇒ integer
  • .projector_backward() ⇒ integer
  • .camera_forward(cmd) ⇒ integer
  • .black_forward() ⇒ integer
  • .camera_backward(cmd) ⇒ integer
  • .black_backward() ⇒ integer
  • .camera_second_forward(cmd) ⇒ integer
  • .camera_second_backward(cmd) ⇒ integer
  • .cameras_forward(cmd) ⇒ integer
  • .cameras_backward(cmd) ⇒ integer
  • .camera_forward_camera_second_backward(cmd) ⇒ integer
  • .camera_backward_camera_second_forward(cmd) ⇒ integer
  • .projector_second_forward() ⇒ integer
  • .projector_second_backward() ⇒ integer
  • .projectors_forward() ⇒ integer
  • .projectors_backward() ⇒ integer
  • .projector_forward_projector_second_backward() ⇒ integer
  • .projector_backward_projector_second_forward() ⇒ integer
  • .alert() ⇒ integer
  • .pause() ⇒ integer
  • .camera_exposure()

commands.projector_forward() ⇒ integer

Move the projector one frame forward

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.projector_backward() ⇒ integer

Move the projector one frame backward

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.camera_forward(cmd) ⇒ integer

Move the camera one frame forward

Kind: instance method of Commands
Returns: integer - Length of action in ms

Param	Type	Description
cmd	object	Full cmd object

commands.black_forward() ⇒ integer

Move the camera one frame forward with light off

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.camera_backward(cmd) ⇒ integer

Move the camera one frame backward

Kind: instance method of Commands
Returns: integer - Length of action in ms

Param	Type	Description
cmd	object	Full cmd object

commands.black_backward() ⇒ integer

Move the camera one frame forward, light set to black or off

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.camera_second_forward(cmd) ⇒ integer

Move the second camera one frame forward

Kind: instance method of Commands
Returns: integer - Length of action in ms

Param	Type	Description
cmd	object	Full cmd object

commands.camera_second_backward(cmd) ⇒ integer

Move the second camera one frame backward

Kind: instance method of Commands
Returns: integer - Length of action in ms

Param	Type	Description
cmd	object	Full cmd object

commands.cameras_forward(cmd) ⇒ integer

Move the both cameras one frame forward

Kind: instance method of Commands
Returns: integer - Length of action in ms

Param	Type	Description
cmd	object	Full cmd object

commands.cameras_backward(cmd) ⇒ integer

Move the both cameras one frame backward

Kind: instance method of Commands
Returns: integer - Length of action in ms

Param	Type	Description
cmd	object	Full cmd object

commands.camera_forward_camera_second_backward(cmd) ⇒ integer

Move first camera one frame forward and rewind secondary camera one frame backward

Kind: instance method of Commands
Returns: integer - Length of action in ms

Param	Type	Description
cmd	object	Full cmd object

commands.camera_backward_camera_second_forward(cmd) ⇒ integer

Rewind first camera one frame backward and move secondary camera one frame forward

Kind: instance method of Commands
Returns: integer - Length of action in ms

Param	Type	Description
cmd	object	Full cmd object

commands.projector_second_forward() ⇒ integer

Move the secondary projector forward one frame

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.projector_second_backward() ⇒ integer

Rewind the secondary projector backward one frame

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.projectors_forward() ⇒ integer

Move the both projectors forward one frame

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.projectors_backward() ⇒ integer

Rewind both projectors backwards one frame

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.projector_forward_projector_second_backward() ⇒ integer

Move the primary projector forward one frame and rewind the secondary projector one frame backwards.

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.projector_backward_projector_second_forward() ⇒ integer

Rewind the primary projector backwards one frame and move the secondary projector forward one frame.

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.alert() ⇒ integer

Throws an alert to pause a sequence

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.pause() ⇒ integer

Pauses a sequence for a length of time

Kind: instance method of Commands
Returns: integer - Length of action in ms

commands.camera_exposure()

Sets the camera exposure (if supported).

Kind: instance method of Commands