KFbxVideo Class Reference

This reference page is linked to from the following overview topics: 2012.1, List of Python FBX classes.

---

Search for all occurrences

---

Detailed Description

FBX SDK video class.

Definition at line 32 of file kfbxvideo.h.

#include <kfbxvideo.h>

Inheritance diagram for KFbxVideo:

List of all members.

Public Types
enum	EInterlaceMode {   None, Fields, HalfEven, HalfOdd,   FullEven, FullOdd, FullEvenOdd, FullOddEven }
	Video interlace modes. More...
enum	EAccessMode { Disk, Memory, DiskAsync }
	Video clip access mode. More...
Public Member Functions
double	GetFrameRate () const
	Retrieve the Frame rate of the video clip.
int	GetLastFrame () const
	Retrieve the last frame of the video clip.
int	GetWidth () const
	Retrieve the clip width.
int	GetHeight () const
	Retrieve the clip height.
void	SetStartFrame (int pStartFrame)
	Set the start frame of the video clip.
int	GetStartFrame () const
	Retrieve the start frame of the video clip.
void	SetStopFrame (int pStopFrame)
	Set the stop frame of the video clip.
int	GetStopFrame () const
	Retrieve the stop frame of the video clip.
void	SetPlaySpeed (double pPlaySpeed)
	Set the play speed of the video clip.
double	GetPlaySpeed () const
	Retrieve the play speed of the video clip.
void	SetOffset (KTime pTime)
	Set the time offset.
KTime	GetOffset () const
void	SetFreeRunning (bool pState)
	Set the Free Running state of the video clip.
bool	GetFreeRunning () const
	Retrieve the Free Running state.
void	SetLoop (bool pLoop)
	Set the Loop state of the video clip.
bool	GetLoop () const
	Retrieve the Loop state.
void	SetInterlaceMode (EInterlaceMode pInterlaceMode)
	Set the Interlace mode.
EInterlaceMode	GetInterlaceMode () const
	Retrieve the Interlace mode.
void	SetAccessMode (EAccessMode pAccessMode)
	Set the clip Access Mode.
EAccessMode	GetAccessMode () const
	Retrieve the clip Access Mode.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
virtual KStringList	GetTypeFlags () const
void	SetOriginalFormat (bool pState)
bool	GetOriginalFormat () const
void	SetOriginalFilename (const char *pOriginalFilename)
const char *	GetOriginalFilename () const
Protected Member Functions
	KFbxVideo (KFbxSdkManager &pManager, char const *pName)
virtual void	Construct (const KFbxVideo *pFrom)
virtual bool	ConstructProperties (bool pForceSet)
virtual bool	ConnecNotify (KFbxConnectEvent const &pEvent)
void	Init ()
Protected Attributes
KFbxTypedProperty< fbxBool1 >	ImageSequence
KFbxTypedProperty< fbxInteger1 >	ImageSequenceOffset
KFbxTypedProperty< fbxDouble1 >	FrameRate
KFbxTypedProperty< fbxInteger1 >	LastFrame
KFbxTypedProperty< fbxInteger1 >	Width
KFbxTypedProperty< fbxInteger1 >	Height
KFbxTypedProperty< fbxString >	Path
KFbxTypedProperty< fbxInteger1 >	StartFrame
KFbxTypedProperty< fbxInteger1 >	StopFrame
KFbxTypedProperty< fbxDouble1 >	PlaySpeed
KFbxTypedProperty< fbxTime >	Offset
KFbxTypedProperty< EInterlaceMode >	InterlaceMode
KFbxTypedProperty< fbxBool1 >	FreeRunning
KFbxTypedProperty< fbxBool1 >	Loop
KFbxTypedProperty< EAccessMode >	AccessMode
bool	mUseMipMap
bool	mOriginalFormat
KString	mOriginalFilename
KString	mRelativeFilename
Static Protected Attributes
static KError	smError
Reset video
void	Reset ()
	Reset the video to default values.
Video attributes Management
void	ImageTextureSetMipMap (bool pUseMipMap)
	Set the use of MipMap on the video.
bool	ImageTextureGetMipMap () const
	Retrieve use MipMap state.
bool	SetFileName (char const *pName)
	Specify the Video full filename.
KString	GetFileName () const
	Retrieve the Video full filename.
bool	SetRelativeFileName (char const *pName)
	Specify the Video relative filename.
const char *	GetRelativeFileName () const
	Retrieve the Video relative filename.
Image sequence attributes Management
Besides storing video clips, the KFbxVideo object can also store image sequences.This section contains the manipulation methods used in this specialized mode. Note that, except for the GetFileName(), SetFileName(), GetRelativeFileName(), SetRelativeFileName() and the methods in this section, all the other ones are not mandatory therefore could contain uninitialized or default data values.
void	SetImageSequence (bool pImageSequence)
	Specify if this video object is holding the starting point of an image sequence.
bool	GetImageSequence () const
	Get the current state of the ImageSequence property.
void	SetImageSequenceOffset (int pOffset)
	Specify the frame offset to be applied to the image sequence.
int	GetImageSequenceOffset () const
	Get the current value of the ImageSequenceOffset property.
Error Management
enum	EError { eTAKE_NODE_ERROR, eERROR_COUNT }
	Error identifiers. More...
KError &	GetError ()
	Retrieve error object.
EError	GetLastErrorID () const
	Get last error code.
const char *	GetLastErrorString () const
	Get last error string.

---

Member Enumeration Documentation

enum EInterlaceMode

Search for all occurrences

Video interlace modes.

Enumerator:

None	Progressive frame (full frame). Search for all occurrences
Fields	Alternate even/odd fields. Search for all occurrences
HalfEven	Half of a frame, even fields only. Search for all occurrences
HalfOdd	Half of a frame, odd fields only. Search for all occurrences
FullEven	Extract and use the even field of a full frame. Search for all occurrences
FullOdd	Extract and use the odd field of a full frame. Search for all occurrences
FullEvenOdd	Extract Fields and make full frame with each one beginning with Odd (60fps). Search for all occurrences
FullOddEven	Extract Fields and make full frame with each one beginning with Even (60fps). Search for all occurrences

Definition at line 210 of file kfbxvideo.h.

        {
            None,           
            Fields,         
            HalfEven,       
            HalfOdd,        
            FullEven,       
            FullOdd,        
            FullEvenOdd,    
            FullOddEven     
        } EInterlaceMode;

enum EAccessMode

Search for all occurrences

Video clip access mode.

Enumerator:

Disk	Search for all occurrences
Memory	Search for all occurrences
DiskAsync	Search for all occurrences

Definition at line 235 of file kfbxvideo.h.

        {
            Disk,
            Memory,
            DiskAsync
        } EAccessMode;

enum EError

Search for all occurrences

Error identifiers.

Enumerator:

eTAKE_NODE_ERROR	Search for all occurrences
eERROR_COUNT	End flag. Search for all occurrences

Definition at line 264 of file kfbxvideo.h.

        {
            eTAKE_NODE_ERROR,
            eERROR_COUNT        
        } EError;

---

Constructor & Destructor Documentation

KFbxVideo	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		[protected]

---

Member Function Documentation

void Reset

(

)

Search for all occurrences

Reset the video to default values.

void ImageTextureSetMipMap

(

bool

pUseMipMap

)

Search for all occurrences

Set the use of MipMap on the video.

Parameters:

pUseMipMap

If true, use MipMap on the video.

bool ImageTextureGetMipMap

(

)

const

Search for all occurrences

Retrieve use MipMap state.

Returns:

MipMap flag state.

bool SetFileName

(

char const *

pName

)

Search for all occurrences

Specify the Video full filename.

Parameters:

pName

Video full filename.

Returns:

True,if update successfully, false otherwise.

Remarks:

Update the texture filename if the connection exists.

KString GetFileName

(

)

const

Search for all occurrences

Retrieve the Video full filename.

Returns:

Video full filename.

bool SetRelativeFileName

(

char const *

pName

)

Search for all occurrences

Specify the Video relative filename.

Parameters:

pName

Video relative filename.

Returns:

True, if update successfully, false otherwise.

Remarks:

Update the texture filename if the connection exists.

const char* GetRelativeFileName

(

)

const

Search for all occurrences

Retrieve the Video relative filename.

Returns:

Video relative filename.

void SetImageSequence

(

bool

pImageSequence

)

Search for all occurrences

Specify if this video object is holding the starting point of an image sequence.

Parameters:

pImageSequence

If true, this object is holding an image sequence.

Remarks:

When this object is used as image sequence, the FBX SDK will automatically exclude it from the embedding mechanism.

bool GetImageSequence

(

)

const

Search for all occurrences

Get the current state of the ImageSequence property.

Returns:

ImageSequence property value.

void SetImageSequenceOffset

(

int

pOffset

)

Search for all occurrences

Specify the frame offset to be applied to the image sequence.

Parameters:

pOffset

The frame offset value.

int GetImageSequenceOffset

(

)

const

Search for all occurrences

Get the current value of the ImageSequenceOffset property.

Returns:

ImageSequenceOffset property value.

double GetFrameRate

(

)

const

Search for all occurrences

Retrieve the Frame rate of the video clip.

Returns:

Frame rate.

int GetLastFrame

(

)

const

Search for all occurrences

Retrieve the last frame of the video clip.

Returns:

Last frame number.

int GetWidth

(

)

const

Search for all occurrences

Retrieve the clip width.

Returns:

Video image width.

int GetHeight

(

)

const

Search for all occurrences

Retrieve the clip height.

Returns:

Video image height.

void SetStartFrame

(

int

pStartFrame

)

Search for all occurrences

Set the start frame of the video clip.

Parameters:

pStartFrame

Start frame number.

Remarks:

The parameter value is not checked. It is the responsibility of the caller to deal with bad frame numbers.

int GetStartFrame

(

)

const

Search for all occurrences

Retrieve the start frame of the video clip.

Returns:

Start frame number.

void SetStopFrame

(

int

pStopFrame

)

Search for all occurrences

Set the stop frame of the video clip.

Parameters:

pStopFrame

Stop frame number.

Remarks:

The parameter value is not checked. It is the responsibility of the caller to deal with bad frame numbers.

int GetStopFrame

(

)

const

Search for all occurrences

Retrieve the stop frame of the video clip.

Returns:

Stop frame number.

void SetPlaySpeed

(

double

pPlaySpeed

)

Search for all occurrences

Set the play speed of the video clip.

Parameters:

pPlaySpeed

Playback speed of the clip.

Remarks:

The parameter value is not checked. It is the responsibility of the caller to deal with bad playback speed values.

double GetPlaySpeed

(

)

const

Search for all occurrences

Retrieve the play speed of the video clip.

Returns:

Playback speed.

void SetOffset

(

KTime

pTime

)

Search for all occurrences

Set the time offset.

The offset can be used to shift the playback start time of the clip.

Parameters:

pTime

Time offset of the clip.

KTime GetOffset

(

)

const

Search for all occurrences

void SetFreeRunning

(

bool

pState

)

Search for all occurrences

Set the Free Running state of the video clip.

The Free Running flag can be used by a client application to implement a playback scheme that is independent of the main timeline.

Parameters:

pState

State of the Free running flag.

bool GetFreeRunning

(

)

const

Search for all occurrences

Retrieve the Free Running state.

Returns:

Current free running flag.

void SetLoop

(

bool

pLoop

)

Search for all occurrences

Set the Loop state of the video clip.

The Loop flag can be used by a client application to implement the loop playback of the video clip.

Parameters:

pLoop

State of the loop flag.

bool GetLoop

(

)

const

Search for all occurrences

Retrieve the Loop state.

Returns:

Current loop flag.

void SetInterlaceMode

(

EInterlaceMode

pInterlaceMode

)

Search for all occurrences

Set the Interlace mode.

Parameters:

pInterlaceMode

Interlace mode identifier.

EInterlaceMode GetInterlaceMode

(

)

const

Search for all occurrences

Retrieve the Interlace mode.

Returns:

Interlace mode identifier.

void SetAccessMode

(

EAccessMode

pAccessMode

)

Search for all occurrences

Set the clip Access Mode.

Parameters:

pAccessMode

Clip access mode identifier.

EAccessMode GetAccessMode

(

)

const

Search for all occurrences

Retrieve the clip Access Mode.

Returns:

Clip access mode identifier.

KError& GetError

(

)

Search for all occurrences

Retrieve error object.

Returns:

Reference to error object.

EError GetLastErrorID

(

)

const

Search for all occurrences

Get last error code.

Returns:

Last error code.

const char* GetLastErrorString

(

)

const

Search for all occurrences

Get last error string.

Returns:

Textual description of the last error.

virtual void Construct

(

const KFbxVideo *

pFrom

)

[protected, virtual]

Search for all occurrences

virtual bool ConstructProperties

(

bool

pForceSet

)

[protected, virtual]

Search for all occurrences

Reimplemented from KFbxObject.

virtual bool ConnecNotify

(

KFbxConnectEvent const &

pEvent

)

[protected, virtual]

Search for all occurrences

Reimplemented from KFbxObject.

virtual KFbxObject& Copy

(

const KFbxObject &

pObject

)

[virtual]

Search for all occurrences

Copy an object content into this object.

Parameters:

pObject

The source object to copy data from.

Returns:

Returns the destination object being modified by the source.

Remarks:

This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

Reimplemented from KFbxObject.

virtual KStringList GetTypeFlags

(

)

const [virtual]

Search for all occurrences

Reimplemented from KFbxObject.

void SetOriginalFormat

(

bool

pState

)

Search for all occurrences

bool GetOriginalFormat

(

)

const

Search for all occurrences

void SetOriginalFilename

(

const char *

pOriginalFilename

)

Search for all occurrences

const char* GetOriginalFilename

(

)

const

Search for all occurrences

void Init

(

)

[protected]

Search for all occurrences

---

Member Data Documentation

KError smError [static, protected]

Search for all occurrences

Definition at line 302 of file kfbxvideo.h.

KFbxTypedProperty<fbxBool1> ImageSequence [protected]

Search for all occurrences

Definition at line 304 of file kfbxvideo.h.

KFbxTypedProperty<fbxInteger1> ImageSequenceOffset [protected]

Search for all occurrences

Definition at line 305 of file kfbxvideo.h.

KFbxTypedProperty<fbxDouble1> FrameRate [protected]

Search for all occurrences

Definition at line 306 of file kfbxvideo.h.

KFbxTypedProperty<fbxInteger1> LastFrame [protected]

Search for all occurrences

Definition at line 307 of file kfbxvideo.h.

KFbxTypedProperty<fbxInteger1> Width [protected]

Search for all occurrences

Definition at line 308 of file kfbxvideo.h.

KFbxTypedProperty<fbxInteger1> Height [protected]

Search for all occurrences

Definition at line 309 of file kfbxvideo.h.

KFbxTypedProperty<fbxString> Path [protected]

Search for all occurrences

Definition at line 310 of file kfbxvideo.h.

KFbxTypedProperty<fbxInteger1> StartFrame [protected]

Search for all occurrences

Definition at line 311 of file kfbxvideo.h.

KFbxTypedProperty<fbxInteger1> StopFrame [protected]

Search for all occurrences

Definition at line 312 of file kfbxvideo.h.

KFbxTypedProperty<fbxDouble1> PlaySpeed [protected]

Search for all occurrences

Definition at line 313 of file kfbxvideo.h.

KFbxTypedProperty<fbxTime> Offset [protected]

Search for all occurrences

Definition at line 314 of file kfbxvideo.h.

KFbxTypedProperty<EInterlaceMode> InterlaceMode [protected]

Search for all occurrences

Definition at line 315 of file kfbxvideo.h.

KFbxTypedProperty<fbxBool1> FreeRunning [protected]

Search for all occurrences

Definition at line 316 of file kfbxvideo.h.

KFbxTypedProperty<fbxBool1> Loop [protected]

Search for all occurrences

Definition at line 317 of file kfbxvideo.h.

KFbxTypedProperty<EAccessMode> AccessMode [protected]

Search for all occurrences

Definition at line 318 of file kfbxvideo.h.

bool mUseMipMap [protected]

Search for all occurrences

Definition at line 320 of file kfbxvideo.h.

bool mOriginalFormat [protected]

Search for all occurrences

Definition at line 321 of file kfbxvideo.h.

KString mOriginalFilename [protected]

Search for all occurrences

Definition at line 322 of file kfbxvideo.h.

KString mRelativeFilename [protected]

Search for all occurrences

Definition at line 325 of file kfbxvideo.h.

---

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

• fbxfilesdk/kfbxplugins/kfbxvideo.h