IPodEQPreset Class Reference

A class representing an EQ Preset on the iPod. More...

#include <ipod_cpp.h>

List of all members.

Public Member Functions
	IPodEQPreset (IPod &ipod)
	Constructor, creates a new, empty EQ Preset on the iPod.
	~IPodEQPreset ()
	Destructor, does not delete the EQ Preset.
void	Remove (void)
	Removes the EQ Preset from the iPod.
std::string	GetText (int tag)
	Retrieves a text attribute from the EQ Preset.
void	SetText (int tag, std::string s)
	Sets a text attribute for the EQ Preset.
bool	HasText (int tag)
	Indicates whether the EQ Preset currently has a particular string.
int32_t	GetAttribute (int tag)
	Return a numerical attribute for the EQ Preset.
void	SetAttribute (int tag, int32_t value)
	Set the value of an attribute for the EQ Preset.
Friends
class	IPod

---

Detailed Description

A class representing an EQ Preset on the iPod.

---

Member Function Documentation

std::string IPodEQPreset::GetText

(

int

tag

)

Retrieves a text attribute from the EQ Preset.

Parameters:

tag

an identifier for the string to be retrieved, only IPOD_TITLE currently supported

Returns:

the text of the string in the current encoding

   cout << "Preset name is " << preset.GetText(IPOD_TITLE) << endl;

void IPodEQPreset::SetText	(	int	tag,
		std::string	s
	)

Sets a text attribute for the EQ Preset.

Parameters:

	tag	an identifier for the string to be modified or added, only IPOD_TITLE currently supported
	s	the string to be assigned in the current encoding

   std:string title = "Boom Box";
   preset.SetText(IPOD_TITLE,title);

bool IPodEQPreset::HasText

(

int

tag

)

Indicates whether the EQ Preset currently has a particular string.

Parameters:

tag

an identifier for the string being queried, true only for IPOD_TITLE

Returns:

a boolean indicating whether or not the string item exists in the preset

int32_t IPodEQPreset::GetAttribute

(

int

tag

)

Return a numerical attribute for the EQ Preset.

Parameters:

tag

an identifier for the attribute to be retrieved

Returns:

the current value for the attribute

  cout << "Preamp is " << preset.GetAttribute(IPOD_EQ_PRESET_PREAMP) << endl;

void IPodEQPreset::SetAttribute	(	int	tag,
		int32_t	value
	)

Set the value of an attribute for the EQ Preset.

Parameters:

	tag	an identifier for the attribute to be modified
	value	the new value for the attribute

   preset.SetAttribute(IPOD_EQ_PRESET,100);

---

The documentation for this class was generated from the following file:

• include/ipod/ipod_cpp.h

---