ik_ISoundSource.h

Go to the documentation of this file.

// Copyright (C) 2002-2014 Nikolaus Gebhardt
// This file is part of the "irrKlang" library.
// For conditions of distribution and use, see copyright notice in irrKlang.h

#ifndef __I_IRRKLANG_IRR_SOUND_SOURCE_H_INCLUDED__
#define __I_IRRKLANG_IRR_SOUND_SOURCE_H_INCLUDED__

#include "ik_IVirtualRefCounted.h"
#include "ik_vec3d.h"
#include "ik_EStreamModes.h"
#include "ik_SAudioStreamFormat.h"


namespace irrklang
{


    class ISoundSource : public IVirtualRefCounted
    {
    public:

        virtual const ik_c8* getName() = 0;


        virtual void setStreamMode(E_STREAM_MODE mode) = 0;


        virtual E_STREAM_MODE getStreamMode() = 0;


        virtual ik_u32 getPlayLength() = 0;


        virtual SAudioStreamFormat getAudioFormat() = 0;

        /* If a sound is seekable depends on the file type and the audio format. For example MOD files
        cannot be seeked currently.
        \return Returns true of the sound source supports setPlayPosition() and false if not. 
        Note: If the sound never has been played before, the sound engine will have to open
        the file and try to get the information from there, so this call could take a bit depending
        on the type of file. */
        virtual bool getIsSeekingSupported() = 0;