c4d.bitmaps.MovieSaver

class c4d.bitmaps.MovieSaver

The movie saver class is used for reading and writing movie streams.

Methods Signatures

MovieSaver.__init__(self,)

rtype

c4d.bitmaps.MovieSaver

MovieSaver.Open(self, name, bm, fps, ...)

Opens a movie stream to the file name.

MovieSaver.Close(self,)

Close the movie file.

MovieSaver.Write(self, bm)

Adds another frame to the end of the movie stream.

MovieSaver.Choose(self, format, bc)

Opens the standard compression chooser for movie formats.

Methods Documentation

MovieSaver.__init__(self)
Return type

c4d.bitmaps.MovieSaver

Returns

The new movie saver

MovieSaver.Open(self, name, bm, fps, format, data, savebits)
Opens a movie stream to the file name.
The resolution and bit depth are defined by the first frame in bm.
The framerate is specified by fps.
Parameters
  • name (Union[str, c4d.storage.MemoryFileStruct]) – A file.

  • bm (c4d.bitmaps.BaseBitmap) – A typical frame of the movie, used for dimensions.

  • fps (int) – The frame rate in frames per second

  • format (int) – The file format. Valid values are either FILTER_AVI or FILTER_MOVIE.

  • data (c4d.BaseContainer) –

    Additional settings for the file format.

    (Please see the documentation for the AVI and Quicktime formats for more information.)

    AVISAVER_FCCTYPE

    Unknown.

    AVISAVER_FCCHANDLER

    Unknown.

    AVISAVER_LKEY

    Unknown.

    AVISAVER_LDATARATE

    Unknown.

    AVISAVER_LQ

    Unknown.

    QTSAVER_COMPRESSOR

    Unknown.

    QTSAVER_QUALITY

    Unknown.

    QTSAVER_TEMPQUAL

    Unknown.

    QTSAVER_FRAMERATE

    Unknown.

    QTSAVER_KEYFRAMES

    Unknown.

    QTSAVER_PLANES

    Unknown.

    QTSAVER_DATARATE

    Unknown.

    QTSAVER_FRAMEDURATION

    Unknown.

    QTSAVER_MINQUALITY

    Unknown.

    QTSAVER_MINTEMPQUAL

    Unknown.

    QTSAVER_FIXEDFRAMERATE

    Unknown.

  • savebits (int) –

    Can be a combination of the following flags:

    SAVEBIT_NONE

    None.

    SAVEBIT_ALPHA

    Save the alpha channel(s) in the file. (For filter plugins, do not save an alpha channel if this is not set.)

    SAVEBIT_MULTILAYER

    Save multiple layers.

    SAVEBIT_USESELECTEDLAYERS

    Use selected layers.

    SAVEBIT_16BITCHANNELS

    Use 16-bit channels.

    SAVEBIT_GREYSCALE

    Save in grayscale mode.

    SAVEBIT_INTERNALNET

    Private.

    SAVEBIT_DONTMERGE

    Avoid merging of layers in BodyPaint 3D files.

    SAVEBIT_32BITCHANNELS

    Use 32-bit channels.

    SAVEBIT_SAVERENDERRESULT

    Private.

    SAVEBIT_FIRSTALPHA_ONLY

    Private.

MovieSaver.Close(self)

Close the movie file.

MovieSaver.Write(self, bm)

Adds another frame to the end of the movie stream.

Parameters

bm (c4d.bitmaps.BaseBitmap) – The frame to add

Return type

int

Returns

The result. Possible values are:

IMAGERESULT_OK

Image loaded/created.

IMAGERESULT_NOTEXISTING

Image does not exist.

IMAGERESULT_WRONGTYPE

Image has the wrong type.

IMAGERESULT_OUTOFMEMORY

Not enough memory.

IMAGERESULT_FILEERROR

File error.

IMAGERESULT_FILESTRUCTURE

Invalid file structure.

IMAGERESULT_MISC_ERROR

Unknown error.

IMAGERESULT_PARAM_ERROR

Parameter error.

IMAGERESULT_THREADCANCELED

Thread canceled while working.

MovieSaver.Choose(self, format, bc)

Opens the standard compression chooser for movie formats.

Note

The arguments might change in the future.

The new settings are stored in bc if the user clicks ok.

data = c4d.BaseContainer()
action = ms.Choose(c4d.FILTER_AVI, data)
if action==False: return #is True if the user canceled the dialog

ms.Open(..., data, ...)
Parameters
  • format (int) – The file format. Valid values are either FILTER_AVI or FILTER_MOVIE.

  • bc (c4d.BaseContainer) – Used to pass the default settings, and to read the settings the user has chosen.