IAUDDEC1 - XDM Audio Decoder Interface

Data Structures
struct	IAUDDEC1_Obj
	This must be the first field of all IAUDDEC1 instance objects. More...
struct	IAUDDEC1_Params
	Defines the creation time parameters for all IAUDDEC1 instance objects. More...
struct	IAUDDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct	IAUDDEC1_InArgs
	Defines the input arguments for all IAUDDEC1 instance process function. More...
struct	IAUDDEC1_Status
	Defines instance status parameters (read-only). More...
struct	IAUDDEC1_OutArgs
	Defines the run time output arguments for all IAUDDEC1 instance objects. More...
struct	IAUDDEC1_Fxns
	Defines all of the operations on IAUDDEC1 objects. More...

Macros
#define	IAUDDEC1_EOK   XDM_EOK
#define	IAUDDEC1_EFAIL   XDM_EFAIL
#define	IAUDDEC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Typedefs
typedef struct IAUDDEC1_Obj	IAUDDEC1_Obj
	This must be the first field of all IAUDDEC1 instance objects.
typedef struct IAUDDEC1_Obj *	IAUDDEC1_Handle
	Opaque handle to an IAUDDEC1 objects.
typedef struct IAUDDEC1_Params	IAUDDEC1_Params
	Defines the creation time parameters for all IAUDDEC1 instance objects.
typedef struct IAUDDEC1_DynamicParams	IAUDDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IAUDDEC1_InArgs	IAUDDEC1_InArgs
	Defines the input arguments for all IAUDDEC1 instance process function.
typedef struct IAUDDEC1_Status	IAUDDEC1_Status
	Defines instance status parameters (read-only).
typedef struct IAUDDEC1_OutArgs	IAUDDEC1_OutArgs
	Defines the run time output arguments for all IAUDDEC1 instance objects.
typedef IALG_Cmd	IAUDDEC1_Cmd
	Defines the control commands for the IAUDDEC1 module.
typedef struct IAUDDEC1_Fxns	IAUDDEC1_Fxns
	Defines all of the operations on IAUDDEC1 objects.

---

Detailed Description

This is the XDM IAUDDEC1 Audio Decoder Interface.

---

Macro Definition Documentation

#define IAUDDEC1_EOK   XDM_EOK

Success.

#define IAUDDEC1_EFAIL   XDM_EFAIL

General failure.

#define IAUDDEC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

---

Typedef Documentation

typedef struct IAUDDEC1_Obj IAUDDEC1_Obj

This must be the first field of all IAUDDEC1 instance objects.

typedef struct IAUDDEC1_Obj* IAUDDEC1_Handle

Opaque handle to an IAUDDEC1 objects.

typedef struct IAUDDEC1_Params IAUDDEC1_Params

Defines the creation time parameters for all IAUDDEC1 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.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

typedef struct IAUDDEC1_DynamicParams IAUDDEC1_DynamicParams

This structure defines the codec 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.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IAUDDEC1_Fxns::control()

typedef struct IAUDDEC1_InArgs IAUDDEC1_InArgs

Defines the input arguments for all IAUDDEC1 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.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IAUDDEC1_Fxns::process()

typedef struct IAUDDEC1_Status IAUDDEC1_Status

Defines instance status parameters (read-only).

@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.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IAUDDEC1_Fxns::control()

typedef struct IAUDDEC1_OutArgs IAUDDEC1_OutArgs

Defines the run time output arguments for all IAUDDEC1 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.

Remarks:

The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

@sa         IAUDDEC1_Fxns::process()

typedef IALG_Cmd IAUDDEC1_Cmd

Defines the control commands for the IAUDDEC1 module.

Remarks:

This ID can be extended in IMOD interface for additional controls.

See also:

XDM_CmdId

IAUDDEC1_Fxns::control()

typedef struct IAUDDEC1_Fxns IAUDDEC1_Fxns

Defines all of the operations on IAUDDEC1 objects.