HOM/HOM_audio.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_audio_h__
#define __HOM_audio_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_EnumValue.h"
#include "HOM_EnumModules.h"
#include "HOM_Errors.h"

SWIGOUT(%rename(audio) HOM_audio;)
class HOM_API HOM_audio
{
public:
    virtual ~HOM_audio()
    {}

    virtual std::string __repr__() throw(HOM_Error) = 0;

    // switching the audio panel mode
    virtual void turnOffAudio()
        throw(HOM_Error) = 0;
    virtual void useTimeLineMode()
        throw(HOM_Error) = 0;
    virtual void useTimeSliceMode()
        throw(HOM_Error) = 0;
    virtual void useTestMode()
        throw(HOM_Error) = 0;

    // controlls common to all modes
    virtual void setMono( bool on )
        throw(HOM_Error) = 0;
    virtual void setVolumeTied( bool on )
        throw(HOM_Error) = 0;
    virtual void setMeter( bool on )
        throw(HOM_Error) = 0;
    virtual void setLeftVolume( float volume )
        throw(HOM_Error) = 0;
    virtual void setRightVolume( float volume )
        throw(HOM_Error) = 0;

    // switching between playing a CHOP or a file 
    virtual void useChops()
        throw(HOM_Error) = 0;
    virtual void useAudioFile()
        throw(HOM_Error) = 0;

    // setting the chop playback parameters
    virtual void setChopPath(const char *node_path)
        throw(HOM_TypeError, HOM_Error) = 0;
    
    // setting the file playback parameters
    virtual void setAudioFileName(const char *file_name)
        throw(HOM_TypeError, HOM_Error) = 0;
    virtual void setAudioOffset( float time_offset )
        throw(HOM_Error) = 0;
    virtual void setAudioFrame( float frame )
        throw(HOM_Error) = 0;

    // parameters specific to time line mode (scrub)
    virtual void setScrubRepeat( bool on )
        throw(HOM_Error) = 0;
    virtual void setScrubSustain( float sustain )
        throw(HOM_Error) = 0;
    virtual void setScrubRate( float scrub_rate )
        throw(HOM_Error) = 0;

    // parameters specific to test mode 
    virtual void reverse()
        throw(HOM_Error) = 0;
    virtual void stop()
        throw(HOM_Error) = 0;
    virtual void play()
        throw(HOM_Error) = 0;
    virtual void setLooping( bool on )
        throw(HOM_Error) = 0;
    virtual void setRewind( bool on )
        throw(HOM_Error) = 0;
};

#endif

---