VideoReaderFFMPEG
Python template · sinapsis_data_readers.templates.video_readers.video_reader_ffmpeg
Overview
This template provides functionality to read video files using the FFMPEG library. The video frames are read asynchronously, and the resources are cleaned after all the frames have been processed
Capabilities
Capabilities: not setInstallation
Install the published package using pip or uv.
pip install sinapsis-data-readers==1.0.0uv pip install sinapsis-data-readers==1.0.0uv add sinapsis-data-readers==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
Device to be used for loading the video. Default is "cpu".
Optional
Default: "cpu"
Optional
Default: null
Optional
Default: null
Number of frames in the batch. Default is 1.
Optional
Default: 1
Whether to loop the video indefinitely. Default is False.
Optional
Default: false
Source of the video. Default is a UUID string.
Optional
Default: "836c104a-f9c8-4ee5-865c-e96f413a0b21"
Path or list of paths to the video(s).
Required
Default: null
Configuration example
Example from the Python docstring:
agent:
name: my_test_agent
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name: VideoReaderFFMPEG
class_name: VideoReaderFFMPEG
template_input: InputTemplate
attributes:
video_file_path: '/path/to/video/file'
batch_size: 1
video_source: 4d2a355f-cda4-4742-9042-8e6ee842d1cf
loop_forever: falseShow schema-based configuration skeleton
templates:
- template_name: "VideoReaderFFMPEG"
class_name: "VideoReaderFFMPEG"
attributes:
device: "cpu"
root_dir: null
batch_size: 1
loop_forever: false
video_source: "836c104a-f9c8-4ee5-865c-e96f413a0b21"
video_file_path: "<required>"
Inheritance
sinapsis_data_readers.templates.video_readers.base_video_reader.BaseVideoReaderEnvironment variables
Environment definitions belong to their canonical Python modules.
No directly related environment variables listed.