Open Reality Reference Guide
 
Loading...
Searching...
No Matches
fbvideo.h File Reference

FBVideo and derivative classes. More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcore.h>

Go to the source code of this file.

Classes

class  FBVideo
 Video media class. More...
 
class  FBVideoClip
 Video clip media class. More...
 
class  FBVideoClipImage
 Video clip image media class. Used for a variety of image types. For DDS images, use the FBVideoClipImageDDS instead. More...
 
class  FBVideoClipImageDDS
 Video clip image media class for DDS images. More...
 
class  FBVideoMemory
 FBVideoMemory allow external media source (which can't be supported by MoBu natively) More...
 
class  FBVideoIn
 Basic video input class, supporting webcam and DV device. More...
 
class  FBVideoOut
 Video media class. More...
 
class  FBEventVideoSwitcher
 Video switcher callback event. More...
 
class  FBVideoSwitcher
 Video Switcher class. More...
 
class  FBPropertyListVideoClip
 PropertyList: VideoClip More...
 
class  FBPropertyListVideoIn
 PropertyList: VideoIn More...
 
class  FBPropertyListVideoOut
 PropertyList: VideoOut More...
 

Macros

#define FBSDK_DLL   K_DLLIMPORT
 Be sure that FBSDK_DLL is defined only once...
 
#define FBVideoDeclare(ClassName, Parent)
 Video declaration.
 
#define FBVideoImplementation(ThisComponent)    FBClassImplementation( ThisComponent )
 Video implementation.
 

Enumerations

enum  FBVideoProxyMode {
  kFBVideoProxyNone ,
  kFBVideoProxyOnPlay ,
  kFBVideoProxyAlways
}
 Video proxy modes. More...
 
enum  FBVideoStorageMode {
  kFBVideoStorageDisk ,
  kFBVideoStorageMemory ,
  kFBVideoStorageDiskAsync
}
 Video storage modes. More...
 
enum  FBVideoInterlaceMode {
  kFBVideoInterlaceNone ,
  kFBVideoInterlaceHalfFrameEven ,
  kFBVideoInterlaceHalfFrameOdd ,
  kFBVideoInterlaceFullFrameEven ,
  kFBVideoInterlaceFullFrameOdd
}
 Video interlace modes. More...
 
enum  FBVideoFormat {
  kFBVideoFormat_Any ,
  kFBVideoFormat_Other ,
  kFBVideoFormat_RGBA_32 ,
  kFBVideoFormat_RGB_24 ,
  kFBVideoFormat_BGRA_32 ,
  kFBVideoFormat_BGR_24 ,
  kFBVideoFormat_BGR_16 ,
  kFBVideoFormat_ABGR_32 ,
  kFBVideoFormat_ARGB_32 ,
  kFBVideoFormat_422
}
 Video color modes. More...
 
enum  FBVideoResolution {
  kFBVideo_RES_FULL = 0 ,
  kFBVideo_RES_1 ,
  kFBVideo_RES_2 ,
  kFBVideo_RES_4 ,
  kFBVideo_RES_8 ,
  kFBVideo_RES_16 ,
  kFBVideo_RES_32 ,
  kFBVideo_RES_64 ,
  kFBVideo_RES_128 ,
  kFBVideo_RES_256 ,
  kFBVideo_RES_512 ,
  kFBVideo_RES_1K ,
  kFBVideo_RES_2K ,
  kFBVideo_RES_4K ,
  kFBVideo_RES_8K ,
  kFBVideo_RES_16K
}
 Video Resolution (1D) More...
 
enum  FBVideoLiveType {
  kFBVideoLiveDefault ,
  kFBVideoLiveBasic
}
 Video Live type. More...
 
enum  FBClipEnd {
  kFBClipEndEnd ,
  kFBClipEndLoop
}
 Clip end actions. More...
 
enum  FBPlayMode {
  kFBPlayModeNoPlay ,
  kFBPlayModePreviewToEnd ,
  kFBPlayModePlay ,
  kFBPlayModeLoop ,
  kFBPlayModePlayToEnd
}
 Play modes. More...
 

Functions

 FB_DEFINE_COMPONENT (K_DLLIMPORT, Video)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, VideoIn)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, VideoOut)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, VideoClip)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, VideoClipImage)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, VideoClipImageDDS)
 
 FB_DEFINE_COMPONENT (K_DLLIMPORT, VideoSwitcher)
 
 __FB_FORWARD (FBVideo)
 
 __FB_FORWARD (FBVideoClip)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, TimeMode)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, VideoProxyMode)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, VideoStorageMode)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, VideoInterlaceMode)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, VideoFormat)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, VideoResolution)
 
 __FB_FORWARD (FBVideoClipImage)
 
 __FB_FORWARD (FBVideoClipImageDDS)
 
 __FB_FORWARD (FBVideoMemory)
 
 __FB_FORWARD (FBVideoIn)
 
 __FB_FORWARD (FBVideoOut)
 
 __FB_FORWARD (FBVideoSwitcher)
 
 __FB_FORWARD (FBEventVideoSwitcher)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, ClipEnd)
 
 FB_DEFINE_ENUM (K_DLLIMPORT, PlayMode)
 

Detailed Description

FBVideo and derivative classes.

Definition in file fbvideo.h.

Macro Definition Documentation

◆ FBSDK_DLL

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbvideo.h.

◆ FBVideoDeclare

#define FBVideoDeclare (   ClassName,
  Parent 
)
Value:
FBClassDeclare( ClassName,Parent ); \
public: \
ClassName(const char* pName):Parent(pName) { FBClassInit; } \
private:
#define FBClassDeclare(Name, Parent)
Class declaration.
Definition fbdefines.h:85
#define FBClassInit
Class initialization.
Definition fbdefines.h:64

Video declaration.

Parameters
ClassNameName of Video class.
ParentParent class of ClassName.

Definition at line 70 of file fbvideo.h.

◆ FBVideoImplementation

#define FBVideoImplementation (   ThisComponent)     FBClassImplementation( ThisComponent )

Video implementation.

Parameters
ThisComponentName of Video class to implement.

Definition at line 79 of file fbvideo.h.

Enumeration Type Documentation

◆ FBClipEnd

enum FBClipEnd

Clip end actions.

Enumerator
kFBClipEndEnd 

On clip end stop clip.

kFBClipEndLoop 

On clip end loop clip.

Definition at line 450 of file fbvideo.h.

◆ FBPlayMode

enum FBPlayMode

Play modes.

Enumerator
kFBPlayModeNoPlay 

No play (most common).

kFBPlayModePreviewToEnd 

Preview clip until end.

kFBPlayModePlay 

Play clip.

kFBPlayModeLoop 

Loop clip.

kFBPlayModePlayToEnd 

Play clip to end.

Definition at line 455 of file fbvideo.h.

◆ FBVideoFormat

Video color modes.

Definition at line 112 of file fbvideo.h.

◆ FBVideoInterlaceMode

Video interlace modes.

Enumerator
kFBVideoInterlaceNone 

No interacling.

kFBVideoInterlaceHalfFrameEven 

Half frame (even field).

kFBVideoInterlaceHalfFrameOdd 

Half frame (odd field).

kFBVideoInterlaceFullFrameEven 

Full frame (even field).

kFBVideoInterlaceFullFrameOdd 

Full frame (odd field).

Definition at line 103 of file fbvideo.h.

◆ FBVideoLiveType

Video Live type.

Enumerator
kFBVideoLiveDefault 

Generic video input, type not specified.

kFBVideoLiveBasic 

Basic video input, like webcam and dv camera.

Definition at line 359 of file fbvideo.h.

◆ FBVideoProxyMode

Video proxy modes.

Enumerator
kFBVideoProxyNone 

No video proxy.

kFBVideoProxyOnPlay 

Video proxy on play.

kFBVideoProxyAlways 

Always video proxy.

Definition at line 89 of file fbvideo.h.

◆ FBVideoResolution

Video Resolution (1D)

Definition at line 126 of file fbvideo.h.

◆ FBVideoStorageMode

Video storage modes.

Enumerator
kFBVideoStorageDisk 

Storage on disk.

kFBVideoStorageMemory 

Storage in memory.

kFBVideoStorageDiskAsync 

Storage on disk async access.

Definition at line 96 of file fbvideo.h.