ffmpeg | Camera Component
ffmpeg
The ffmpeg camera model uses a camera device, a video file, or a stream as a camera.
When used with a streaming camera, the ffmpeg camera model supports any streaming camera format that is supported by the ffmpeg program, including MJPEG, H264, and MP4.
Note
The ffmpeg program must be installed separately from viam-server on your system for this driver to work.
Configuration
Copy
Copy
Attributes
| Name | Type | Required? | Description |
|---|---|---|---|
video_path |
string | Required | The file path to the camera device, color image file, or streaming camera. If you are using a camera with an RTSP stream, provide the RTSP address to this attribute. |
intrinsic_parameters |
object | Optional | The intrinsic parameters of the camera used to do 2D <-> 3D projections: - width_px: The expected width of the aligned image in pixels. Value must be positive.- height_px: The expected height of the aligned image in pixels. Value must be positive.- fx: The image center x point.- fy: The image center y point.- ppx: The image focal x.- ppy: The image focal y. |
distortion_parameters |
object | Optional | Modified Brown-Conrady parameters used to correct for distortions caused by the shape of the camera lens: - rk1: The radial distortion x.- rk2: The radial distortion y.- rk3: The radial distortion z.- tp1: The tangential distortion x.- tp2: The tangential distortion y. |
input_kw_args |
object | Optional | The input keyword arguments. |
filters |
array | Optional | Array of filter objects that specify: - name: The name of the filter.- args: The arguments for the filter.- kw_args: Any keyword arguments for the filter. |
output_kw_args |
object | Optional | The output keyword arguments. |