SGTL5000Class Class

SGTL5000Class Class

Description
Defines a class of SGTL5000Class.

Syntax
class SGTL5000Class

Members

Public Constructors 
SGTL5000Class::SGTL5000ClassConstructs a SGTL5000Class object
SGTL5000Class::~SGTL5000ClassDestructs a SGTL5000Class object
Public Methods 
SGTL5000Class::beginInitialize SGTL5000Class
SGTL5000Class::muteHeadphoneMute the headphone
SGTL5000Class::unmuteHeadphoneUnmute the headphone
SGTL5000Class::muteLineoutMute the line out
SGTL5000Class::unmuteLineoutUnmute the line out
SGTL5000Class::inputSelectSelect the input type
SGTL5000Class::setVolumeSet the volume
SGTL5000Class::micGainSet the gain of the MIC in dB

SGTL5000Class::begin

Description
Initialize SGTL5000Class.

Syntax
uint8_t SGTL5000Class::begin(void);

Parameters
The function requires no input parameter.

Returns
The function returns “0” indicates success to begin, otherwise failed.

Example Code
NA

Notes and Warnings
Include “AmebaSGTL5000.h” in order to use the class function.
 

SGTL5000Class::muteHeadphone

Description
Mute the headphone.

Syntax
uint8_t SGTL5000Class::muteHeadphone(void);

Parameters
The function requires no input parameter.

Returns
The function returns “0” indicates successfully muted the headphone, otherwise failed.

Example Code
NA

Notes and Warnings
Include “AmebaSGTL5000.h” in order to use the class function.
 

SGTL5000Class::unmuteHeadphone

Description
Unmute the headphone.

Syntax
uint8_t SGTL5000Class::unmuteHeadphone(void);

Parameters
The function requires no input parameter.

Returns
The function returns “0” indicates successfully unmuted the headphone, otherwise failed.

Example Code
NA

Notes and Warnings
Include “AmebaSGTL5000.h” in order to use the class function.
 

SGTL5000Class::muteLineout

Description
Mute the line out.

Syntax
uint8_t SGTL5000Class::muteLineout(void);

Parameters
The function requires no input parameter.

Returns
The function returns “0” indicates successfully muted lineout, otherwise failed.

Example Code
NA

Notes and Warnings
Include “AmebaSGTL5000.h” in order to use the class function.
 

SGTL5000Class::unmuteLineout

Description
Unmute the line out.

Syntax
uint8_t SGTL5000Class::unmuteLineout(void);

Parameters
The function requires no input parameter.

Returns
The function returns “0” indicates successfully unmuted lineout, otherwise failed.

Example Code
NA

Notes and Warnings
Include “AmebaSGTL5000.h” in order to use the class function.
 

SGTL5000Class::inputSelect

Description
Select the input type.

Syntax
uint8_t SGTL5000Class::inputSelect(uint8_t type);

Parameters
type: “0” input inline; “1” input MIC

Returns
The function returns “0” indicates successfully select the input type to either Inline or MIC, otherwise it failed.

Example Code
NA

Notes and Warnings
Include “AmebaSGTL5000.h” in order to use the class function.
 

SGTL5000Class::setVolume

Description
Set the volume.

Syntax
uint8_t SGTL5000Class::setVolume(float val);

Parameters
val: a float value indicates the volume. The range is of val is “0 < (val * 129 + 0.499) < 128”.

Returns
The function returns “0” indicates successfully set the volume, otherwise failed.

Example Code
NA

Notes and Warnings
Include “AmebaSGTL5000.h” in order to use the class function.
 

SGTL5000Class::micGain

Description
Set the gain of the MIC in dB.

Syntax
uint8_t SGTL5000Class::micGain(uint16_t dB);

Parameters
dB: The value of gain in dB.

Returns
The function returns “0” indicates successfully set the gain of MIC in dB, otherwise failed.

Example Code
NA

Notes and Warnings
Include “AmebaSGTL5000.h” in order to use the class function.

請先確認已安裝QQ通訊軟體