AXGetDeviceFinalOutput

Syntax

#include <cafe.h>

AXPB_ERROR_CODE AXGetDeviceFinalOutput(AXPBDeviceType device,
				s16 *dataPtr,
				u32 const size,
				AXDEVICEFINALOUTPUTSTRUCT *axDeviceFinalOutputStruct);

Parameters

device Output device.
dataPtr Pointer to the user provided array where final output is copied to.
size Size of the array pointed by dataPtr in bytes.
axDeviceFinalOutputStruct Pointer to the user provided AXDEVICEFINALOUTPUTSTRUCT where the info is copied to.

Return Values

Zero if successful, an error of type AXPB_ERROR_CODE otherwise.

Description

If the size of the array that is provided by the user is large enough, this function copies the final output samples that are being pumped. AXDEVICEFINALOUTPUTSTRUCT provides information about the output format, number of samples, sample frequency, etc. for the output samples that are being copied.

The size of the buffer should be at least 1728 bytes (6 channels *144 samples/frame *2 bytes/sample) for TV and at least 576 bytes (2 channels *144 samples/frame *2 bytes/sample). In the future, a function will be provided that gets the minimum size of the buffer for copying the samples.

When the output mode for the device is set to:

NOTE:
Currently, only TV and DRC are supported.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

Revision History

2013/07/20 Added information about how the mode settings for a device effect the output.
2013/05/08 Automated cleanup pass.
2012/10/26 added minimum size requirements on the buffer being provided
2012/08/01 Cleanup Pass.
2011/02/21 Initial version.


CONFIDENTIAL