FbxVideo Class Reference
This reference page is linked to from the following overview topics: List of Python Fbx classes.
#include <fbxvideo.h>
FBX SDK video class.
Definition at line 25 of file fbxvideo.h.
Public Types |
|
| enum | EInterlaceMode
{ eNone, eFields, eHalfEven, eHalfOdd, eFullEven, eFullOdd, eFullEvenOdd, eFullOddEven } |
| Video interlace modes. More... |
|
| enum | EAccessMode { eDisk, eMemory, eDiskAsync } |
| 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 (FbxTime pTime) |
| Set the time offset. |
|
| FbxTime | 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. |
|
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 (const char *pName) |
| Specify the Video full filename. |
|
| FbxString | GetFileName () const |
| Retrieve the Video full filename. |
|
| bool | SetRelativeFileName (const char *pName) |
| Specify the Video relative filename.
|
|
| const char * | GetRelativeFileName () const |
| Retrieve the Video relative filename.
|
|
Image sequence attributes Management |
|
|
Besides storing video clips, the FbxVideo 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. |
|
| enum EInterlaceMode |
Video interlace modes.
Definition at line 203 of file fbxvideo.h.
{
eNone,
eFields,
eHalfEven,
eHalfOdd,
eFullEven,
eFullOdd,
eFullEvenOdd,
eFullOddEven
};
| enum EAccessMode |
| void Reset | ( | ) |
Reset the video to default values.
| void ImageTextureSetMipMap | ( | bool | pUseMipMap | ) |
Set the use of MipMap on the video.
| pUseMipMap | If true, use MipMap on the video. |
| bool ImageTextureGetMipMap | ( | ) | const |
| bool SetFileName | ( | const char * | pName | ) |
Specify the Video full filename.
| pName | Video full filename. |
True,if update successfully, false
otherwise.| FbxString GetFileName | ( | ) | const |
| bool SetRelativeFileName | ( | const char * | pName | ) |
Specify the Video relative filename.
| pName | Video relative filename. |
True, if update successfully, false
otherwise.| const char* GetRelativeFileName | ( | ) | const |
| void SetImageSequence | ( | bool | pImageSequence | ) |
Specify if this video object is holding the starting point of an image sequence.
| pImageSequence | If true, this object is holding 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.
| pOffset | The frame offset value. |
| int GetImageSequenceOffset | ( | ) | const |
Get the current value of the ImageSequenceOffset property.
| double GetFrameRate | ( | ) | const |
| int GetLastFrame | ( | ) | const |
| int GetWidth | ( | ) | const |
| int GetHeight | ( | ) | const |
| void SetStartFrame | ( | int | pStartFrame | ) |
Set the start frame of the video clip.
| pStartFrame | Start frame number. |
| int GetStartFrame | ( | ) | const |
| void SetStopFrame | ( | int | pStopFrame | ) |
Set the stop frame of the video clip.
| pStopFrame | Stop frame number. |
| int GetStopFrame | ( | ) | const |
| void SetPlaySpeed | ( | double | pPlaySpeed | ) |
Set the play speed of the video clip.
| pPlaySpeed | Playback speed of the clip. |
| double GetPlaySpeed | ( | ) | const |
| void SetOffset | ( | FbxTime | pTime | ) |
Set the time offset.
The offset can be used to shift the playback start time of the clip.
| pTime | Time offset of the clip. |
| FbxTime GetOffset | ( | ) | const |
| 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.
| pState | State of the Free running flag. |
| bool GetFreeRunning | ( | ) | const |
| 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.
| pLoop | State of the loop flag. |
| bool GetLoop | ( | ) | const |
| void SetInterlaceMode | ( | EInterlaceMode | pInterlaceMode | ) |
Set the Interlace mode.
| pInterlaceMode | Interlace mode identifier. |
| EInterlaceMode GetInterlaceMode | ( | ) | const |
| void SetAccessMode | ( | EAccessMode | pAccessMode | ) |
Set the clip Access Mode.
| pAccessMode | Clip access mode identifier. |
| EAccessMode GetAccessMode | ( | ) | const |