XDAIS  dais-x04
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Fields
IAUDENC_Fxns Struct Reference

Defines all of the operations on IAUDENC objects. More...

#include <iaudenc.h>

Collaboration diagram for IAUDENC_Fxns:
Collaboration graph

Data Fields

IALG_Fxns ialg
XDAS_Int32(* process )(IAUDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IAUDENC_InArgs *inArgs, IAUDENC_OutArgs *outArgs)
 Basic audio encoding call.
XDAS_Int32(* control )(IAUDENC_Handle handle, IAUDENC_Cmd id, IAUDENC_DynamicParams *params, IAUDENC_Status *status)
 Control behaviour of an algorithm.

Detailed Description

Defines all of the operations on IAUDENC objects.


Field Documentation

IALG_Fxns IAUDENC_Fxns::ialg

XDAIS algorithm interface.

See also:
IALG_Fxns
XDAS_Int32(* IAUDENC_Fxns::process)(IAUDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IAUDENC_InArgs *inArgs, IAUDENC_OutArgs *outArgs)

Basic audio encoding call.

Parameters:
[in]handleHandle to an algorithm instance.
[in]inBufsInput buffer descriptors.
[in,out]outBufsOutput buffer descriptors. The algorithm may modify the output buffer pointers.
[in]inArgsInput arguments. This is a required parameter.
[out]outArgsOuput results. This is a required parameter.
Remarks:
process() is a blocking call. When process() returns, the algorithm's processing is complete.
Precondition:
handle must be a valid algorithm instance handle.
inArgs must not be NULL, and must point to a valid IAUDENC_InArgs structure.
outArgs must not be NULL, and must point to a valid IAUDENC_OutArgs structure.
inBufs must not be NULL, and must point to a valid XDM_BufDesc structure.
outBufs must not be NULL, and must point to a valid XDM_BufDesc structure.
The buffers in inBufs and outBufs are physically contiguous and owned by the calling application.
Postcondition:
The algorithm must not modify the contents of inArgs.
The buffers in inBufs and outBufs are owned by the calling application.
Return values:
IALG_EOKSuccess.
IALG_EFAILFailure. See IAUDENC_OutArgs::extendedError for more detailed further error conditions.
XDAS_Int32(* IAUDENC_Fxns::control)(IAUDENC_Handle handle, IAUDENC_Cmd id, IAUDENC_DynamicParams *params, IAUDENC_Status *status)

Control behaviour of an algorithm.

Parameters:
[in]handleHandle to an algorithm instance.
[in]idCommand id. See XDM_CmdId.
[in]paramsDynamic parameters. This is a required parameter.
[out]statusOutput results. This is a required parameter.
Precondition:
handle must be a valid algorithm instance handle.
params must not be NULL, and must point to a valid IAUDENC_DynamicParams structure.
status must not be NULL, and must point to a valid IAUDENC_Status structure.
Return values:
IALG_EOKSuccess.
IALG_EFAILFailure. See IAUDENC_Status::extendedError for more detailed further error conditions.

The documentation for this struct was generated from the following file:
Copyright 2013, Texas Instruments Incorporated