WriteGear API Parameters¶

output¶

This parameter sets the valid filename/path/URL for the video output.

Data-Type: String

Usage:

Its valid input can be one of the following:

• Path to directory: Valid path of the directory to save the output video file. In this case, WriteGear API will automatically assign a unique filename (with a default extension i.e..mp4) as follows:

  writer = WriteGear(output = '/home/foo/foo1') #Define writer 
  

• Filename (with/without path): Valid filename(with valid extension) of the output video file. In case filename is provided without path, then current working directory will be used.

  writer = WriteGear(output = 'output.mp4') #Define writer 
  

  Make sure to provide valid filename with valid file-extension based on the encoder in use.

• URL: Valid URL of a network stream with a protocol supported by installed FFmpeg (verify with command ffmpeg -protocols) only. This is useful for building a Video-Streaming Server with FFmpeg in WriteGear API. For example, you can stream on a rtmp protocol URL as follows:

  writer = WriteGear(output = 'rtmp://localhost/live/test') #Define writer 
  

compression_mode¶

This parameter selects the WriteGear's Primary Mode of Operation, i.e. if you want to use Compression Mode, then set this parameter to True, otherwise set it to False for Non-Compression Mode.

Data-Type: Boolean

Default Value: Its default value is True.

Usage:

WriteGear(output = 'output.mp4', compression_mode=True)

custom_ffmpeg¶

This parameter assigns the path or directory where the custom FFmpeg executables are located in Compression Mode only.

Data-Type: String

Default Value: Its default value is None.

Usage:

output_params¶

This parameter allows to customize the output video encoding parameters both in Compression and Non-Compression Mode.

• In non-compression mode, this parameter allows us to exploit almost all OpenCV's VideoWriter API supported parameters effortlessly and flexibly for video-encoding, by formatting desired OpenCV Parameters as this parameter's attributes.
• In compression mode, this parameter allows us to exploit almost all FFmpeg's Video Encoding API supported parameters effortlessly and flexibly for encoding, by formatting desired FFmpeg Parameters as this parameter's attributes.

Data-Type: Dictionary

Default Value: Its default value is {}.

Usage:

logging¶

This parameter enables logging (if True), essential for debugging.

Data-Type: Boolean

Default Value: Its default value is False.

Usage:

WriteGear(output = 'output.mp4', logging=True)