Functions |
Int32 | VIDANALYTICS_control (VIDANALYTICS_Handle handle, VIDANALYTICS_Cmd id, VIDANALYTICS_DynamicParams *params, VIDANALYTICS_Status *status) |
| Execute the control() method in this instance of a video analytics algorithm.
|
VIDANALYTICS_Handle | VIDANALYTICS_create (Engine_Handle e, String name, VIDANALYTICS_Params *params) |
| Create an instance of a video analytics algorithm.
|
Void | VIDANALYTICS_delete (VIDANALYTICS_Handle handle) |
| Delete the instance of a video analytics algorithm.
|
Int32 | VIDANALYTICS_process (VIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, VIDANALYTICS_InArgs *inArgs, VIDANALYTICS_OutArgs *outArgs) |
| Execute the process() method in this instance of a video analytics algorithm.
|
XDAS_Int32 | VIDANALYTICS_processAsync (VIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IVIDANALYTICS_InArgs *inArgs, IVIDANALYTICS_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a video analytics algorithm.
|
XDAS_Int32 | VIDANALYTICS_processWait (VIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IVIDANALYTICS_InArgs *inArgs, IVIDANALYTICS_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of VIDANALYTICS_processAsync() in this instance of an video analytics algorithm.
|
Detailed Description
This is the VIDANALYTICS video analytics interface. Several of the data types in this API are specified by the XDM IVIDANALYTICS interface; please see the XDM documentation for those details.
Macro Definition Documentation
Special value for timeout parameter indicating never timeout.
#define VIDANALYTICS_STUBSNAME "VIDANYLITIC_STUBS" |
Name of stub functions. Use this name when registering the VIDANALYTICS_STUBS functions with Engine_addStubFxns.
- See also:
- Engine_addStubFxns
#define VIDANALYTICS_VISATYPE "ti.sdo.ce.vidanalytics.IVIDANALYTICS" |
Typedef Documentation
Opaque handle to a VIDANALYTICS codec.
Defines the creation time parameters for all IVIDANALYTICS instance objects.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines the input arguments for all IVIDANALYTICS instance process function.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines the run time output arguments for all IVIDANALYTICS instance objects.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
This structure defines the algorithm parameters that can be modified after creation via control() calls.
@remarks It is not necessary that a given implementation support all
dynamic parameters to be configurable at run time. If a
particular algorithm does not support run-time updates to
a parameter that the application is attempting to change
at runtime, it may indicate this as an error.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines instance status parameters.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Function Documentation
Execute the control() method in this instance of a video analytics algorithm.
- Parameters:
-
[in] | handle | Handle to a created video analytics instance. |
[in] | id | Command id for XDM control operation. |
[in] | params | Runtime control parameters used for the video analytics instance. |
[out] | status | Status info returned by the video analytics instance. |
- Precondition:
handle
is a valid (non-NULL) video analytics handle and the video analytics instance is in the created state.
- Return values:
-
- See also:
- VIDANALYTICS_create()
-
VIDANALYTICS_delete()
-
IVIDANALYTICS_Fxns::control()
Create an instance of a video analytics algorithm.
Instance handles must not be concurrently accessed by multiple threads;
each thread must either obtain its own handle (via VIDANALYTICS_create()) or
explicitly serialize access to a shared handle.
@param[in] e Handle to an opened engine.
@param[in] name String identifier of the type of video analytics
algorithm to create.
@param[in] params Creation parameters.
@retval NULL An error has occurred.
@retval non-NULL The handle to the newly created video analytics
instance.
@remarks @c params is optional. If it's not supplied, codec-specific
default params will be used.
@remark Depending on the configuration of the engine opened, this
call may create a local or remote instance of the video
analytics algorithm.
@remarks In general, @c name is the name of the codec configured by the system integrator. However, an optional "argument string" may be appended to the codec name, to allow the codec's configured priority and/or the heaps where its memory will be allocated, to be overridden. This optional argument string is of the form <b>":priority"</b>, <b>":priority:flag"</b>, or <b>"::flag"</b>.
Delete the instance of a video analytics algorithm.
- Parameters:
-
[in] | handle | Handle to a created video analytics instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the VIDANALYTICS_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- VIDANALYTICS_create()