Changes

CLI

1,710 bytes added, 24 May

Created page with "Use command line arguments interact with Screenbits through command line interface (CLI). == Commands == Screenbits supports the following commands: {|class="wikitable" ! st..."

Use command line arguments interact with Screenbits through command line interface (CLI).

== Commands ==
Screenbits supports the following commands:

{|class="wikitable"
! style="text-align:left;"| Command
! Description
|-
|start
|Starts recording
|-
|stop
|Stops recording
|-
|pause
|Pauses recording
|-
|resume
|Resumes recording
|}

== Arguments ==
The following arguments can be used along with commands:

{|class="wikitable"
! style="text-align:left;"| Argument
! Description
|-
|background
|Keep the app in the background while executing the command.
|}

== Usage (Packaged) ==
Use protocol activation to activate '''screenbits''' protocol to run a command for a packaged installation of Screenbits in the following form:

<code>
start screenbits://[command]/?arg[=value]
</code>


The following example starts recording without bringing the app to foreground:

<code>
start screenbits://record/?background
</code>


You can also use '''explorer''' program instead of '''start''' command to activate a protocol if you need to specify an executable file to launch the command. This is useful for creating tasks in scheduler programs such as [https://en.wikipedia.org/wiki/Windows_Task_Scheduler Windows Task Scheduler]:

<code>
explorer screenbits://record/?background
</code>

== Usage (Non-Packaged) ==
To run a command for a non-packaged installation of Screenbits, simply pass the command and arguments to the application executable:

<code>
[path-to-executable]screenbits.exe [command -[arg[=value]]]
</code>


The following example starts recording without bringing the app to foreground:

<code>
"C:\Program Files (x86)\Steam\steamapps\common\Screenbits\screenbits.exe" record -background
</code>

• Newer edit →

Mchehraz

Bureaucrat, administrator

1,133

edits