ApiBuffer Class

Function

C++

static WMX3APIFUNC ErrorToString(int errCode, wchar_t *pString, unsigned int size);

Python

Returns

Type

Value

Remarks

Function

C++

static WMX3APIFUNC ApiLogToString(unsigned char *pLogData, unsigned int logDataSize, char *pString, unsigned int size);

Python

def ApiLogToString(pLogData, logDataSize)

Returns

Type

string

Value

API log string

Remarks

Function

C++

static WMX3APIFUNC ApiLogToString(unsigned char *pLogData, unsigned int logDataSize, wchar_t *pString, unsigned int size);

Python

Returns

Type

Value

Remarks

Function

C++

static WMX3APIFUNC GetLibVersion(int *pMajorVersion, int *pMinorVersion, int *pRevisionVersion, int *pFixVersion);

Python

def GetLibVersion()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - MajorVersion

  • 2 : int - MinorVersion

  • 3 : int - RevisionVersion

  • 4 : int - FixVersion

Remarks

Function

C++

bool IsDeviceValid();

Python

def IsDeviceValid()

Returns

Type

bool

Value

Whether the device is alive

Remarks

Function

C++

WMX3APIFUNC GetVersion(int *pMajorVersion, int *pMinorVersion, int *pRevisionVersion, int *pFixVersion);

Python

def GetVersion()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - MajorVersion

  • 2 : int - MinorVersion

  • 3 : int - RevisionVersion

  • 4 : int - FixVersion

Remarks

Function

C++

WMX3APIFUNC CreateApiBuffer(unsigned int channel, unsigned int size);

Python

def CreateApiBuffer(channel, size)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC CreateApiBuffer(unsigned int channel);

Python

def CreateApiBuffer(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC CreateApiBuffer(unsigned int channel, unsigned int size, SizeUnit::T sizeUnit);

Python

def CreateApiBuffer(channel, size, sizeUnit)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC FreeApiBuffer(unsigned int channel);

Python

def FreeApiBuffer(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC StartRecordBufferChannel(unsigned int channel);

Python

def StartRecordBufferChannel(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC EndRecordBufferChannel();

Python

def EndRecordBufferChannel()

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetRecordingBufferChannel(int* channel, unsigned char* enable);

Python

def GetRecordingBufferChannel()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - channel

  • 2 : int - enable

Remarks

Function

C++

WMX3APIFUNC Execute(unsigned int channel);

Python

def Execute(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Halt(unsigned int channel);

Python

def Halt(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Clear(unsigned int channel);

Python

def Clear(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Rewind(unsigned int channel);

Python

def Rewind(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetStatus(unsigned int channel, ApiBufferStatus* pStatus);

Python

def GetStatus(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : ApiBufferStatus - status

Remarks

Function

C++

WMX3APIFUNC SetOptions(unsigned int channel, ApiBufferOptions *pOptions);

Python

def SetOptions(channel, pOptions)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetOptions(unsigned int channel, ApiBufferOptions *pOptions);

Python

def GetOptions(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : ApiBufferOptions - options

Remarks

Function

C++

WMX3APIFUNC SetWatch(unsigned int channel, ApiBufferWatch *pWatch);

Python

def SetWatch(channel, pWatch)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetWatch(unsigned int channel, ApiBufferWatch *pWatch);

Python

def GetWatch(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : ApiBufferWatch - watch

Remarks

Function

C++

WMX3APIFUNC Sleep(unsigned int milliseconds);

Python

def Sleep(milliseconds)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Wait(int axis);

Python

def Wait(int axis)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Wait(AxisSelection *pAxisSelection);

Python

def Wait_AxisSel(pAxisSelection)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Wait(ApiBufferCondition* condition);

Python

def Wait_ApiBufferCondition(condition)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC FlowIf(ApiBufferCondition* condition, ApiBufferCondition* wait = NULL);

Python

  • def FlowIf(condition)

  • def FlowIf(condition, wait)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC FlowElseIf(ApiBufferCondition* condition);

Python

def FlowElseIf(condition)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC FlowElse();

Python

def FlowElse()

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC FlowEndIf();

Python

def FlowEndIf()

Returns

Type

int

Value

error code

Remarks

Function

C++

int GetOutputModuleId();

Python

def GetOutputModuleId()

Returns

Type

int

Value

ID of the module

Remarks

このPythonメソッドは予約されており、PythonAPIでは未サポートです。

Function

C++

WMX3APIFUNC GetOutputData(unsigned char* buff, int buffSize, int* dataSize);

Python

def GetOutputData(buff, buffSize, dataSize)

Returns

Type

int

Value

error code

Remarks

このPythonメソッドは予約されており、PythonAPIでは未サポートです。

Function

C++

WMX3APIFUNC SetOutputData(int moduleId, unsigned char* data, int dataSize);

Python

def SetOutputData(moduleId, data, dataSize)

Returns

Type

int

Value

error code

Remarks

このPythonメソッドは予約されており、PythonAPIでは未サポートです。