Main Page | Directories | File List | Globals | Related Pages

QTWrapper.h File Reference

Declares an interface adapter for the Quicktime MacOSX SDK. More...

#include "VideoWrapperCommon/VideoWrapperTypes.h"
#include <sys/time.h>

Go to the source code of this file.

Functions

void DSWRAPPER_API DSDECLSPEC setPrintFunction (printfcn *function)
 Sets a callback function to be used for printing messages.
VWHCamera DSWRAPPER_API DSDECLSPEC initQTVideo (char *lpCmdLine)
 Intializes a video camera.
int DSWRAPPER_API DSDECLSPEC closeQTVideo (VWHCamera hCam)
 Close the video camera.
int DSWRAPPER_API DSDECLSPEC resetQTCamera (VWHCamera hCam, bool bAutomatic)
 Resets all the camera parameters to defaults.
int DSWRAPPER_API DSDECLSPEC showQTFilterPropertities (VWHCamera hCam)
 Pops up the properties screen associated with this device.
int DSWRAPPER_API DSDECLSPEC getQTFrame (VWHCamera hCam, unsigned char **ppbFrame, timeval *pTimestamp=NULL)
 Captures a video frame.
void DSWRAPPER_API DSDECLSPEC releaseQTFrame (VWHCamera hCam)
 Releases the frame so that the space can be freed.
double DSWRAPPER_API DSDECLSPEC getQTFrameRate (VWHCamera hCam)
 Gets the frame rate of the camera as frames per second.
int DSWRAPPER_API DSWRAPPER_API getQTVideoWidth (VWHCamera hCam)
 Gets the video width.
int DSWRAPPER_API DSWRAPPER_API getQTVideoHeight (VWHCamera hCam)
 Gets the video height.
int DSWRAPPER_API DSDECLSPEC getQTVideoPixelFormat (VWHCamera hCam)
 Gets the pixel format.
int DSWRAPPER_API DSDECLSPEC getQTOpenGLFormat (VWHCamera hCam)
 Gets the OpenGL format.
int DSWRAPPER_API DSDECLSPEC getQTVideoDepth (VWHCamera hCam)
 Gets color depth as bits ber pixel.


Detailed Description

Declares an interface adapter for the Quicktime MacOSX SDK.

For use by VideoWrapper.

See also:
VideoWrapper.h
Copyright 2004-5, Georgia Tech Research Corporation, Atlanta, Georgia 30332-0415 All Rights Reserved

Function Documentation

int DSWRAPPER_API DSDECLSPEC closeQTVideo VWHCamera  hCam  ) 
 

Close the video camera.

Parameters:
hCam Handle to video camera.
Returns:
0 if successful, 1 if failure.

int DSWRAPPER_API DSDECLSPEC getQTFrame VWHCamera  hCam,
unsigned char **  ppbFrame,
timeval *  pTimestamp = NULL
 

Captures a video frame.

Parameters:
hCam Handle to video camera.
[out] ppbFrame Pointer to captured video frame.
[out] pTimestamp Pointer to timestamp.
Returns:
0 if successful, 1 if failure.

double DSWRAPPER_API DSDECLSPEC getQTFrameRate VWHCamera  hCam  ) 
 

Gets the frame rate of the camera as frames per second.

Parameters:
hCam Handle to video camera.
Returns:
The frame rate of the camera.

int DSWRAPPER_API DSDECLSPEC getQTOpenGLFormat VWHCamera  hCam  ) 
 

Gets the OpenGL format.

Parameters:
hCam Handle to video camera.
Returns:
The OpenGL format.

int DSWRAPPER_API DSDECLSPEC getQTVideoDepth VWHCamera  hCam  ) 
 

Gets color depth as bits ber pixel.

Always returns 24.

Parameters:
hCam Handle to video camera.
Returns:
The color depth.

int DSWRAPPER_API DSWRAPPER_API getQTVideoHeight VWHCamera  hCam  ) 
 

Gets the video height.

Parameters:
hCam Handle to video camera.
Returns:
The video height.

int DSWRAPPER_API DSDECLSPEC getQTVideoPixelFormat VWHCamera  hCam  ) 
 

Gets the pixel format.

Parameters:
hCam Handle to video camera.
Returns:
An integer expressing pixel format.
See also:
pixelFormat.h

int DSWRAPPER_API DSWRAPPER_API getQTVideoWidth VWHCamera  hCam  ) 
 

Gets the video width.

Parameters:
hCam Handle to video camera.
Returns:
The video width.

VWHCamera DSWRAPPER_API DSDECLSPEC initQTVideo char *  lpCmdLine  ) 
 

Intializes a video camera.

Parameters:
[in] plCmdLine String used to configure the camera. Takes the form: "iCam size rate colorMode outputMode useBigger", where
  • iCam is number, representing the camera to choose from (starting at 0)
  • size is the desired width (currently, only 160, 320 or 640 allowed)
  • rate is the desired frame rate (IGNORED)
  • colorMode is a string. Specifies the format of the desired mode. Either yuv, rgb, grey8 or grey16 is allowed. Case insensitive. (IGNORED)
  • outputMode is a string, either rgb or bgr. (IGNORED)
  • useBigger is 0 or 1. 1 means a mode of 2x or 4x the size can be used, and scaled to the correct size. (IGNORED)
Returns:
A VWHCamera (> 0) if successful, 0 if not.

void DSWRAPPER_API DSDECLSPEC releaseQTFrame VWHCamera  hCam  ) 
 

Releases the frame so that the space can be freed.

Parameters:
hCam Handle to video camera.

int DSWRAPPER_API DSDECLSPEC resetQTCamera VWHCamera  hCam,
bool  automatic
 

Resets all the camera parameters to defaults.

Parameters:
automatic If true, allow the camera to auto-adust
Returns:
0 if successful

void DSWRAPPER_API DSDECLSPEC setPrintFunction printfcn *  function  ) 
 

Sets a callback function to be used for printing messages.

Parameters:
function: ptr to print function

int DSWRAPPER_API DSDECLSPEC showQTFilterPropertities VWHCamera  hCam  ) 
 

Pops up the properties screen associated with this device.

Returns:
0 if successful


Generated on Tue Oct 18 12:18:51 2005 for VideoWrapper API by  doxygen 1.4.1