File ChannelInstance.h¶

// Copyright (c) 2026-present Sparky Studios. All rights reserved.
//
// 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.

#pragma once

#ifndef _AM_CORE_PLAYBACK_CHANNEL_INSTANCE_H
#define _AM_CORE_PLAYBACK_CHANNEL_INSTANCE_H

#include <SparkyStudios/Audio/Amplitude/Core/Common.h>
#include <SparkyStudios/Audio/Amplitude/Core/Room.h>

namespace SparkyStudios::Audio::Amplitude
{
    class ChannelInstanceInternalState;

    enum eChannelInstanceMode : AmUInt8
    {
        eChannelInstanceMode_Blended = 0,

        eChannelInstanceMode_Separate = 1,
    };

    class AM_API_PUBLIC ChannelInstance
    {
    public:
        ChannelInstance();

        explicit ChannelInstance(ChannelInstanceInternalState* state);

        void Clear();

        [[nodiscard]] bool Valid() const;

        [[nodiscard]] AmChannelInstanceID GetId() const;

        [[nodiscard]] const AmVector3& GetLocation() const;

        void SetLocation(const AmVector3& location) const;

        [[nodiscard]] Room GetRoom() const;

        void SetRoom(const Room& room) const;

        [[nodiscard]] AmReal32 GetWeight() const;

        void SetWeight(AmReal32 weight) const;

        [[nodiscard]] ChannelInstanceInternalState* GetState() const;

    private:
        ChannelInstanceInternalState* _state;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_CORE_PLAYBACK_CHANNEL_INSTANCE_H