ObjectFrameGet Method (MWriterClass)

Gets the current frame from any source object.

Syntax

Public Overridable Sub ObjectFrameGet( _
   ByRef _ppFrame As MFrame, _
   ByVal _bsParam As String _
)

public virtual void ObjectFrameGet( 
   out MFrame _ppFrame,
   string _bsParam
)

public procedure ObjectFrameGet( 
   Out  _ppFrame: MFrame;
    _bsParam: String
); virtual;

public: virtual void ObjectFrameGet( 
   [PARAMFLAG::Out] MFrame* _ppFrame,
   BSTR* _bsParam
)

Parameters

_ppFrame

output frame object

_bsParam

additional parameters:

make_local - "true" to convert frame to ARGB32 format (by default, for other formats you should set pixel_format parameter); "false" to left the current format
pixel_format - format for frame conversion (ARGB32/YVYU/HDYC)

Example

Here is example of how to get frame from Live source object:

Dim myFrame As MFrame
myLive.ObjectFrameGet(myFrame, "")

MFrame myFrame;
myLive.ObjectFrameGet(out myFrame, "");

var
myObject: IMObject;
myFrame: MFrame;
begin
myObject := myLive as IMObject;
myObject.ObjectFrameGet(myFrame, '');
end;