FFmpegSettings(bpy_struct)

base class — bpy_struct

class bpy.types.FFmpegSettings(bpy_struct)

FFmpeg related settings for the scene

audio_bitrate

Audio bitrate (kb/s)

Type:int in [32, 384], default 0
audio_channels

Audio channel count

  • MONO Mono, Set audio channels to mono.
  • STEREO Stereo, Set audio channels to stereo.
  • SURROUND4 4 Channels, Set audio channels to 4 channels.
  • SURROUND51 5.1 Surround, Set audio channels to 5.1 surround sound.
  • SURROUND71 7.1 Surround, Set audio channels to 7.1 surround sound.
Type:enum in [‘MONO’, ‘STEREO’, ‘SURROUND4’, ‘SURROUND51’, ‘SURROUND71’], default ‘MONO’
audio_codec

FFmpeg audio codec to use

  • NONE No Audio, Disables audio output, for video-only renders.
  • AAC AAC.
  • AC3 AC3.
  • FLAC FLAC.
  • MP2 MP2.
  • MP3 MP3.
  • PCM PCM.
  • VORBIS Vorbis.
Type:enum in [‘NONE’, ‘AAC’, ‘AC3’, ‘FLAC’, ‘MP2’, ‘MP3’, ‘PCM’, ‘VORBIS’], default ‘NONE’
audio_mixrate

Audio samplerate(samples/s)

Type:int in [8000, 192000], default 0
audio_volume

Audio volume

Type:float in [0, 1], default 0.0
buffersize

Rate control: buffer size (kb)

Type:int in [0, 2000], default 0
codec

FFmpeg codec to use for video output

  • NONE No Video, Disables video output, for audio-only renders.
  • DNXHD DNxHD.
  • DV DV.
  • FFV1 FFmpeg video codec #1.
  • FLASH Flash Video.
  • H264 H.264.
  • HUFFYUV HuffYUV.
  • MPEG1 MPEG-1.
  • MPEG2 MPEG-2.
  • MPEG4 MPEG-4 (divx).
  • PNG PNG.
  • QTRLE QT rle / QT Animation.
  • THEORA Theora.
  • WEBM WEBM / VP9.
Type:enum in [‘NONE’, ‘DNXHD’, ‘DV’, ‘FFV1’, ‘FLASH’, ‘H264’, ‘HUFFYUV’, ‘MPEG1’, ‘MPEG2’, ‘MPEG4’, ‘PNG’, ‘QTRLE’, ‘THEORA’, ‘WEBM’], default ‘H264’
constant_rate_factor

Constant Rate Factor (CRF); tradeoff between video quality and file size

  • NONE Constant Bitrate, Configure constant bit rate, rather than constant output quality.
  • LOSSLESS Lossless.
  • PERC_LOSSLESS Perceptually lossless.
  • HIGH High quality.
  • MEDIUM Medium quality.
  • LOW Low quality.
  • VERYLOW Very low quality.
  • LOWEST Lowest quality.
Type:enum in [‘NONE’, ‘LOSSLESS’, ‘PERC_LOSSLESS’, ‘HIGH’, ‘MEDIUM’, ‘LOW’, ‘VERYLOW’, ‘LOWEST’], default ‘MEDIUM’
ffmpeg_preset

Tradeoff between encoding speed and compression ratio

  • BEST Slowest, Recommended if you have lots of time and want the best compression efficiency.
  • GOOD Good, The default and recommended for most applications.
  • REALTIME Realtime, Recommended for fast encoding.
Type:enum in [‘BEST’, ‘GOOD’, ‘REALTIME’], default ‘GOOD’
format

Output file container

Type:enum in [‘MPEG1’, ‘MPEG2’, ‘MPEG4’, ‘AVI’, ‘QUICKTIME’, ‘DV’, ‘OGG’, ‘MKV’, ‘FLASH’], default ‘MKV’
gopsize

Distance between key frames, also known as GOP size; influences file size and seekability

Type:int in [0, 500], default 25
max_b_frames

Maximum number of B-frames between non-B-frames; influences file size and seekability

Type:int in [0, 16], default 0
maxrate

Rate control: max rate (kb/s)

Type:int in [-inf, inf], default 0
minrate

Rate control: min rate (kb/s)

Type:int in [-inf, inf], default 0
muxrate

Mux rate (bits/s(!))

Type:int in [0, inf], default 0
packetsize

Mux packet size (byte)

Type:int in [0, 16384], default 0
use_autosplit

Autosplit output at 2GB boundary

Type:boolean, default False
use_lossless_output

Use lossless output for video streams

Type:boolean, default False
use_max_b_frames

Set a maximum number of B-frames

Type:boolean, default False
video_bitrate

Video bitrate (kb/s)

Type:int in [-inf, inf], default 0
classmethod bl_rna_get_subclass(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The RNA type or default when not found.
Return type:bpy.types.Struct subclass
classmethod bl_rna_get_subclass_py(id, default=None)
Parameters:id (string) – The RNA type identifier.
Returns:The class or default when not found.
Return type:type

Inherited Properties

Inherited Functions

References