DecodeVideo


Captures an image from video file with using FFmpeg library.

Syntax

C++
Python
 
def DecodeVideo(
	state: FFmpeg_DecoderState,
	inFile: str,
	outImage: Image,
	/,
	*,
	inStartFrameId: int | None = None
)
-> (
	outResult: bool,
	outFrameId: int
)

Parameters

Name Type Default Description
Input will be modified ioState FFmpeg_DecoderState
Input value inFile str File path with the appropriate format, e.g., input.avi
Input value inStartFrameId int | None None ID of the frame to start the acquisition
Output value outImage Image Captured frame
Output value outFrameId int ID of the captured frame