Commands¶
Commands can be used in:
- Main Menu
- Event Command
- Command Line Interface
Event Command¶
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
Available Commands¶
-
AddBatchJob
¶
Adds a batch job.
sourcefile <string> |
-
AddFilter
¶
Adds a filter at the end of the script.
active <boolean> |
name <string> |
category <string> |
script <string> |
-
AddJob
¶
Adds a job to the job list.
showConfirmation <boolean> | Show Confirmation |
templateName <string> | Template Name: Name of the template to be loaded after the job was added. Empty to load no template. |
position <integer> | Position to insert new job |
Adds tags to the container (works only with mkvmerge).
tags <string> | name 1 = value 1; name 2 = value 2; etc. |
-
CheckForUpdate
¶
Checks if a update is available.
-
ClearJobs
¶
Clears the job list.
-
CopyToClipboard
¶
Copies a string to the clipboard.
value <string> | Copies text to the clipboard. May contain macros. |
-
DeleteFiles
¶
Deletes files in a given directory.
dir <string> | Directory: Directory in which to delete files. |
filter <string> | Example: ‘.txt .log’ |
Placeholder for dynamically updated menu items.
id <dynamicmenuitemid> | Audio1Profiles, Audio2Profiles, EncoderProfiles, FilterSetupProfiles, MuxerProfiles, RecentProjects, TemplateProjects, HelpApplications, Scripts, AddFilters, InsertFilters, ReplaceFilters, FilterCategory |
-
ExecuteCommandLine
¶
Executes a command line. If Shell Execute is disabled then macros are passed in as environment variables.
commandLine <string> | Command Line: The command line to be executed. Macros are solved. |
waitForExit <boolean> | Wait For Exit: Halt until the command line returns. |
showProcessWindow <boolean> | Show Process Window: Redirects the output of console apps to StaxRips process window. Disables Shell Execute. |
useShellExecute <boolean> | Use Shell Execute: Executes the command line using the shell. Available when the Show Process Window option is disabled. |
workingDirectory <string> | Working Directory: Working directory the process will use. |
-
ExecutePowerShellScript
¶
Executes PowerShell script code.
code <string> | Script Code: PowerShell script code to be executed. Macros are expanded. |
externalShell <boolean> | Use External Shell: Execute in StaxRip to automate StaxRip or use external shell. |
-
ExecuteScriptFile
¶
Executes a PowerShell PS1 script file.
filepath <string> | File Path: Filepath to a PowerShell PS1 script file. May contain macros. |
-
Exit
¶
Exits StaxRip
-
GenerateWikiPages
¶
Generates various wiki pages.
-
ImportVideoEncoderCommandLine
¶
Changes video encoder settings.
commandLine <string> | Command Line |
-
LoadProfile
¶
Loads a audio or video profile.
videoProfile <string> | Video |
audioProfile1 <string> | Audio 1 |
audioProfile2 <string> | Audio 2 |
-
LoadSourceFile
¶
Loads a source file.
path <string> | Source File Path |
-
LoadTemplate
¶
Loads a template.
name <string> |
-
OpenHelpTopic
¶
Opens a given help topic In the help browser.
topic <string> | Help Topic: Name Of the help topic To be opened. |
-
PlaySound
¶
Plays audio file.
FilePath <string> | Filepath to a mp3, wav or wmv sound file. |
Volume <integer> | Volume (%) |
-
ResetSettings
¶
Shows a dialog allowing to reset specific settings.
-
SaveGIF
¶
Shows a Open File dialog to generate a short GIF.
-
SaveMKVHDR
¶
Shows a Open File dialog to add the remaining HDR10 Metadata to a MKV file.
-
SaveMTN
¶
Shows a Open File dialog to generate thumbnails using mtn engine
-
SavePNG
¶
Shows a open file dialog to create a high quality PNG animation.
-
SaveProject
¶
Saves the current project.
-
SaveProjectAs
¶
Saves the current project.
-
SaveProjectAsTemplate
¶
Saves the current project as template.
-
SaveProjectPath
¶
Saves the current project at the specified path.
path <string> | The path may contain macros. |
-
SetBitrate
¶
Sets the target video bitrate in Kbps.
bitrate <integer> | Target Video Bitrate |
-
SetFilter
¶
Sets a filter replacing a existing filter of same category.
name <string> |
category <string> |
script <string> |
-
SetHideDialogsOption
¶
Sets the project option ‘Hide dialogs asking to demux, source filter etc.’
hide <boolean> |
-
SetPercent
¶
Sets the bitrate according to the compressibility.
value <integer> | Percent Value |
-
SetSize
¶
Sets the target file size in MB.
targetSize <integer> | Target File Size |
-
SetTargetFile
¶
Sets the file path of the target file.
path <string> | Target File Path |
-
SetTargetImageSize
¶
Sets the target image size.
width <integer> |
height <integer> |
-
SetTargetImageSizeByPixel
¶
Sets the target image size by pixels (width x height).
pixel <integer> |
-
ShowAppsDialog
¶
Dialog to manage external tools.
-
ShowAudioProfilesDialog
¶
Dialog to manage audio profiles.
number <integer> | Track Number (0 or 1) |
-
ShowBatchGenerateThumbnailsDialog
¶
Shows a dialog to generate thumbnails.
-
ShowCodePreview
¶
Dialog to preview script code.
-
ShowCropDialog
¶
Shows the crop dialog to crop borders.
-
ShowDemuxTool
¶
Allows to use StaxRip’s demuxing GUIs independently.
-
ShowEncoderProfilesDialog
¶
Shows a dialog to manage video encoder profiles.
-
ShowEventCommandsDialog
¶
Shows the Event Command dialog.
-
ShowFileBrowserToOpenProject
¶
Shows a file browser to open a project file.
-
ShowFilterProfilesDialog
¶
Dialog to configure filter profiles.
-
ShowFiltersEditor
¶
Dialog to edit filters.
-
ShowFilterSetupProfilesDialog
¶
Dialog to configure filter setup profiles.
-
ShowHardcodedSubtitleDialog
¶
Shows a dialog to add a hardcoded subtitle.
-
ShowJobsDialog
¶
Dialog to manage batch jobs.
-
ShowLogFile
¶
Shows the log file with the built-in log file viewer.
-
ShowMacrosDialog
¶
Dialog that shows available macros.
Dialog to configure the main menu.
-
ShowMediaInfo
¶
Shows media info on a given file.
filepath <string> | May contain macros. |
-
ShowMediaInfoBrowse
¶
Shows a Open File dialog to show media info.
-
ShowMediaInfoFolderViewDialog
¶
Presents MediaInfo of all files in a folder in a grid view.
-
ShowMessageBox
¶
Shows a message box.
mainInstruction <string> | Main Instruction: Main instruction may contain macros. |
content <string> | May contain macros. |
icon <msgicon> | None, Error, Question, Warning, Info |
-
ShowMkvInfo
¶
Shows a Open File dialog to open a file to be shown by the console tool mkvinfo.
-
ShowMuxerProfilesDialog
¶
Dialog to manage Muxer profiles.
-
ShowOpenSourceBatchFilesDialog
¶
Dialog to open a file batch source.
-
ShowOpenSourceBlurayFolderDialog
¶
Dialog to open a Blu-ray folder source.
-
ShowOpenSourceDialog
¶
Dialog to open source files.
-
ShowOpenSourceMergeFilesDialog
¶
Dialog to open a merged files source.
-
ShowOpenSourceSingleFileDialog
¶
Dialog to open a single file source.
-
ShowOptionsDialog
¶
Dialog to configure project options.
-
ShowPreview
¶
Dialog to preview or cut the video.
-
ShowScriptInfo
¶
Shows script info using various console tools.
-
ShowSettingsDialog
¶
Shows the settings dialog.
Menu editor for the size menu.
-
ShowVideoComparison
¶
Shows a dialog to compare different videos.
-
Shutdown
¶
Shut down PC.
-
Standby
¶
Standby PC.
-
StartAutoCrop
¶
Crops borders automatically.
-
StartCompCheck
¶
Starts the compressibility check.
-
StartEncoding
¶
Creates a job and runs the job list.
-
StartJobs
¶
Runs all active jobs of the job list.
-
StartSmartCrop
¶
Crops borders automatically until the proper aspect ratio is found.
-
StartTool
¶
Starts a tool by name as shown in the app manage dialog.
name <string> | Tool Name: Tool name as shown in the app manage dialog. |
-
TestAndDynamicFileCreation
¶
Development tests and creation of doc files.
-
WriteLog
¶
Writes a log message to the log file.
header <string> | Header is optional and may contain macros. |
message <string> | Message is optional and may contain macros. |