KFbxVideo Class Reference

Inherits KFbxTakeNodeContainer.

Inheritance diagram for KFbxVideo:

Inheritance graph
List of all members.

Detailed Description

Definition at line 63 of file kfbxvideo.h.

Video attributes Management

enum  EInterlaceMode
 Video interlace modes. More...
enum  EAccessMode
 Video interlace modes. More...
void ImageTextureSetMipMap (bool pUseMipMap)
 Set the use of MipMap on the video.
bool ImageTextureGetMipMap ()
 Retrieve use MipMap state.
bool SetFileName (char const *pName)
 Specify the Video full filename.
char * GetFileName ()
 Retrieve the Video full filename.
bool SetRelativeFileName (char const *pName)
 Specify the Video relative filename.
char * GetRelativeFileName ()
 Retrieve the Video relative filename.
double GetFrameRate ()
 Retrieve the Frame rate of the video clip.
int GetLastFrame ()
 Retrieve the last frame of the video clip.
int GetWidth ()
 Retrieve the clip width.
int GetHeight ()
 Retrieve the clip height.
void SetStartFrame (int pStartFrame)
 Set the start frame of the video clip.
int GetStartFrame ()
 Retrieve the start frame of the video clip.
void SetStopFrame (int pStopFrame)
 Set the stop frame of the video clip.
int GetStopFrame ()
 Retrieve the stop frame of the video clip.
void SetPlaySpeed (double pPlaySpeed)
 Set the play speed of the video clip.
double GetPlaySpeed ()
 Retrieve the play speed of the video clip.
void SetOffset (KTime pTime)
 Set the time offset.
KTime GetOffset ()
 Video interlace modes.
void SetFreeRunning (bool pState)
 Set the Free Running state of the video clip.
bool GetFreeRunning ()
 Retrieve the Free Running state.
void SetLoop (bool pLoop)
 Set the Loop state of the video clip.
bool GetLoop ()
 Retrieve the Loop state.
void SetInterlaceMode (EInterlaceMode pInterlaceMode)
 Set the Interlace mode.
EInterlaceMode GetInterlaceMode ()
 Retrieve the Interlace mode.
void SetAccessMode (EAccessMode pAccessMode)
 Set the clip Access Mode.
EAccessMode GetAccessMode ()
 Retrieve the clip Access Mode.

Error Management

enum  EError
 Error identifiers. More...
KError & GetError ()
 Retrieve error object.
EError GetLastErrorID ()
 Get last error code.
char * GetLastErrorString ()
 Get last error string.

Public Member Functions

void Reset ()
 Reset the video to default values.

Member Enumeration Documentation

enum EInterlaceMode

Video interlace modes.

  • Node
  • Fields
  • HalfEven
  • HalfOdd
  • FullEven
  • FullOdd
  • FullEvenOdd
  • FullOddEven

Definition at line 210 of file kfbxvideo.h.

enum EAccessMode

Video interlace modes.

  • Node
  • Fields
  • HalfEven
  • HalfOdd
  • FullEven
  • FullOdd
  • FullEvenOdd
  • FullOddEven

Definition at line 238 of file kfbxvideo.h.

enum EError

Error identifiers.

  • eTAKE_NODE_ERROR
  • eERROR_COUNT

Definition at line 271 of file kfbxvideo.h.

Member Function Documentation

void Reset (  ) 

Reset the video to default values.

void ImageTextureSetMipMap ( bool  pUseMipMap  ) 

Set the use of MipMap on the video.

Parameters:
pUseMipMap If true, use MipMap on the video.

bool ImageTextureGetMipMap (  ) 

Retrieve use MipMap state.

Returns:
MipMap flag state.

bool SetFileName ( char const *  pName  ) 

Specify the Video full filename.

Parameters:
pName Video full filename.
Remarks:
Update the texture filename if the connection exists.

char* GetFileName (  ) 

Retrieve the Video full filename.

Returns:
Video full filename.

bool SetRelativeFileName ( char const *  pName  ) 

Specify the Video relative filename.

Parameters:
pName Video relative filename.
Remarks:
Update the texture filename if the connection exists.

char* GetRelativeFileName (  ) 

Retrieve the Video relative filename.

Returns:
Video relative filename.

double GetFrameRate (  ) 

Retrieve the Frame rate of the video clip.

Returns:
Frame rate.

int GetLastFrame (  ) 

Retrieve the last frame of the video clip.

Returns:
Last frame number.

int GetWidth (  ) 

Retrieve the clip width.

Returns:
Video image width.

int GetHeight (  ) 

Retrieve the clip height.

Returns:
Video image height.

void SetStartFrame ( int  pStartFrame  ) 

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

Retrieve the start frame of the video clip.

Returns:
Start frame number.

void SetStopFrame ( int  pStopFrame  ) 

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

Retrieve the stop frame of the video clip.

Returns:
Stop frame number.

void SetPlaySpeed ( double  pPlaySpeed  ) 

Set the play speed of the video clip.

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

Retrieve the play speed of the video clip.

Returns:
Playback speed.

void SetOffset ( KTime  pTime  ) 

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

Video interlace modes.

  • Node
  • Fields
  • HalfEven
  • HalfOdd
  • FullEven
  • FullOdd
  • FullEvenOdd
  • FullOddEven

void SetFreeRunning ( bool  pState  ) 

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

Retrieve the Free Running state.

Returns:
Current free running flag.

void SetLoop ( bool  pLoop  ) 

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

Retrieve the Loop state.

Returns:
Current loop flag.

void SetInterlaceMode ( EInterlaceMode  pInterlaceMode  ) 

Set the Interlace mode.

Parameters:
pInterlaceMode Interlace mode identifier.

EInterlaceMode GetInterlaceMode (  ) 

Retrieve the Interlace mode.

Returns:
Interlace mode identifier.

void SetAccessMode ( EAccessMode  pAccessMode  ) 

Set the clip Access Mode.

Parameters:
pAccessMode Clip access mode identifier.

EAccessMode GetAccessMode (  ) 

Retrieve the clip Access Mode.

Returns:
Clip access mode identifier.

KError& GetError (  ) 

Retrieve error object.

Returns:
Reference to error object.

EError GetLastErrorID (  ) 

Get last error code.

Returns:
Last error code.

char* GetLastErrorString (  ) 

Get last error string.

Returns:
Textual description of the last error.