Difference between revisions of "CLI"

From User Manual :: Screenbits
Jump to: navigation, search
(Usage (Non-Packaged))
(Usage (Packaged))
 
(6 intermediate revisions by the same user not shown)
Line 5: Line 5:
  
 
{|class="wikitable"
 
{|class="wikitable"
! style="text-align:left;"| Command
+
! style="text-align:left;| Command
! Description
+
! style="text-align:left; width:280px"| Description
 
|-
 
|-
 
|start
 
|start
Line 33: Line 33:
  
 
== Usage (Packaged) ==
 
== Usage (Packaged) ==
Use protocol activation to activate '''screenbits''' protocol to run a command for a packaged installation of Screenbits in the following form:
+
Use protocol activation to activate '''screenbits''' protocol to run a command for a packaged installation (through ''Microsoft Store'') of Screenbits in the following form:
  
 
<code>
 
<code>
Line 42: Line 42:
  
 
<code>
 
<code>
start screenbits://record/?background
+
start screenbits://start/?background
 
</code>
 
</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]:
+
You can also use '''explorer''' program instead of '''start''' command to activate a protocol if you need to specify an executable file to run 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>
 
<code>
explorer screenbits://record/?background
+
explorer screenbits://start/?background
 
</code>
 
</code>
  
 
== Usage (Non-Packaged) ==
 
== Usage (Non-Packaged) ==
To run a command for a non-packaged installation of Screenbits, simply pass the command and arguments to the application executable:
+
To run a command for a non-packaged installation (through ''Steam'') of Screenbits, simply pass the command and arguments to the application executable:
  
 
<code>
 
<code>
[path-to-executable]screenbits.exe [command -[arg[=value]]]
+
[path-to-executable]screenbits.exe command [-arg[=value]]
 
</code>
 
</code>
  
Line 61: Line 61:
  
 
<code>
 
<code>
"C:\Program Files (x86)\Steam\steamapps\common\Screenbits\screenbits.exe" record -background
+
"C:\Program Files (x86)\Steam\steamapps\common\Screenbits\screenbits.exe" start -background
 
</code>
 
</code>

Latest revision as of 11:47, 25 May 2024

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

Commands

Screenbits supports the following commands:

Command Description
start Starts recording
stop Stops recording
pause Pauses recording
resume Resumes recording

Arguments

The following arguments can be used along with commands:

Argument Description
background Command is executed without bringing the app to foreground.

Usage (Packaged)

Use protocol activation to activate screenbits protocol to run a command for a packaged installation (through Microsoft Store) of Screenbits in the following form:

start screenbits://[command]/?arg[=value]

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

start screenbits://start/?background

You can also use explorer program instead of start command to activate a protocol if you need to specify an executable file to run the command. This is useful for creating tasks in scheduler programs such as Windows Task Scheduler:

explorer screenbits://start/?background

Usage (Non-Packaged)

To run a command for a non-packaged installation (through Steam) of Screenbits, simply pass the command and arguments to the application executable:

[path-to-executable]screenbits.exe command [-arg[=value]]

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

"C:\Program Files (x86)\Steam\steamapps\common\Screenbits\screenbits.exe" start -background