Record Video

This function block saves incoming frames into a video file. It supports multiple trigger modes (keyboard or signal), selectable output quality, and automatic file naming to avoid overwriting existing recordings. Use this block when you want to capture and store a sequence of images as a video.

📥 Inputs

• Frame — Image frames to be recorded into the video.

• Record — Boolean signal to control recording (behaviour depends on selected trigger mode).

• Folder Path — Destination folder where the video file will be saved.

• File Name (no extension) — Optional file name; if left empty a timestamp-based name will be created.

📤 Outputs

• This function block does not provide outputs.

🕹️ Controls

• Video Quality — Choose output quality. Options typically include Compressed and High Quality.

• Trigger Mode — Choose how recording is started/stopped. Options typically include Spacebar, Continuous, and Once.

• Recording — LED-style indicator showing whether a recording is currently active.

Note: In Spacebar trigger mode press the actual Spacebar to start/stop recording. In Continuous and Once modes the behaviour follows the boolean Record input.

🎨 Features

• Automatic unique filename creation when a name already exists in the selected folder.

• Two quality modes that save in different container/codec formats (common compressed and high-quality options).

• Visual LED indicator for recording state.

• Supports starting/stopping via keyboard or boolean signals so it fits both manual and automated workflows.

• Converts single-channel frames to color before writing when needed (ensures consistent video format).

⚙️ Running mechanism

• Choose a Trigger Mode:

  • Spacebar — press Spacebar to toggle start/stop.

  • Continuous — providing TRUE starts recording; providing FALSE stops and finalizes the file.

  • Once — toggling the Record input triggers a single start/stop action.

• When recording starts the block creates a new file in the selected folder using the chosen quality. If a file with the requested name already exists the block appends a unique suffix.

• While active the block writes each received Frame into the file. When stopping, the file is finalized and closed.

• The saved file may not be viewable while recording; wait until recording finishes to open the file.

📝 Usage instructions

1. Provide a source of frames to Frame (for example from Camera USB, Camera IP (ONVIF), Stream Reader, or Video).

2. Select a destination folder via Folder Path.

3. Optionally set File Name (no extension) or leave empty to use a timestamp.

4. Choose Video Quality and Trigger Mode.

5. Use the chosen trigger (press Spacebar or toggle the Record input) to start and stop recording.

💡 Tips and Tricks

• To preview what will be recorded, connect the same frame source also to Show Image so you can see a live preview while recording.

• If input frames are larger than needed, add Image Resizer before this block to reduce resolution and lower output file size.

• If you prefer saving individual frames instead of a video, use Image Logger or Multi Image Write in parallel.

• Use Date-Time or Date-Time List to build human-friendly file names (feed the resulting text into File Name (no extension)).

• Use File/Folder Operations to prepare or validate the target folder before starting a recording.

• If you need to stop the whole scenario while recording, combine this block with Stop to ensure a clean finish.

🛠️ Troubleshooting

• Recording does not start:

  • Check the selected Trigger Mode and ensure the appropriate action (Spacebar press or boolean signal) is being used.

  • Verify that Folder Path is valid and writable.

• No frames in saved video or corrupted output:

  • Ensure the frame source actually supplies frames (try previewing with Show Image).

  • Make sure frame size is consistent; resizing the frames before recording can help.

• File name collisions or unexpected suffixes:

  • The block automatically generates unique names when duplicates exist. Use a custom File Name (no extension) and include date/time if you want predictable names.

• Cannot open video while recording:

  • This is expected. Wait until recording stops and the file is finalized before opening it.

If problems persist, try recording a short test clip with a simple source like Video or Load Image (looped) to isolate whether the issue is with the source feed or the saving process.