PMICSetEcReset

Syntax

#include <revolution/pmic.h>

// Echo Canceller Reset State
#define PMIC_EC_RESET_ON             0x0001
#define PMIC_EC_RESET_OFF            0x0000

PMIC_ERR PMICSetEcReset(u16 state);

Arguments

state Sets the reset state (ON/OFF) for the Wii Speak's echo canceler.

Return Values

Returns one of the following.

PMIC_ERR_OK The reset state was set successfully.
PMIC_ERR_INVALID_ARGUMENTS The correct argument was not passed.
PMIC_ERR_NO_DEVICE The Wii Speak has been unplugged.
PMIC_ERR_INVALID_STATE The Wii Speak is not open.
PMIC_ERR_BUSY Cannot register the command. Call the function again.
PMIC_ERR_USB_ERROR An error occurred in USB communications. Call the function again.
PMIC_ERR_FATAL A fatal error has occurred.

Description

Synchronously sets the reset state (ON/OFF) for the Wii Speak's echo canceler.

The echo canceler will be reset automatically if the PMICStart or PMICStartAsync function is called to start the Wii Speak, so you do not normally need to use this function.

However, the echo canceler will sometimes stop functioning properly if, for example, packets are lost and the other party's voice is interrupted during voice chat. At such times, use this function to reset the echo canceler. This allows you to return the echo canceler to a normal state without stopping the Wii Speak.

Call this function twice in the following order to reset the echo canceler.

(1) PMICSetEcReset(PMIC_EC_RESET_ON);
(2) PMICSetEcReset(PMIC_EC_RESET_OFF);

After the echo canceler is reset, it will take several seconds to begin having an effect on the echoes.

See Also

PMICStartAsync
PMICStart

Revision History

2008/10/24 Added to Return Values and Description.
2008/10/22 Initial version.


CONFIDENTIAL