IMFrame

Operates a single frame

Methods

FrameAudioGetBytes

Gets the audio plain data pointer (only local).

Syntax

void FrameAudioGetBytes( 
   out int _pcbSize,
   out long _ppbAudio
)

Parameters

_pcbSize - size of data
_ppbAudio - audio data pointer

FrameAudioSaveToFile

Saves the audio to file (*.wav format is used). If file already exists then it adds audio to the end of the file.

Syntax

void FrameAudioSaveToFile( 
   string _bsFileName,
   int _bAppend
)

Parameters

_bsFileName - full name of file to save audio
_bAppend - indicates whether audio is added to the file or not (create a new file)

FrameAVPropsGet

Gets the media properties of frame.

Syntax

void FrameAVPropsGet( 
   out M_AV_PROPS _pProps
)

Parameters

_pProps - media properties

FrameAVPropsSet

Sets the media properties to frame.

Syntax

void FrameAVPropsSet( 
   ref M_AV_PROPS _pProps
)

Parameters

_pProps - media properties

FrameClone

Gets clone of the video frame

Syntax

void FrameClone( 
   out MFrame _ppCloneFrame,
   eMFrameClone _eCloneType,
   eMFCC _fccPixelFormat
)

Parameters

_ppCloneFrame - output frame clone
_eCloneType - type of clone
_fccPixelFormat - output pixel format

FrameConvert

Converts frame format or just scale video frame.

Syntax

void FrameConvert( 
   ref M_VID_PROPS _pVidPropsDest,
   out MFrame _ppFrameRes,
   string _bsPropsList
)

Parameters

_pVidPropsDest - video properties
_ppFrameRes - output frame object
_bsPropsList - additional properties

FrameCut

Cuts out part of video frame, without memory copy.

Syntax

void FrameCut( 
   int _nField,
   ref tagRECT _pRect,
   out MFrame _ppFrameRes
)

Parameters

_nField - number of fields for cutting (for interlacing)
_pRect - rectangular part of source frame
_ppFrameRes - output frame object

FrameDataGet

Gets the ancillary data by its code.

Syntax

void FrameDataGet( 
   int _nDataFCC,
   out int _pcbANCData,
   out long _ppbANCData
)

Parameters

_nDataFCC - four chars code
_pcbANCData - ancillary data
_ppbANCData - ancillary data pointer

FrameDataGetByIndex

Gets the ancillary data by number in M_ANC_DATA structure.

Syntax

void FrameDataGetByIndex( 
   int _nIndex,
   out int _pnDataFCC,
   out int _pcbANCData,
   out long _ppbANCData
)

Parameters

_nIndex - number in M_ANC_DATA structure
_pnDataFCC - four chars code
_pcbANCData - ancillary data
_ppbANCData - ancillary data pointer

FrameDataSet

Sets the ancillary data by its four chars code.

Syntax

void FrameDataSet( 
   int _nDataFCC,
   int _cbANCData,
   long _pbANCData
)

Parameters

_nDataFCC - four chars code
_cbANCData - ancillary data
_pbANCData - ancillary data pointer

FrameOverlay

Overlay (mix) two frames with alpha, the position is from top-left corner, for 4:2:2 images (e.g. UYVY) horz position aligned by two (e.g. 21->20). Note: For ARGB32 images, alpha from images used for mix.

Syntax

void FrameOverlay( 
   MFrame _pFrameOver,
   int _nPosX,
   int _nPosY,
   double _dblAlpha,
   string _bsPropsList
)

Parameters

_pFrameOver - frame that overlays the source frame
_nPosX - X position of frame
_nPosY - Y position of frame
_dblAlpha - transparency: 0.0 - transparent (no mix), 1.0 - solid
_bsPropsList - additional properties

FrameRelease

Release frame buffer. Note: do it for ALL frames received by event in .Net application!

Syntax

void FrameRelease()

FrameTimeGet

Gets the frame time.

Syntax

void FrameTimeGet( 
   out M_TIME _pTime
)

Parameters

_pTime - frame time

FrameTimeSet

Sets the frame time.

Syntax

void FrameTimeSet( 
   ref M_TIME _pTime
)

Parameters

_pTime - frame time

FrameVideoGetBytes

Gets the video plain data pointer (only local).

Syntax

void FrameVideoGetBytes( 
   out int _pcbSize,
   out long _ppbVideo
)

Parameters

_pcbSize - data size
_ppbVideo - video data pointer

FrameVideoGetHbitmap

Gets the video HBitmap (bitmap handle).

Note: the returned bitmap should be free via WinAPI ::DeleteObject() call

Syntax

void FrameVideoGetHbitmap( 
   out long _pcpHBitmap
)

Parameters

_pcpHBitmap - bitmap handle

FrameVideoSaveToFile

Saves the video frame to file. Method supports *.png, *.jpg, *.bmp, *.tga, *.tiff files.

Syntax

void FrameVideoSaveToFile( 
   string _bsFileName
)

Parameters

_bsFileName - full name of file