CE interface SPI
|
VISA_Handle | VISA_create (Engine_Handle engine, String name, IALG_Params *params, size_t msgSize, String type) |
| Create a new instance of an algorithm.
|
Void | VISA_delete (VISA_Handle visa) |
| Delete an instance of an algorithm.
|
VISA_Handle | VISA_create2 (Engine_Handle engine, String name, IALG_Params *params, Int paramsSize, size_t msgSize, String type) |
| Create a new instance of an algorithm.
|
Void | VISA_enter (VISA_Handle visa) |
| Enter an algorithm's critical section. This must be called before any of the algorithm's IALG_Fxns are invoked.
|
Void | VISA_exit (VISA_Handle visa) |
| Leave an algorithm's critical section. This must be called after the API has completed calling an algorithm's IALG_Fxns.
|
Ptr | VISA_getAlgHandle (VISA_Handle visa) |
| Obtains an algorithm's handle. This is the handle required to be passed to the algorithm's IALG_Fxns.
|
Ptr | VISA_getAlgorithmHandle (VISA_Handle visa) |
| Obtains an algorithm's handle. If the algorithm is local, this is the handle that can be passed to Algorithm APIs, not to the IALG_Fxns.
|
IALG_Fxns * | VISA_getAlgFxns (VISA_Handle visa) |
| Get implementation functions for this algorithm.
|
Detailed Description
Codec Engine System Programming Interface (SPI) for class interface implementors.
Function Documentation
Create a new instance of an algorithm.
- Parameters:
-
[in] | engine | Handle to an engine in which the algorithm has been configured. |
[in] | name | Name of the algorithm to create. name is specified in the engine configuration. |
[in] | params | Creation parameters. |
[in] | msgSize | Size of the message which will be allocated in the event that this algorithm is configured to run remotely. |
[in] | type | String name of the "type" of algorithm. |
- Return values:
-
| NULL | General failure. |
| non-NULL | Handle to an algorithm instance. |
- See also:
- VISA_delete()
Delete an instance of an algorithm.
- Parameters:
-
[in] | visa | Handle to an algorithm instance to delete. |
- See also:
- VISA_create()
Create a new instance of an algorithm.
- Parameters:
-
[in] | engine | Handle to an engine in which the algorithm has been configured. |
[in] | name | Name of the algorithm to create. name is specified in the engine configuration. |
[in] | params | Creation parameters. |
[in] | paramsSize | Size of params . |
[in] | msgSize | Size of the message which will be allocated in the event that this algorithm is configured to run remotely. |
[in] | type | String name of the "type" of algorithm. |
- Return values:
-
| NULL | General failure. |
| non-NULL | Handle to an algorithm instance. |
- See also:
- VISA_create()
-
VISA_delete()
Enter an algorithm's critical section. This must be called before any of the algorithm's IALG_Fxns are invoked.
- Parameters:
-
[in] | visa | Handle to an algorithm instance. |
- See also:
- VISA_exit()
Leave an algorithm's critical section. This must be called after the API has completed calling an algorithm's IALG_Fxns.
- Parameters:
-
[in] | visa | Handle to an algorithm instance. |
- See also:
- VISA_enter()
Obtains an algorithm's handle. This is the handle required to be passed to the algorithm's IALG_Fxns.
- Parameters:
-
[in] | visa | Handle to an algorithm instance. |
- Return values:
-
| NULL | General system error |
| non-NULL | The remote algorithm's message. |
- See also:
- VISA_getAlgFxns()
Obtains an algorithm's handle. If the algorithm is local, this is the handle that can be passed to Algorithm APIs, not to the IALG_Fxns.
- Parameters:
-
[in] | visa | Handle to an algorithm instance. |
- Return values:
-
| NULL | General system error |
| non-NULL | The Algorithm handle. |
- See also:
- VISA_getAlgHandle()
Get implementation functions for this algorithm.
- Parameters:
-
[in] | visa | Handle to an algorithm instance. |
- Return values:
-
| NULL | An error has occurred. |
| non-NULL | The algorithm's IALG_Fxns. |
- See also:
- VISA_getAlgHandle()