Open Reality Reference Guide
|
|
Go to the documentation of this file.
43 #include <kaydaradef.h>
48 #define FBSDK_DLL K_DLLIMPORT
54 #ifdef FBSDKUseNamespace
55 namespace FBSDKNamespace {
69 #define FBVideoDeclare( ClassName, Parent ) \
70 FBClassDeclare( ClassName,Parent ); \
72 ClassName(const char* pName):Parent(pName) { FBClassInit; } \
78 #define FBVideoImplementation( ThisComponent ) \
79 FBClassImplementation( ThisComponent )
113 kFBVideoFormat_Other,
114 kFBVideoFormat_RGBA_32,
115 kFBVideoFormat_RGB_24,
116 kFBVideoFormat_BGRA_32,
117 kFBVideoFormat_BGR_24,
118 kFBVideoFormat_BGR_16,
119 kFBVideoFormat_ABGR_32,
120 kFBVideoFormat_ARGB_32,
127 kFBVideo_RES_FULL = 0,
177 FBVideo(
const char* pName, HIObject pObject=NULL);
237 virtual void DrawImage(
int pX = 0,
int pY = 0,
int pW = -1,
int pH = -1,
int pFrame = -1);
479 virtual bool IsSDKSwitcher();
536 #ifdef FBSDKUseNamespace
FBVideoResolution
Video Resolution (1D)
@ kFBVideoInterlaceHalfFrameEven
Half frame (even field).
@ kFBPlayModePlayToEnd
Play clip to end.
virtual unsigned char * GetPowerOfTwoImage()
Get the current image buffer resized with width and height power of two.
FBVideoInterlaceMode
Video interlace modes.
@ kFBPlayModePlay
Play clip.
@ kFBVideoLiveBasic
Basic video input, like webcam and dv camera.
virtual void DrawImage(int pX=0, int pY=0, int pW=-1, int pH=-1, int pFrame=-1)
Draw a frame of the image to the current view.
@ kFBPlayModeNoPlay
No play (most common).
FBVideoOut(HIObject pObject=NULL)
Constructor.
virtual int LiveGetCompressor()
Get the current compressor index.
FBVideoSwitcher(const char *pName=NULL, HIObject pObject=NULL)
Constructor.
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
class K_DLLIMPORT FBPropertyBase< kReference, kFBPT_kReference > FBPropertykReference
Property: kReference
@ kFBVideoStorageDisk
Storage on disk.
FBPropertyClipEnd EndType
Read Only Property: Clip end action.
class K_DLLIMPORT FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
FBPropertykReference Reference
Read Only Property: Data.
@ kFBPlayModePreviewToEnd
Preview clip until end.
virtual const char * LiveGetCompressorName(int pCompressorIndex)
Get the compressor name at a particular index.
FBPropertyBool UsingSystemTime
Read Write Property: Using the system time?
FBPropertyTime TimeOffset
Read Write Property: Temporal offset for beginning of video.
FBPropertyBool UseSystemFrameRate
Read Write Property: Clip is using system frame rate?
A box is a fundamental building block in the application architecture.
virtual void PrepareNextFrame()
Prepare the next frame.
FBPropertyTime FrameTime
Read Only Property: Inverse of FPS, time per frame
FBPropertyInt CurrentFrame
Read Write Property: Current frame.
virtual void FinishCurrentVideo()
Finish the current video.
@ kFBVideoInterlaceNone
No interacling.
FBPropertyBool Online
Read Write Property: If true, the device is online and will output display.
FBPropertyBool KeepOnGPU
Read Write Property: Don't auto flush from GPU if true. session runtime flag, won't be saved.
virtual bool LiveSetCompressor(int pCompressorIndex)
Set the current compressor to be used when recording.
FBPropertyBool FreeRunning
Read Write Property: Is free Running on?
class K_DLLIMPORT FBPropertyBase< double, kFBPT_double > FBPropertyDouble
Property: double
FBPropertyString RelativePath
Read Only Property: Relative path of media.
@ kFBVideoInterlaceHalfFrameOdd
Half frame (odd field).
virtual void FBDelete() override
Open Reality deletion function.
FBPropertyInt PowerOfTwoHeight
Read Only Property: Closest power of two value superior to height of image.
FBPropertyInt Height
Read Only Property: Height of image.
FBVideoProxyMode
Video proxy modes.
bool IsValid()
Verifies the validity of the FBVideo object.
virtual void SetObjectImageSize(int pW, int pH)
Set image size to allow MoBu preview texture with proper dimension / aspect.
FBPropertyVideoInterlaceMode InterlaceMode
Read Write Property: Interlace mode.
FBPropertyBool Loop
Read Write Property: Loop video clip?
@ kFBClipEndEnd
On clip end stop clip.
@ kFBPlayModeLoop
Loop clip.
FBPropertyString FilePath
Read Write Property: Location of the generated movie file after a recording session.
FBPropertyInt CurrentFrame
Read Write Property: Current frame.
FBPropertyTime LastFrameTime
Read Only Property: Time of last frame
FBPropertyInt PowerOfTwoWidth
Read Only Property: Closest power of two value superior to width of image.
FBPropertyDouble PlaySpeed
Read Write Property: Playback speed.
FBPropertyInt StartFrame
Read Write Property: Frame to begin video playback from.
Video switcher callback event.
virtual void SetNextClip(FBVideo *pVideo, FBPlayMode pMode)
Set the next clip.
class K_DLLIMPORT FBPropertyBase< FBTime, kFBPT_Time > FBPropertyTime
Property: FBTime
#define __FBClassDeclare(Name, Parent)
For internal use only.
FBVideoMemory(const char *pName, HIObject pObject=NULL)
Constructor.
virtual void ResetVideoSwitcher()
Reset the video switcher (clear all clips).
FBPropertyPlayMode PlayMode
Read Write Property: Current play mode.
@ kFBVideoStorageDiskAsync
Storage on disk async access.
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
virtual void ImageIncUpdateID()
Increase Image update id after modification to trigger internal state refresh.
virtual void SwapCurrent(FBVideo *pVideo)
Swap the current video.
FBVideo(const char *pName, HIObject pObject=NULL)
Constructor.
virtual unsigned char * GetImage(int pFrame=-1)
Get the current image buffer.
FBPropertyBool Recording
Read Write Property: If true, the device will record during a recording session.
FBPropertyDevice DeviceOwner
Read Write Property: Hook onto owner device.
FBVideoIn(HIObject pObject=NULL)
Constructor.
FBVideoFormat
Video color modes.
FBPropertyTime TimeRemaining
Read Only Property: Time remaining.
virtual int LiveGetResolutionFR()
Get the current resolution and frame rate index.
int GetTextureID()
Get the texture ID.
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
FBPropertyVideoResolution MaxMipMapResolution
Read Write Property: Maximum MipMap resolution will be loaded into GPU.
virtual FBVideoLiveType LiveGetType()
Get the type of the video input device.
FBPropertyTime CurrentFrameTime
Read Write Property: Current time in clip.
FBPropertyBool ImageSequence
Read Write Property: Clip is an image sequence?
PropertyEvent: Base event class.
virtual int LiveGetCompressorCount()
Get the compressor count.
FBPropertyInt StopFrame
Read Write Property: Frame to end video playback at.
FBPropertyVideoFormat Format
Read Only Property: Video format.
virtual const char * LiveGetResolutionFRName(int pIndex)
Get the resolution and frame rate string description at the specified index.
FBPropertyString Filename
Read Write Property: Filename of media.
FBPropertyDouble FrameRate
Read Write Property: Frame rate.
@ kFBClipEndLoop
On clip end loop clip.
FBVideoClipImage(const char *pName, HIObject pObject=NULL)
Constructor.
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
FBPropertyBool Online
Read Write Property: If true, the device is online and will display the current video feed.
FBVideoIn * operator[](int pIndex)
Get the video at pIndex.
FBVideoMemory allow external media source (which can't be supported by MoBu natively)
@ kFBVideoProxyOnPlay
Video proxy on play.
FBPropertyVideoStorageMode StorageMode
Read Write Property: Storage mode.
FBVideoOut * operator[](int pIndex)
Get the video at pIndex.
FBVideoClip * operator[](int pIndex)
Get the video at pIndex.
FBPropertyEvent OnClipEnd
Event: Clip end event.
FBPropertyInt LastFrame
Read Only Property: Last frame in clip.
virtual void LiveSetResolutionFR(int pIndex)
Set the current resolution and frame rate for the device.
PropertyList: Concrete class for PropertyList of component
@ kFBVideoProxyAlways
Always video proxy.
FBClipEnd
Clip end actions.
Contains definitions for devices, boxes and models.
@ kFBVideoInterlaceFullFrameOdd
Full frame (odd field).
FBVideoClip(const char *pName, HIObject pObject=NULL)
Constructor.
@ kFBVideoProxyNone
No video proxy.
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
@ kFBVideoStorageMemory
Storage in memory.
@ kFBVideoLiveDefault
Generic video input, type not specified.
FBEventVideoSwitcher(HKEventBase pEvent)
Constructor.
FBVideoStorageMode
Video storage modes.
FBPropertyBool RecordAudio
Read Write Property: If true, the device will also record audio during a recording session.
FBPropertyVideoSwitcher VideoSwitcher
Read Only Property: Video switcher.
Property class: const char * (String).
@ kFBVideoInterlaceFullFrameEven
Full frame (even field).
FBPropertyTime CurrentFrameTimeCode
Read Only Property: Embedded timecode from current frame in clip. Use the method GetEmbeddedTimecode ...
FBPropertyInt TextureOGLId
Read Write Property: OpenGL texture buffer object id (GL_TEXTURE_2D type).
FBPropertyInt Width
Read Only Property: Width of image.
FBVideoLiveType
Video Live type.
FBPropertyVideo CurrentVideo
Read Only Property: Current video.
virtual bool GetEmbeddedTimecode(int pFrame, FBTimeCode &pTimeCode)
Get the embedded timecode associated to a video clip frame.
Basic video input class, supporting webcam and DV device.
FBPropertyVideoProxyMode ProxyMode
Read Write Property: Proxy mode.
virtual int LiveGetResolutionFRCount()
Get the number of resolution and frame rate available for the device.