XAPO_PROCESS_BUFFER_PARAMETERS Structure

Defines stream buffer parameters that may change from one call to the next. Used with the Process method.

Syntax

typedef struct XAPO_PROCESS_BUFFER_PARAMETERS {
    void *pBuffer;
    XAPO_BUFFER_FLAGS BufferFlags;
    UINT32 ValidFrameCount;
} XAPO_PROCESS_BUFFER_PARAMETERS;  

Members

pBuffer
Pointer to a stream buffer that contains audio data. The buffer must be 16-byte aligned, non-NULL, and must be at least XAPO_LOCKFORPROCESS_BUFFER_PARAMETERS.MaxFrameCount frames in size.

BufferFlags
An XAPO_BUFFER_FLAGS enumeration describing the contents of the stream buffer.

ValidFrameCount
Number of frames to process; this value must be within the range 0 to XAPO_LOCKFORPROCESS_BUFFER_PARAMETERS.MaxFrameCount.

Remarks

Although the format and maximum size values of a particular stream buffer are constant, as defined by the XAPO_LOCKFORPROCESS_BUFFER_PARAMETERS structure, the actual memory address of the stream buffer is permitted to change. For constant-bit-rate (CBR) XAPOs, ValidFrameCount is constant and is always equal to the corresponding XAPO_LOCKFORPROCESS_BUFFER_PARAMETERS.MaxFrameCount for this buffer.

Note

Only constant-bit-rate XAPOs are currently supported.

Requirements

Header: Declared in xapo.h.

Library: Use xapobase.lib.