SetParameter(uint32_t width, uint32_t height, EPixelType inputPixelType, double framesPerSecondPlaybackSpeed, uint32_t quality) Easy way to set parameters required for video recording.
CanAddWithoutConversion(const Pylon::IImage & image) Can be used to check whether the given image is added to the video file without prior conversion when Add() is called.
Easy way to set parameters required for video recording.
Parameters:
width The number of pixels in a row of the video file to save.
height The number of rows of the video file to save.
inputPixelType The pixel type of the images that will be added to the video writer. This input is used to derive the video format. Currently the output is always YUV420p.
framesPerSecondPlaybackSpeed The playback speed in frames per second.
quality The quality setting, valid range is 1 … 100.
Precondition: The VideoWriter ist closed.
Error Safety:
Throws a C++ exception when a parameter is out of range, set to an invalid value or parameters cannot be changed (e.g., after calling Open()).
This is a convenient way to set all required parameters in a single function call. The parameters width, height, framesPerSecondPlaybackSpeed and quality are set in the nodemap. The parameter inputPixelType is checked for its convertibility to YUV420p or whether it is already YUV420p. Advanced parameters can be accessed using the nodemap provided by GetNodeMap().
If the pixelType is YUV420p the orientation has to be ImageOrientation_TopDown.
The width and height of the image match the values passed when opening the video file.
Error Safety:
Throws an exception if the image cannot be added.
Thread Safety:
This method is synchronized using the lock provided by GetLock().
Converts the image to the correct format if required.
The image is automatically converted to YUV420p unless the input pixelType is already YUV420p. The orientation of the image is always converted to ImageOrientation_TopDown unless the inputpixelType is YUV420p. In that case, the orientation of the image must already be ImageOrientation_TopDown. See preconditions.
If the pixelType is YUV420p the orientation has to be ImageOrientation_TopDown.
The width and height of the image match the values passed when opening the video file.
Error Safety:
Throws an exception if the image cannot be added.
Thread Safety:
This method is synchronized using the lock provided by GetLock().
Converts the image to the correct format if required.
The image is automatically converted to YUV420p unless the input pixelType is already YUV420p. The orientation of the image is always converted to ImageOrientation_TopDown unless the input pixelType is YUV420p. In that case, the orientation of the image must already be ImageOrientation_TopDown. See preconditions.
Can be used to check whether the given image is added to the video file without prior conversion when Add() is called.
Parameters:
pixelType The pixel type of the image to save.
width The number of pixels in a row of the image to save.
height The number of rows of the image to save.
paddingX The number of extra data bytes at the end of each row.
orientation The vertical orientation of the image data in the video file.
Return: Returns true if the image is added to the video stream without prior conversion when Add() is called. Returns false if the image is automatically converted when Add() is called. Returns false if the image cannot be added at all. See the preconditions of Add() for more information.
Return: Returns true if the image is added to the video stream without prior conversion when Add() is called. Returns false if the image is automatically converted when Add() is called. Returns false if the image cannot be added at all. See the preconditions of Add() for more information.
Return: Returns true if video writing is supported.
Error Safety:
Does not throw C++ exceptions.
Checks if all necessary dynamic libraries of the supplementary software package are installed and can be loaded. This does not check if the codec for the video can be used. This is checked in Open().
Quality of the resulting compressed stream. The quality has a direct influence on the resulting bit rate. The optimal bit rate is calculated based on the input values height, width, and playback frame rate (WIDTH * HEIGHT * PLAYBACKFRAMERATE * 0.25). This is then normalized to the quality value range 1-100, where 100 corresponds to the optimum bit rate and 1 to the lowest bit rate.