Open Reality Reference Guide
FBVideoCodecManager Class Reference

Video Codec manager class. More...

#include <fbvideocodecmanager.h>

Static Public Member Functions

static void GetCodecIdList (const char *pFileFormatInfo, FBStringList &pCodecList)
 GetCodecIdList. More...
 
static FBVideoCodecMode GetVideoCodecMode ()
 GetVideoCodecMode. More...
 
static void SetVideoCodecMode (FBVideoCodecMode pVideoCodecMode)
 SetVideoCodecMode. More...
 
static void SetDefaultCodec (const char *pFileFormatInfo, const char *pCodecId)
 SetDefaultCodec. More...
 
static const char * GetDefaultCodec (const char *pFileFormatInfo)
 GetDefaultCodec. More...
 
static bool RegisterExternalVideoFormat (const char *pFormatSuffix)
 Register external video format suffix. More...
 

Detailed Description

Video Codec manager class.

Use to set or get codec used and codec params

Definition at line 67 of file fbvideocodecmanager.h.

Member Function Documentation

◆ GetCodecIdList()

static void GetCodecIdList ( const char *  pFileFormatInfo,
FBStringList pCodecList 
)
static

GetCodecIdList.

Get all codec id available for a given file format.

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

◆ GetDefaultCodec()

static const char* GetDefaultCodec ( const char *  pFileFormatInfo)
static

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...)

◆ GetVideoCodecMode()

static FBVideoCodecMode GetVideoCodecMode ( )
static

GetVideoCodecMode.

Get the current codec mode. This decide how the system behaves when ask to render a file (codec dialog, uncompress, use default codec)

◆ RegisterExternalVideoFormat()

static bool RegisterExternalVideoFormat ( const char *  pFormatSuffix)
static

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.

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.
Parameters
pFormatSuffixSuffix/File extension of external video file format
Returns
true if register successful

◆ SetDefaultCodec()

static void SetDefaultCodec ( const char *  pFileFormatInfo,
const char *  pCodecId 
)
static

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

◆ SetVideoCodecMode()

static void SetVideoCodecMode ( FBVideoCodecMode  pVideoCodecMode)
static

SetVideoCodecMode.

Get the current codec mode.

Parameters
pVideoCodecModethe codec mode to apply to the whole system

The documentation for this class was generated from the following file: