ngIEqualizerPresetProvider.idl

Go to the documentation of this file.

/*
//
// BEGIN NIGHTINGALE GPL
//
// This file is part of the Nightingale web player.
//
// http://getnightingale.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END NIGHTINGALE GPL
//
*/

#include "nsISupports.idl"

interface nsIArray;
interface ngIEqualizerPreset;

[scriptable, uuid(cfb2690d-659c-462a-ac8f-c4eef7c536de)]
interface ngIEqualizerPresetProvider : nsISupports
{
    readonly attribute nsIArray presets;
};


[scriptable, uuid(ed4cde10-746d-4cc9-9da4-7421543f711f)]
interface ngIEqualizerPresetCollection : nsISupports
{
    ngIEqualizerPreset getPresetByName(in AString aName);

    PRBool hasPresetNamed(in AString aName);
};

[scriptable, uuid(24e07f0f-8715-4768-a2fc-6ef171f4aabd)]
interface ngIMainEqualizerPresetProvider : ngIEqualizerPresetProvider
{
    void deletePreset(in AString aName);

    void savePreset(in AString aName, in nsIArray aValues);
};

%{C++
#define NG_EQUALIZER_PRESET_SAVE_TOPIC "equalizer-preset-saved"
#define NG_EQUALIZER_PRESET_DELETE_TOPIC "equalizer-preset-deleted"
%}

[scriptable, uuid(28fd6696-89ac-4895-8a62-27039473d98d)]
interface ngIEqualizerPresetProviderManager : nsISupports
{
    readonly attribute nsIArray providers;

    readonly attribute nsIArray presets;

    void registerPresetProvider(in ngIEqualizerPresetProvider aNewProvider);

    void unregisterPresetProvider(in ngIEqualizerPresetProvider aProvider);
};

%{C++
#define NG_EQUALIZER_PRESETS_CHANGED_TOPIC "equalizer-presets-changed"
%}