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
class	FBVideoClipImage
class	FBVideoMemory
	Video media class. 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...
Defines
#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	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 (FBSDK_DLL, Video)
	FB_DEFINE_COMPONENT (FBSDK_DLL, VideoIn)
	FB_DEFINE_COMPONENT (FBSDK_DLL, VideoOut)
	FB_DEFINE_COMPONENT (FBSDK_DLL, VideoClip)
	FB_DEFINE_COMPONENT (FBSDK_DLL, VideoClipImage)
	FB_DEFINE_COMPONENT (FBSDK_DLL, VideoSwitcher)
	__FB_FORWARD (FBVideo)
	__FB_FORWARD (FBVideoClip)
	FB_DEFINE_ENUM (FBSDK_DLL, VideoProxyMode)
	FB_DEFINE_ENUM (FBSDK_DLL, VideoStorageMode)
	FB_DEFINE_ENUM (FBSDK_DLL, VideoInterlaceMode)
	FB_DEFINE_ENUM (FBSDK_DLL, VideoFormat)
	__FB_FORWARD (FBVideoClipImage)
	__FB_FORWARD (FBVideoMemory)
	__FB_FORWARD (FBVideoIn)
	__FB_FORWARD (FBVideoOut)
	__FB_FORWARD (FBVideoSwitcher)
	__FB_FORWARD (FBEventVideoSwitcher)
	FB_DEFINE_ENUM (FBSDK_DLL, ClipEnd)
	FB_DEFINE_ENUM (FBSDK_DLL, PlayMode)

---

Detailed Description

FBVideo and derivative classes.

Definition in file fbvideo.h.

---

Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbvideo.h.

#define FBVideoDeclare	(		ClassName,
			Parent
	)

Search for all occurrences

Value:

FBClassDeclare( ClassName,Parent ); \
  public: \
  ClassName(char * pName):Parent(pName) { FBClassInit; } \
  private:

Video declaration.

Parameters:

ClassName	Name of Video class.
Parent	Parent class of ClassName.

Definition at line 69 of file fbvideo.h.

#define FBVideoImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

Search for all occurrences

Video implementation.

Parameters:

ThisComponent

Name of Video class to implement.

Definition at line 78 of file fbvideo.h.

---

Enumeration Type Documentation

enum FBVideoProxyMode

Search for all occurrences

Video proxy modes.

Enumerator:

kFBVideoProxyNone	No video proxy. Search for all occurrences
kFBVideoProxyOnPlay	Video proxy on play. Search for all occurrences
kFBVideoProxyAlways	Always video proxy. Search for all occurrences

Definition at line 88 of file fbvideo.h.

                      {   
    kFBVideoProxyNone,      
    kFBVideoProxyOnPlay,    
    kFBVideoProxyAlways     
};

enum FBVideoStorageMode

Search for all occurrences

Video storage modes.

Enumerator:

kFBVideoStorageDisk	Storage on disk. Search for all occurrences
kFBVideoStorageMemory	Storage in memory. Search for all occurrences
kFBVideoStorageDiskAsync	Storage on disk async access. Search for all occurrences

Definition at line 95 of file fbvideo.h.

                        {
    kFBVideoStorageDisk,            
    kFBVideoStorageMemory,          
    kFBVideoStorageDiskAsync        
};

enum FBVideoInterlaceMode

Search for all occurrences

Video interlace modes.

Enumerator:

kFBVideoInterlaceNone	No interacling. Search for all occurrences
kFBVideoInterlaceHalfFrameEven	Half frame (even field). Search for all occurrences
kFBVideoInterlaceHalfFrameOdd	Half frame (odd field). Search for all occurrences
kFBVideoInterlaceFullFrameEven	Full frame (even field). Search for all occurrences
kFBVideoInterlaceFullFrameOdd	Full frame (odd field). Search for all occurrences

Definition at line 102 of file fbvideo.h.

                          {
    kFBVideoInterlaceNone,              
    kFBVideoInterlaceHalfFrameEven,     
    kFBVideoInterlaceHalfFrameOdd,      
    kFBVideoInterlaceFullFrameEven,     
    kFBVideoInterlaceFullFrameOdd       
};

enum FBVideoFormat

Search for all occurrences

Video color modes.

Enumerator:

kFBVideoFormat_Any	Search for all occurrences
kFBVideoFormat_Other	Search for all occurrences
kFBVideoFormat_RGBA_32	Search for all occurrences
kFBVideoFormat_RGB_24	Search for all occurrences
kFBVideoFormat_BGRA_32	Search for all occurrences
kFBVideoFormat_BGR_24	Search for all occurrences
kFBVideoFormat_BGR_16	Search for all occurrences
kFBVideoFormat_ABGR_32	Search for all occurrences
kFBVideoFormat_ARGB_32	Search for all occurrences
kFBVideoFormat_422	Search for all occurrences

Definition at line 111 of file fbvideo.h.

                   {
    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
};

enum FBVideoLiveType

Search for all occurrences

Video Live type.

Enumerator:

kFBVideoLiveDefault	Generic video input, type not specified. Search for all occurrences
kFBVideoLiveBasic	Basic video input, like webcam and dv camera. Search for all occurrences

Definition at line 274 of file fbvideo.h.

                     { 
    kFBVideoLiveDefault,    
    kFBVideoLiveBasic       
};

enum FBClipEnd

Search for all occurrences

Clip end actions.

Enumerator:

kFBClipEndEnd	On clip end stop clip. Search for all occurrences
kFBClipEndLoop	On clip end loop clip. Search for all occurrences

Definition at line 364 of file fbvideo.h.

               { 
    kFBClipEndEnd,  
    kFBClipEndLoop  
};

enum FBPlayMode

Search for all occurrences

Play modes.

Enumerator:

kFBPlayModeNoPlay	No play (most common). Search for all occurrences
kFBPlayModePreviewToEnd	Preview clip until end. Search for all occurrences
kFBPlayModePlay	Play clip. Search for all occurrences
kFBPlayModeLoop	Loop clip. Search for all occurrences
kFBPlayModePlayToEnd	Play clip to end. Search for all occurrences

Definition at line 369 of file fbvideo.h.

                { 
    kFBPlayModeNoPlay,          
    kFBPlayModePreviewToEnd,    
    kFBPlayModePlay,            
    kFBPlayModeLoop,            
    kFBPlayModePlayToEnd        
};

---

Function Documentation

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		Video
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		VideoIn
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		VideoOut
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		VideoClip
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		VideoClipImage
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		VideoSwitcher
	)

Search for all occurrences

__FB_FORWARD

(

FBVideo

)

Search for all occurrences

__FB_FORWARD

(

FBVideoClip

)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		VideoProxyMode
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		VideoStorageMode
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		VideoInterlaceMode
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		VideoFormat
	)

Search for all occurrences

__FB_FORWARD

(

FBVideoClipImage

)

Search for all occurrences

__FB_FORWARD

(

FBVideoMemory

)

Search for all occurrences

__FB_FORWARD

(

FBVideoIn

)

Search for all occurrences

__FB_FORWARD

(

FBVideoOut

)

Search for all occurrences

__FB_FORWARD

(

FBVideoSwitcher

)

Search for all occurrences

__FB_FORWARD

(

FBEventVideoSwitcher

)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		ClipEnd
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		PlayMode
	)

Search for all occurrences