ISPHENC_Fxns Struct Reference
[XDM ISPHENC Speech/Voice Encoder Interface]

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

#include <isphenc.h>

Collaboration diagram for ISPHENC_Fxns:

[legend]

Data Fields
IALG_Fxns	ialg
XDAS_Int32(*	process )(ISPHENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, ISPHENC_InArgs *inArgs, ISPHENC_OutArgs *outArgs)
	Basic speech/voice encoding call.
XDAS_Int32(*	control )(ISPHENC_Handle handle, ISPHENC_Cmd id, ISPHENC_DynamicParams *params, ISPHENC_Status *status)
	Control behavior of an algorithm.

---

Detailed Description

Defines all of the operations on ISPHENC objects.

---

Field Documentation

IALG_Fxns ISPHENC_Fxns::ialg

XDAIS algorithm interface.

See also:

IALG_Fxns

XDAS_Int32(* ISPHENC_Fxns::process)(ISPHENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, ISPHENC_InArgs *inArgs, ISPHENC_OutArgs *outArgs)

Basic speech/voice encoding 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 ISPHENC_InArgs structure.

outArgs must not be NULL, and must point to a valid ISPHENC_OutArgs structure.

inBufs must not be NULL, and must point to a valid XDM_BufDesc structure.

inBufs.buf[0] must not be NULL, and must point to a valid buffer of data that is at least inBufs.bufSizes[0] bytes in length.

outBufs must not be NULL, and must point to a valid XDM_BufDesc structure.

outBufs.buf[0] must not be NULL, and must point to a valid buffer of data that is at least outBufs.bufSizes[0] bytes in length.

The buffers in inBufs and outBufs are physically contiguous and owned by the calling application.

Postcondition:

The algorithm must not modify the contents of inBufs. That is, the data and buffers pointed to by these parameters must be treated as read-only.

The buffers in inBufs and outBufs are owned by the calling application.

Return values:

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

XDAS_Int32(* ISPHENC_Fxns::control)(ISPHENC_Handle handle, ISPHENC_Cmd id, ISPHENC_DynamicParams *params, ISPHENC_Status *status)

Control behavior 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 ISPHENC_DynamicParams structure.

status must not be NULL, and must point to a valid ISPHENC_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 ISPHENC_Status::extendedError for more detailed further error conditions.

---

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

• isphenc.h