Texas Instruments DM6467, User Manual

Page: 70 / 78

API Reference
4-34
4.3.3 Control API
Control API is used for controlling the functioning of the algorithm instance
during run-time. This is done by changing the status of the controllable
parameters of the algorithm during run-time. These controllable parameters
are defined in the
IVIDENC1_DynamicParams
data structure (see Data
Structures section for details).
║ Name
control()
– change run-time parameters and query the status
║ Synopsis
XDAS_Int32 (*control) (IVIDENC1_Handle handle,
IVIDENC1_Cmd id, IVIDENC1_DynamicParams *params,
IVIDENC1_Status *status);
║
Arguments
IVIDENC1_Handle handle; /* algorithm instance handle */
IVIDENC1_Cmd id; /* algorithm specific control commands*/
IVIDENC1_DynamicParams *params;
/*
algorithm run-time
parameters */
IVIDENC1_Status *status;
/*
algorithm instance status
parameters */
║
Return Value
IALG_EOK; /* status indicating success */
IALG_EFAIL; /* status indicating failure */
║ Description
This function changes the run-time parameters of an algorithm instance
and queries the algorithm
status. control()
must only be called after a
successful call
to algInit()
and must never be called after a call
to
algFree()
.
The first argument to
control()
is a handle to an algorithm instance.
The second argument is an algorithm specific control command. See
XDM_CmdId
enumeration for details.
The third and fourth arguments are pointers to the
IVIDENC1_DynamicParams
and
IVIDENC1_Status
data structures
respectively.
Note :
‰ If the third and the fourth arguments point to the base data structure
of
DynamicParams
and
status,
then the basic parameters are
used.
‰
If the third and the fourth arguments point to the extended data
structure of
DynamicParams
and
status,
then the extended
parameters are used.