IAUDENC1 - Audio Encoder Interface

Data Structures
struct	IAUDENC1_Obj
	This must be the first field of all IAUDENC1 instance objects. More...
struct	IAUDENC1_Params
	Defines the creation time parameters for all IAUDENC1 instance objects. More...
struct	IAUDENC1_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls. More...
struct	IAUDENC1_InArgs
	Defines the input arguments for all IAUDENC1 instance process function. More...
struct	IAUDENC1_Status
	Defines instance status parameters (read-only). More...
struct	IAUDENC1_OutArgs
	Defines the run time output arguments for all IAUDENC1 instance objects. More...
struct	IAUDENC1_Fxns
	Defines all of the operations on IAUDENC1 objects. More...

Macros
#define	IAUDENC1_EOK   XDM_EOK
#define	IAUDENC1_EFAIL   XDM_EFAIL
#define	IAUDENC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Typedefs
typedef struct IAUDENC1_Obj	IAUDENC1_Obj
	This must be the first field of all IAUDENC1 instance objects.
typedef struct IAUDENC1_Obj *	IAUDENC1_Handle
	Opaque handle to an IAUDENC1 objects.
typedef struct IAUDENC1_Params	IAUDENC1_Params
	Defines the creation time parameters for all IAUDENC1 instance objects.
typedef struct IAUDENC1_DynamicParams	IAUDENC1_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls.
typedef struct IAUDENC1_InArgs	IAUDENC1_InArgs
	Defines the input arguments for all IAUDENC1 instance process function.
typedef struct IAUDENC1_Status	IAUDENC1_Status
	Defines instance status parameters (read-only).
typedef struct IAUDENC1_OutArgs	IAUDENC1_OutArgs
	Defines the run time output arguments for all IAUDENC1 instance objects.
typedef IALG_Cmd	IAUDENC1_Cmd
	Defines the control commands for the IAUDENC1 module.
typedef struct IAUDENC1_Fxns	IAUDENC1_Fxns
	Defines all of the operations on IAUDENC1 objects.

---

Detailed Description

This is the XDM IAUDENC1 Audio Encoder Interface.

---

Macro Definition Documentation

#define IAUDENC1_EOK   XDM_EOK

Success.

#define IAUDENC1_EFAIL   XDM_EFAIL

General failure.

#define IAUDENC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

---

Typedef Documentation

typedef struct IAUDENC1_Obj IAUDENC1_Obj

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

typedef struct IAUDENC1_Obj* IAUDENC1_Handle

Opaque handle to an IAUDENC1 objects.

typedef struct IAUDENC1_Params IAUDENC1_Params

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

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 IAUDENC1_DynamicParams IAUDENC1_DynamicParams

This structure defines the algorithm parameters that can be modified after creation via control() calls.

Remarks:

It is not necessary that 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.

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 size parameter.

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.

See also:

IAUDENC1_Fxns::control()

typedef struct IAUDENC1_InArgs IAUDENC1_InArgs

Defines the input arguments for all IAUDENC1 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 size parameter.

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.

See also:

IAUDENC1_Fxns::process()

typedef struct IAUDENC1_Status IAUDENC1_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 size parameter.

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.

See also:

IAUDENC1_Fxns::control()

typedef struct IAUDENC1_OutArgs IAUDENC1_OutArgs

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

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.

See also:

IAUDENC1_Fxns::process()

typedef IALG_Cmd IAUDENC1_Cmd

Defines the control commands for the IAUDENC1 module.

Remarks:

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

See also:

XDM_CmdId

IAUDENC1_Fxns::control()

typedef struct IAUDENC1_Fxns IAUDENC1_Fxns

Defines all of the operations on IAUDENC1 objects.