ISoundMixer.java

////////////////////////////////////////////////////////////////////////////////
// Copyright 2013 Michael Schmalle - Teoti Graphix, LLC
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0 
// 
// Unless required by applicable law or agreed to in writing, software 
// distributed under the License is distributed on an "AS IS" BASIS, 
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and 
// limitations under the License
// 
// Author: Michael Schmalle, Principal Architect
// mschmalle at teotigraphix dot com
////////////////////////////////////////////////////////////////////////////////

package com.teotigraphix.caustk.sound;

import com.teotigraphix.caustk.controller.IControllerComponent;
import com.teotigraphix.caustk.core.IRestore;
import com.teotigraphix.caustk.sound.SoundMixer.MixerInput;
import com.teotigraphix.caustk.tone.Tone;

public interface ISoundMixer extends IControllerComponent, IRestore {

    MasterMixer getMasterMixer();

    SoundMixerChannel getChannel(Tone tone);

    SoundMixerChannel getChannel(int index);

    /**
     * @see #executeSetValue(int, MixerInput, Number)
     */
    public static final String COMMAND_SET_VALUE = "sound_mixer/set_value";

    /**
     * Executes the {@link #COMMAND_SET_VALUE} command.
     * 
     * @param toneIndex The tone target's index.
     * @param input The {@link MixerInput} value that will be set.
     * @param value The value of the input's adjustment.
     */
    void executeSetValue(int toneIndex, MixerInput input, Number value);

    String serialize();

}