iTunes COM Interface: IITEQPreset Interface Reference

iTunes COM

previous page next page
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

IITEQPreset Interface Reference

List of all members.

Detailed Description

Represents an equalizer preset.

You can retrieve or set the currently selected EQ preset using the IiTunes::CurrentEQPreset property.

Public Member Functions

Properties
HRESULT Name ([out, retval] BSTR *name)
 Returns the name of the the EQ preset (e.g. "Acoustic").
HRESULT Modifiable ([out, retval] VARIANT_BOOL *isModifiable)
 Returns true if the EQ preset can be modified.
Preamp and Band Properties
HRESULT Preamp ([out, retval] double *level)
 Returns the equalizer preamp level (-12.0 db to +12.0 db).
HRESULT Preamp ([in] double level)
 Set the equalizer preamp level (-12.0 db to +12.0 db).
HRESULT Band1 ([out, retval] double *level)
 Returns the equalizer 32Hz band level (-12.0 db to +12.0 db).
HRESULT Band1 ([in] double level)
 Set the equalizer 32Hz band level (-12.0 db to +12.0 db).
HRESULT Band2 ([out, retval] double *level)
 Returns the equalizer 64Hz band level (-12.0 db to +12.0 db).
HRESULT Band2 ([in] double level)
 Set the equalizer 64Hz band level (-12.0 db to +12.0 db).
HRESULT Band3 ([out, retval] double *level)
 Returns the equalizer 125Hz band level (-12.0 db to +12.0 db).
HRESULT Band3 ([in] double level)
 Set the equalizer 125Hz band level (-12.0 db to +12.0 db).
HRESULT Band4 ([out, retval] double *level)
 Returns the equalizer 250Hz band level (-12.0 db to +12.0 db).
HRESULT Band4 ([in] double level)
 Set the equalizer 250Hz band level (-12.0 db to +12.0 db).
HRESULT Band5 ([out, retval] double *level)
 Returns the equalizer 500Hz band level (-12.0 db to +12.0 db).
HRESULT Band5 ([in] double level)
 Set the equalizer 500Hz band level (-12.0 db to +12.0 db).
HRESULT Band6 ([out, retval] double *level)
 Returns the equalizer 1KHz band level (-12.0 db to +12.0 db).
HRESULT Band6 ([in] double level)
 Set the equalizer 1KHz band level (-12.0 db to +12.0 db).
HRESULT Band7 ([out, retval] double *level)
 Returns the equalizer 2KHz band level (-12.0 db to +12.0 db).
HRESULT Band7 ([in] double level)
 Set the equalizer 2KHz band level (-12.0 db to +12.0 db).
HRESULT Band8 ([out, retval] double *level)
 Returns the equalizer 4KHz band level (-12.0 db to +12.0 db).
HRESULT Band8 ([in] double level)
 Set the equalizer 4KHz band level (-12.0 db to +12.0 db).
HRESULT Band9 ([out, retval] double *level)
 Returns the equalizer 8KHz band level (-12.0 db to +12.0 db).
HRESULT Band9 ([in] double level)
 Set the equalizer 8KHz band level (-12.0 db to +12.0 db).
HRESULT Band10 ([out, retval] double *level)
 Returns the equalizer 16KHz band level (-12.0 db to +12.0 db).
HRESULT Band10 ([in] double level)
 Set the equalizer 16KHz band level (-12.0 db to +12.0 db).
Methods
HRESULT Delete ([in] VARIANT_BOOL updateAllTracks)
 Delete this EQ preset.
HRESULT Rename ([in] BSTR newName,[in] VARIANT_BOOL updateAllTracks)
 Rename this EQ preset.

Member Function Documentation

HRESULT IITEQPreset::Band1 (  [in] double  level  ) 
 

Set the equalizer 32Hz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 32Hz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band1 (  [out, retval] double *  level  ) 
 

Returns the equalizer 32Hz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 32Hz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band10 (  [in] double  level  ) 
 

Set the equalizer 16KHz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 8KHz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band10 (  [out, retval] double *  level  ) 
 

Returns the equalizer 16KHz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 8KHz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band2 (  [in] double  level  ) 
 

Set the equalizer 64Hz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 64Hz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band2 (  [out, retval] double *  level  ) 
 

Returns the equalizer 64Hz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 64Hz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band3 (  [in] double  level  ) 
 

Set the equalizer 125Hz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 125Hz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band3 (  [out, retval] double *  level  ) 
 

Returns the equalizer 125Hz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 125Hz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band4 (  [in] double  level  ) 
 

Set the equalizer 250Hz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 250Hz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band4 (  [out, retval] double *  level  ) 
 

Returns the equalizer 250Hz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 250Hz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band5 (  [in] double  level  ) 
 

Set the equalizer 500Hz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 500Hz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band5 (  [out, retval] double *  level  ) 
 

Returns the equalizer 500Hz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 500Hz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band6 (  [in] double  level  ) 
 

Set the equalizer 1KHz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 1KHz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band6 (  [out, retval] double *  level  ) 
 

Returns the equalizer 1KHz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 1KHz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band7 (  [in] double  level  ) 
 

Set the equalizer 2KHz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 2KHz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band7 (  [out, retval] double *  level  ) 
 

Returns the equalizer 2KHz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 2KHz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band8 (  [in] double  level  ) 
 

Set the equalizer 4KHz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 4KHz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band8 (  [out, retval] double *  level  ) 
 

Returns the equalizer 4KHz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 4KHz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band9 (  [in] double  level  ) 
 

Set the equalizer 8KHz band level (-12.0 db to +12.0 db).

Parameters:
level The equalizer 8KHz band level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Band9 (  [out, retval] double *  level  ) 
 

Returns the equalizer 8KHz band level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer 8KHz band level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Delete (  [in] VARIANT_BOOL  updateAllTracks  ) 
 

Delete this EQ preset.

Any EQ preset can be deleted, including built-in presets, except for the Manual preset.

Note:
This method is available in iTunes 4.7 and later (iTunes type library 1.2 and later).
Parameters:
updateAllTracks If true, any tracks that use this EQ preset will be set to have no assigned EQ preset.
Return values:
S_OK The operation was successful.
ITUNES_E_OBJECTDELETED This EQ preset has been deleted already.
ITUNES_E_OBJECTLOCKED This is the Manual EQ preset, which cannot be deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Modifiable (  [out, retval] VARIANT_BOOL *  isModifiable  ) 
 

Returns true if the EQ preset can be modified.

Prior to iTunes 4.7, only the Manual preset was modifiable. As of iTunes 4.7 and later (iTunes type library 1.2 and later), all presets can be modified. In other words, this property will always be true.

Parameters:
isModifiable Returns true if the EQ preset can be modified.
Return values:
S_OK The operation was successful.
E_POINTER isModifiable is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Name (  [out, retval] BSTR *  name  ) 
 

Returns the name of the the EQ preset (e.g. "Acoustic").

Parameters:
name Returns the name of the the EQ preset (e.g. "Acoustic").
Return values:
S_OK The operation was successful.
E_POINTER name is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Preamp (  [in] double  level  ) 
 

Set the equalizer preamp level (-12.0 db to +12.0 db).

Parameters:
level The equalizer preamp level (-12.0 db to +12.0 db).
If level is outside the range -12.0 to +12.0, it will be pinned.

Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Preamp (  [out, retval] double *  level  ) 
 

Returns the equalizer preamp level (-12.0 db to +12.0 db).

Parameters:
level Returns the equalizer preamp level (-12.0 db to +12.0 db).
Return values:
S_OK The operation was successful.
E_POINTER level is NULL.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

HRESULT IITEQPreset::Rename (  [in] BSTR  newName,
[in] VARIANT_BOOL  updateAllTracks
) 
 

Rename this EQ preset.

The name of any EQ preset can be changed, including built-in presets, except for the Manual preset.

EQ preset names cannot start with leading spaces. If you specify a name that starts with leading spaces they will be stripped out.

Note:
This method is available in iTunes 4.7 and later (iTunes type library 1.2 and later).
Parameters:
newName The new name of the EQ preset.
updateAllTracks If true, any tracks that use this EQ preset will be updated with the new preset name.
Return values:
S_OK The operation was successful.
E_POINTER newName is NULL.
E_INVALIDARG newName is empty.
ITUNES_E_OBJECTEXISTS An EQ preset with this name already exists.
ITUNES_E_OBJECTLOCKED This is the Manual EQ preset, which cannot be renamed.
ITUNES_E_OBJECTDELETED The EQ preset has been deleted.
E_FAIL An unexpected error occurred.

Generated on Fri Mar 13 12:50:54 2009 for iTunes 8.1.0.52
©2004-2007 Apple Computer, Inc.

previous page start next page