Module: Qcmd::Commands::Help

Defined in:

lib/qcmd/commands.rb

Class Method Summary

• .print_all_commands ⇒ Object

Class Method Details

.print_all_commands ⇒ Object

# File 'lib/qcmd/commands.rb', line 151

def print_all_commands
  Qcmd.print %[
#{Qcmd.centered_text(' Available Commands ', '-')}


exit

  Close qcmd.


connect MACHINE_ID

  Connect to the machine with id MACHINE_ID. This can either be the name of the
  machine shown in the listing or its number on the list. Once a machine is
  connected its name will appear above the prompt.


disconnect

  Disconnect from the current machine and workspace.


..

  Disconnect cue if one is connected. If not, disconnect the current workspace.
  If one is not connected, disconnect from the machine.


use WORKSPACE_NAME [PASSCODE]

  Connect to the workspace with name WORKSPACE_NAME given as a double quoted
  string using passcode PASSCODE. A passcode is only required if the workspace
  has one enabled. Once a workspace is connected its name will appear above the
  prompt.


workspaces

  Show a list of the available workspaces for the currently connected machine.


workspace COMMAND [VALUE]

  Pass the given COMMAND to the connected workspace. The following commands will
  act on a workspace:

    #{Qcmd.wrapped_text(Qcmd::Commands::WORKSPACE.sort.join(', '), :indent => '    ').join("\n")}

  * Pro Tip: once you are connected to a workspace, you can just use COMMAND
  and leave off "workspace" to quickly send the given COMMAND to the connected
  workspace.


cue NUMBER COMMAND [VALUE [ANOTHER_VALUE ...]]

  or

cue_id ID COMMAND [VALUE [ANOTHER_VALUE ...]]

  Send a command to the cue with the given NUMBER or ID depending on the way
  you are addressing the cue.

  NUMBER can be a double quoted string or a number, depending on the command.

  COMMAND can be one of:

    #{Qcmd.wrapped_text(Qcmd::Commands::CUE.sort.join(', '), :indent => '    ').join("\n")}

  Specific types of cues may have different cues available. Here's the commands
  available for different types of cues:

  Group Cue:

    #{Qcmd.wrapped_text(Qcmd::Commands::GROUP_CUE.sort.join(', '), :indent => '    ').join("\n")}

  Audio Cue:

    #{Qcmd.wrapped_text(Qcmd::Commands::AUDIO_CUE.sort.join(', '), :indent => '    ').join("\n")}

  Fade Cue:

    #{Qcmd.wrapped_text(Qcmd::Commands::FADE_CUE.sort.join(', '), :indent => '    ').join("\n")}

  Mic Cue:

    #{Qcmd.wrapped_text(Qcmd::Commands::MIC_CUE.sort.join(', '), :indent => '    ').join("\n")}

  Video Cue:

    #{Qcmd.wrapped_text(Qcmd::Commands::VIDEO_CUE.sort.join(', '), :indent => '    ').join("\n")}

  Once a command has been sent to an existing cue, subsequent cue commands will
  be sent to the same cue with needing to repeat the leading "cue NUMBER". Once
  a cue is connected its name will appear above the prompt.


alias COMMAND ACTION

  Create a new command to use in qcmd! COMMAND should be a single word,
  starting with made of one or more letters, numbers, underscores, and/or
  hyphens. ACTION should be a legit qcmd program surrounded by parentheses,
  which is anything you can type into qcmd. If you want your command to accept
  arguments, use $1, $2, ...  $n in place of the argument.

  For example:

    > alias cue-rename (cue $1 name "Hello $2")

  Would create a new command, "cue-rename", that you could use to rename a cue:

    > cue-rename 10 World

  to rename cue number 10 to "Hello World".

  We've included a few custom commands so you can see how it works. Aliases are
  stored in ~/.qcmd/settings.json and can be edited from there.


aliases

  See all the aliases.


sleep NUMBER

  Pause qcmd execution for NUMBER seconds.

  For example:

    > cue 3 start; sleep 2; stop

  Will start cue number 3, then stop it two seconds later.


log-silent, log-noisy

  Turn off output, turn it back on, respectively.


log-debug, log-info

  Set output "level" to debug or info, respectively. Debug will tell you
  everything qcmd is doing, in great detail. It's really just for development
  purposes.


--, ++, //, **

  These are modifiers can be used with a number on cue specific commands to
  drop, raise, divide, or multiply the given value by the given amount,
  respectively. For example, instead of using:

    cue 1 sliderLevel 1 0

  to set the value of volume slider 1 on cue 1 to 0 absolute, you can use:

    cue 1 sliderLevel 1 ++0.2

  to raise the current value of slider 1 on cue 1 by 0.2. To lower it by 0.2
  you'd use "--0.2". The same for ** and //.

  This is handy if you know you want to adjust the value of the cue setting by
  a small amount but you don't know what the value is at the moment.


]
end