File Bus.h¶

// Copyright (c) 2021-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_BUS_H
#define _AM_CORE_PLAYBACK_BUS_H

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

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

    class AM_API_PUBLIC Bus
    {
    public:
        Bus();

        explicit Bus(BusInternalState* state);

        void Clear();

        [[nodiscard]] bool Valid() const;

        [[nodiscard]] AmBusID GetId() const;

        [[nodiscard]] const AmString& GetName() const;

        void SetGain(AmReal32 gain) const;

        [[nodiscard]] AmReal32 GetGain() const;

        void FadeTo(AmReal32 gain, AmTime duration) const;

        [[nodiscard]] AmReal32 GetFinalGain() const;

        void SetMute(bool mute) const;

        [[nodiscard]] bool IsMuted() const;

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

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

#endif // _AM_CORE_PLAYBACK_BUS_H