/*
 * Copyright 2009 Phil Burk, Mobileer Inc
 *
 * 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.
 */

package com.jsyn.unitgen;

import com.jsyn.ports.UnitInputPort;
import com.softsynth.shared.time.TimeStamp;

/**
 * Interface for unit generators that have an input.
 * 
 * @author Phil Burk, (C) 2009 Mobileer Inc
 */
public interface UnitSink {
    public UnitInputPort getInput();

    /**
     * Begin execution of this unit by the Synthesizer. The input will pull data from any output
     * port that is connected from it.
     */
    public void start();

    public void start(TimeStamp timeStamp);

    public void stop();

    public void stop(TimeStamp timeStamp);

    public UnitGenerator getUnitGenerator();
}