Commands - staxrip/staxrip GitHub Wiki
Tip: This is a extremely long page, use Find (Ctrl+F) to find what you are looking for.
Commands can be used in:
The main menu can be customized at:
Main Menu > Tools > Edit Menu
The Event Command feature allows to define a command to be executed on a defined event under defined conditions.
Find it at:
Main Menu > Tools > Advanced > Event Command
Adds a batch job for a single file.
| Parameter |
|---|
| sourcefile <string> |
Adds batch jobs for multiple files.
| Parameter |
|---|
| sourcefiles <string[]> |
Adds a filter at the end of the script.
| Parameter |
|---|
| active <boolean> |
| name <string> |
| category <string> |
| script <string> |
Adds a job to the job list.
| Parameter | Description |
|---|---|
| Show Confirmation <boolean> | |
| Template Name <string> | Name of the template to be loaded after the job was added. Empty to load no template. |
| Position to insert new job <integer> |
Adds tags to the container (works only with mkvmerge).
| Parameter | Description |
|---|---|
| Tags <string> | name 1 = value 1; name 2 = value 2; etc. |
Checks if an update is available.
Clears the job list.
Closes the current project.
Copies a string to the clipboard.
| Parameter | Description |
|---|---|
| Value <string> | Copies text to the clipboard. May contain macros. |
Deletes files in a given directory.
| Parameter | Description |
|---|---|
| Directory <string> | Directory in which to delete files. |
| Filter <string> | Example: '.txt .log' |
Placeholder for dynamically updated menu items.
| Parameter | Description |
|---|---|
| ID <dynamicmenuitemid> | Audio1Profiles, Audio2Profiles, EncoderProfiles, FilterSetupProfiles, MuxerProfiles, RecentProjects, TemplateProjects, HelpApplications, Scripts, AddFilters, InsertFilters, ReplaceFilters, FilterCategory |
Executes a command line. If Shell Execute is disabled then macros are passed in as environment variables.
| Parameter | Description |
|---|---|
| Command Line <string> | The command line to be executed. Macros are solved. |
| Wait For Exit <boolean> | Halt until the command line returns. |
| Show Process Window <boolean> | Redirects the output of console apps to StaxRips process window. Disables Shell Execute. |
| Use Shell Execute <boolean> | Executes the command line using the shell. Available when the Show Process Window option is disabled. |
| Working Directory <string> | Working directory the process will use. |
Executes PowerShell code.
| Parameter | Description |
|---|---|
| Script Code <string> | PowerShell script code to be executed. Macros are expanded. |
| Use External Shell <boolean> | Execute in StaxRip to automate StaxRip or use external shell. |
Executes a PowerShell script file.
| Parameter | Description |
|---|---|
| File Path <string> | Filepath to a PowerShell script file. May contain macros. |
| Arguments <string> | Semicolon separated arguments passed to the script host. May contain macros. |
Exits StaxRip
Exits StaxRip without saving an unsaved project.
Extract dynamic HDR metadata from a source file.
| Parameter |
|---|
| sourcePath <string> |
Generates various wiki content.
Changes video encoder settings.
| Parameter |
|---|
| Command Line <string> |
Loads an audio or video profile.
| Parameter |
|---|
| Video <string> |
| Audio 1 <string> |
| Audio 2 <string> |
Loads a source file.
| Parameter |
|---|
| Source File Path <string> |
Loads multiple source files.
| Parameter |
|---|
| Source File Paths <string> |
Loads a template.
| Parameter |
|---|
| name <string> |
Opens a given help topic in the help browser.
| Parameter | Description |
|---|---|
| Help Topic <string> | Name of the help topic to be opened. |
Plays audio file.
| Parameter | Description |
|---|---|
| FilePath <string> | Filepath to a mp3, wav or wmv sound file. |
| Volume (%) <integer> |
Shows a dialog allowing to reset specific settings.
Shows an Open File dialog to generate a short GIF.
Shows an Open File dialog to add the remaining HDR10 Metadata to a MKV file.
Shows an Open File dialog to create a high quality PNG animation.
Saves the current project.
Saves the current project.
Saves the current project as template.
Saves the current project at the specified path.
| Parameter | Description |
|---|---|
| path <string> | The path may contain macros. |
Sets the target video bitrate in Kbps.
| Parameter |
|---|
| Target Video Bitrate <integer> |
Sets crop values
| Parameter | Description |
|---|---|
| Left Crop <integer> | Sets the left crop value. |
| Top Crop <integer> | Sets the top crop value. |
| Right Crop <integer> | Sets the right crop value. |
| Bottom Crop <integer> | Sets the bottom crop value. |
Sets a filter replacing an existing filter of same category.
| Parameter |
|---|
| name <string> |
| category <string> |
| script <string> |
Sets the project option 'Hide dialogs asking to demux, source filter etc.'
| Parameter |
|---|
| hide <boolean> |
Sets the bitrate according to the compressibility.
| Parameter |
|---|
| Percent Value <integer> |
Sets the target file size in MB.
| Parameter |
|---|
| Target File Size <integer> |
Sets the file path of the target file.
| Parameter |
|---|
| Target File Path <string> |
Sets the target image size.
| Parameter |
|---|
| width <integer> |
| height <integer> |
Sets the target image size by pixels (width x height).
| Parameter |
|---|
| pixel <integer> |
Shows advanced AviSynth/VapourSynth output script info using various tools.
Dialog to manage external tools.
Dialog to manage audio profiles.
| Parameter |
|---|
| Track Number (0 or 1) <integer> |
Dialog to preview script code.
Shows the crop dialog to crop borders.
Allows to use StaxRip's demuxing GUIs independently.
Shows a dialog to manage video encoder profiles.
Shows the Event Command dialog.
Shows a file browser to open a project file.
Dialog to configure filter profiles.
Dialog to edit filters.
Dialog to configure filter setup profiles.
Shows a dialog to add a hardcoded subtitle.
Dialog to manage batch jobs.
Shows the log file with the built-in log file viewer.
Dialog that shows available macros.
Dialog to configure the main menu.
Shows media info on a given file.
| Parameter | Description |
|---|---|
| Filepath <string> | May contain macros. |
Shows an Open File dialog to show media info.
Presents MediaInfo of all files in a folder in a grid view.
Shows a message box.
| Parameter | Description |
|---|---|
| Main Instruction <string> | Main instruction may contain macros. |
| Content <string> | May contain macros. |
| Icon <taskicon> | None, Info, Warning, Question, Error, Shield |
Shows an Open File dialog to open a file to be shown by the console tool mkvinfo.
Dialog to manage Muxer profiles.
Dialog to open a file batch source.
Dialog to open a Blu-ray folder source.
Dialog to open source files.
Dialog to open a merged files source.
Dialog to open multiple file sources.
Dialog to open a single file source.
Dialog to configure project options.
Window to preview or cut the video.
Dialog to preview or cut the video.
Shows a message about removed functionality.
Shows info about the output AviSynth/VapourSynth script.
Shows the settings dialog.
Menu editor for the size menu.
Shows a dialog to select files, for those thumbnail sheets are created.
Shows a dialog to compare different videos.
Shut down PC.
Standby PC.
Crops borders automatically.
Starts the compressibility check.
Creates a job and runs the job list.
Runs all active jobs of the job list.
Crops borders automatically until the proper aspect ratio is found.
Starts a tool by name as shown in the app manage dialog.
| Parameter | Description |
|---|---|
| Tool Name <string> | Tool name as shown in the app manage dialog. |
Development tests.
Writes a log message to the log file.
| Parameter | Description |
|---|---|
| Header <string> | Header is optional and may contain macros. |
| Message <string> | Message is optional and may contain macros. |