AR Filter API plug-in functions

Use the following information to implement the ARFilterApiCall function in AR System Filter plug-ins:

AR Filter API data structure

The AR System Filter API uses the same data structures that the AR System C API uses.

For more information about AR System C API data structures, see Data-structures.

ARFilterApiCall

Description

The plug-in server calls this function when it receives filter API Set Fields action data or input values from the AR System server during workflow operations.

To be thread-safe, your plug-in must protect any global information or resources accessed here with appropriate mutual exclusion locks.

Important

You must implement this function in all filter API plug-ins.

Synopsis

#include "arfilterapi.h"

int ARFilterApiCall(
  void *object,
  ARValueList *inValues,
  ARValueList *outValues,
  ARStatusList *status)

Input arguments

object

Pointer to the plug-in instance that the call to ARPluginCreateInstance returned.

inValues

Array of input values that the filter action specifies.

Developer Studio defines the filter action and the type of data that the AR System server must pass to the AR System Filter API plug-in.

Return arguments

outValues

Array of output values that the plug-in creator defines.

status

List of zero or more notes, warnings, or errors generated from a call made to this function.

The AR System server passes the status results to the corresponding filter or escalation.

For a description of all possible values, see Error-checking.