openshot-render

openshot-render --project <project_file> --output <output_file> [options]

--project <project_file>
    The path to the OpenShot project file (.osp) to be rendered.

--output <output_file>
    The path and filename for the rendered video output. Specify file extension to define container format (e.g., .mp4, .webm, .avi).

--width <pixels>
    The width of the output video in pixels.

--height <pixels>
    The height of the output video in pixels.

--frame-rate <fps>
    The frame rate of the output video in frames per second (fps).

--video-codec <codec>
    The video codec to use for encoding the video stream (e.g., libx264, libvpx-vp9, libtheora).

--audio-codec <codec>
    The audio codec to use for encoding the audio stream (e.g., aac, libmp3lame, libvorbis).

--channels <channels>
    The number of audio channels to use (e.g. 1 = mono, 2 = stereo).

--sample-rate <hz>
    The audio sample rate in Hz.

--video-bitrate <kbps>
    The video bitrate in kilobits per second (kbps).

--audio-bitrate <kbps>
    The audio bitrate in kilobits per second (kbps).

--start-frame <frame_number>
    The starting frame number to render from.

--end-frame <frame_number>
    The ending frame number to render to.

--zoom <num>
    Zoom value for the video. Values between 0 and 1 can be used to crop the video (e.g.: 0.5 will crop each side to 50% of it's size).

--threads <num>
    Maximum number of threads to use when rendering.

--profile <profile>
    Video profile preset (e.g. HD 720p 30 fps).

--format <format>
    Render format to be used. Can be "mp4", "webm", "mkv" etc.

--progress
    Displays rendering progress with percentages.

--help
    Displays a list of all available command-line options.

The `openshot-render` command is a command-line tool used to render video projects created in the OpenShot Video Editor. It allows users to automate the video rendering process, making it suitable for batch processing, scripting, and server-side video generation.

This tool bypasses the graphical user interface of OpenShot, directly utilizing the underlying rendering engine. This can be more efficient and allows for headless operation, ideal for environments without a display. Users can specify the OpenShot project file (.osp), the desired output file name, video and audio settings, and various rendering options to achieve the desired video output.

The command provides flexibility in controlling various aspects of the rendering process, such as resolution, frame rate, codec, and quality. This allows for fine-tuning the output video to meet specific requirements or platform constraints. Its CLI nature makes it easy to use in automations.

The `openshot-render` command relies on the availability of the necessary codecs and libraries installed on the system. Inconsistent results might appear if your source media do not have proper audio or video codecs to handle them. Check the terminal for errors if the render fails.

Pay close attention to error messages output by `openshot-render`. These messages can provide valuable clues for troubleshooting rendering issues, such as missing codecs, invalid file paths, or project file corruption.

Using a suitable profile can reduce the effort in selecting all other parameters.
Use command line to list avaiable video profiles and their settings.

If you encounter audio/video synchronization issues in the rendered output, try adjusting the video and audio bitrate settings. Sometimes, high bitrates can cause synchronization problems.

The `openshot-render` command was developed as part of the OpenShot Video Editor project, to enable batch processing and scripting of video rendering tasks. It has evolved alongside the OpenShot GUI application, providing a command-line interface for its core rendering functionalities. It improves the user experience for automating video creation processes.