Public Member Functions | List of all members
Recorder Class Reference

Recorder object writing video streams with the given pixel format and recording engine. More...

Inherits object.

Public Member Functions

None close (self)
 Closes the recording stream. More...
 
None write (self, cvb.Image image, Optional[str] meta_data)
 Writes the given image into the stream. More...
 

Detailed Description

Recorder object writing video streams with the given pixel format and recording engine.

Instantiates a Recorder object.

Parameters

path : str Path to write AVI container to.

size : cvb.Size2D Size of the video frames in pixels.

pixel_format : int Defines whether mono or color images are written (see cvb.movie2.RecorderPixelFormat).

settings : Optional[cvb.movie2.RecordingSettings] Recorder settings to use for the recording engine.

Member Function Documentation

◆ close()

None close (   self)

Closes the recording stream.

◆ write()

None write (   self,
cvb.Image  image,
Optional[str]  meta_data 
)

Writes the given image into the stream.

Parameters

image : cvb.Image Image to write into the stream.

meta_data : Optional[str] Metadata text to write into the stream.