OpenRCT2/src/openrct2/audio/AudioChannel.h

71 lines
2.3 KiB
C
Raw Normal View History

/*****************************************************************************
2020-07-21 15:04:34 +02:00
* Copyright (c) 2014-2020 OpenRCT2 developers
*
* For a complete list of all authors, please refer to contributors.md
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
*
* OpenRCT2 is licensed under the GNU General Public License version 3.
*****************************************************************************/
#pragma once
#include "../common.h"
#include "AudioMixer.h"
2018-02-16 00:43:16 +01:00
namespace OpenRCT2::Audio
{
struct IAudioSource;
2017-03-28 20:58:15 +02:00
/**
* Represents an audio channel that represents an audio source
* and a number of properties such as volume, pan and loop information.
*/
struct IAudioChannel
2017-03-28 20:58:15 +02:00
{
virtual ~IAudioChannel() = default;
2018-06-22 22:57:16 +02:00
virtual IAudioSource* GetSource() const abstract;
virtual MixerGroup GetGroup() const abstract;
virtual void SetGroup(MixerGroup group) abstract;
2018-06-22 22:57:16 +02:00
virtual double GetRate() const abstract;
virtual void SetRate(double rate) abstract;
2018-06-22 22:57:16 +02:00
virtual uint64_t GetOffset() const abstract;
virtual bool SetOffset(uint64_t offset) abstract;
2018-06-22 22:57:16 +02:00
virtual int32_t GetLoop() const abstract;
virtual void SetLoop(int32_t value) abstract;
2018-06-22 22:57:16 +02:00
virtual int32_t GetVolume() const abstract;
virtual float GetVolumeL() const abstract;
virtual float GetVolumeR() const abstract;
virtual float GetOldVolumeL() const abstract;
virtual float GetOldVolumeR() const abstract;
virtual int32_t GetOldVolume() const abstract;
virtual void SetVolume(int32_t volume) abstract;
2018-06-22 22:57:16 +02:00
virtual float GetPan() const abstract;
virtual void SetPan(float pan) abstract;
2017-03-28 20:58:15 +02:00
virtual bool IsStopping() const abstract;
virtual void SetStopping(bool value) abstract;
2017-03-28 20:58:15 +02:00
virtual bool IsDone() const abstract;
virtual void SetDone(bool value) abstract;
2017-03-28 20:58:15 +02:00
virtual bool DeleteOnDone() const abstract;
virtual void SetDeleteOnDone(bool value) abstract;
2017-03-28 20:58:15 +02:00
virtual void SetDeleteSourceOnDone(bool value) abstract;
2017-03-28 20:58:15 +02:00
virtual bool IsPlaying() const abstract;
virtual void Play(IAudioSource* source, int32_t loop = 0) abstract;
2017-03-28 20:58:15 +02:00
virtual void UpdateOldVolume() abstract;
2018-06-22 22:57:16 +02:00
virtual size_t Read(void* dst, size_t len) abstract;
2017-03-28 20:58:15 +02:00
};
2018-05-04 22:40:09 +02:00
} // namespace OpenRCT2::Audio