IAUDDEC_Fxns Struct Reference
[XDM IAUDDEC Audio Decoder Interface]

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

#include <iauddec.h>

Collaboration diagram for IAUDDEC_Fxns:

Data Fields
IALG_Fxns	ialg
XDAS_Int32(*	process )(IAUDDEC_Handle handle, XDM_BufDesc inBufs, XDM_BufDesc outBufs, IAUDDEC_InArgs inArgs, IAUDDEC_OutArgs outArgs)
	Basic audio decoding call.
XDAS_Int32(*	control )(IAUDDEC_Handle handle, IAUDDEC_Cmd id, IAUDDEC_DynamicParams params, IAUDDEC_Status status)
	Control behaviour of an algorithm.

Detailed Description

Defines all of the operations on IAUDDEC objects.

XDAIS algorithm interface.

Basic audio decoding call.

Parameters:

`[in]`	handle	Handle to an algorithm instance.
`[in]`	inBufs	Input buffer descriptors.
`[in,out]`	outBufs	Output buffer descriptors. The algorithm may modify the output buffer pointers.
`[in]`	inArgs	Input arguments. This is a required parameter.
`[out]`	outArgs	Ouput 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 IAUDDEC_InArgs structure.; outArgs must not be NULL, and must point to a valid IAUDDEC_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_EOK	Success.
	IALG_EFAIL	Failure. See IAUDDEC_OutArgs::extendedError for more detailed further error conditions.

Control behaviour of an algorithm.

Parameters:

`[in]`	handle	Handle to an algorithm instance.
`[in]`	id	Command id. See XDM_CmdId.
`[in]`	params	Dynamic parameters. This is a required parameter.
`[out]`	status	Output 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 IAUDDEC_DynamicParams structure.; status must not be NULL, and must point to a valid IAUDDEC_Status structure.

Postcondition:: The algorithm must not modify the contents of params. That is, the data pointed to by this parameter must be treated as read-only.

Return values:

	IALG_EOK	Success.
	IALG_EFAIL	Failure. See IAUDDEC_Status::extendedError for more detailed further error conditions.

The documentation for this struct was generated from the following file: