Python Reference Guide
 
Loading...
Searching...
No Matches
FBVideoCodecManager Class Reference

Video Codec manager class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBVideoCodecManager:

Public Member Functions

 GetCodecIdList (str pFileFormatInfo, FBStringList pCodecList)
 GetCodecIdList.
 
str GetDefaultCodec (str pFileFormatInfo)
 GetDefaultCodec.
 
bool RegisterExternalVideoFormat (str pFormatSuffix)
 Register external video format suffix.
 
 SetDefaultCodec (str pFileFormatInfo, str pCodecId)
 SetDefaultCodec.
 

Detailed Description

Video Codec manager class.


Use to set or get codec used and codec params

See samples: codecExamples.py, render.py.

Member Function Documentation

◆ GetCodecIdList()

GetCodecIdList ( str  pFileFormatInfo,
FBStringList  pCodecList 
)

GetCodecIdList.

Get all codec id available for a given file format.

Parameters
pFileFormatInfofile format description string (AVI, MOV...)
pCodecListCodec list id

◆ GetDefaultCodec()

str GetDefaultCodec ( str  pFileFormatInfo)

GetDefaultCodec.

Get the default codec id for a given file format. This is the codec that will be used if codec mode is FBVideoCodecUseDefault

Parameters
pFileFormatInfofile format description string (AVI, MOV...)

◆ RegisterExternalVideoFormat()

bool RegisterExternalVideoFormat ( str  pFormatSuffix)

Register external video format suffix.

Only alphabetic and number is allowed in provided suffix, and can not be empty suffix or the system exist suffixes. This will allow this suffix to be appeared in the filters of file dialog when importing video, also allow to create a texture/video object with a path containing this suffix via SDK. However it will the custom SDK plug-in developer's responsibility to load the file into memory.

Parameters
pFormatSuffixSuffix/File extension of external video file format
Returns
true if register successful
Remarks
After register an external video format, and save a scene with this kind of video. when start MotionBuilder next time and before load the scene back,
It is necessary to call RegisterExternalVideoFormat to register this kind of video format again, otherwise this kind of video will not be loaded.

◆ SetDefaultCodec()

SetDefaultCodec ( str  pFileFormatInfo,
str  pCodecId 
)

SetDefaultCodec.

Set the default codec id for a given file format. This is the codec that will be used if codec mode is FBVideoCodecUseDefault

Parameters
pFileFormatInfofile format description string (AVI, MOV...)
pCodecIdthe codec id to set as default