AXGetAuxReturnVolume

Syntax

#include <cafe/ax.h>
    
AXPB_ERROR_CODE AXGetAuxReturnVolume(AXPBDeviceType device,
                                     u32 Id, u32 auxId, u16 *volume);

Parameters

device Output device.
Id Device instance.
auxId Aux bus.
volume Retrieved volume value.

Return Values

Zero if successful, an error of type AXPB_ERROR_CODE otherwise.

The retrieved master volume value for the specified output device is returned by the parameter volume.

Description

Retrieves the return volume value for Aux bus auxId for the output device specified by device and Id.

NOTE:
The returned value is a 16-bit fixed point number, where the high-order bit represents the integer portion and the lower 15-bits comprise the fractional component.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AX Data Structures and Definitions
AX Aux Effects Overview
AXSetAuxReturnVolume

Revision History

2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup Pass.
2012/01/26 Update to Audio API v2.0.
2011/02/21 Initial Version


CONFIDENTIAL