Merge pull request o3de#17534 from Porcupine-Factory/feature/miniaudio-pause-play

MiniAudio: Add a pause method for the Playback component

Author: AMZN-alexpete

Gems/MiniAudio/Code/Include/MiniAudio/MiniAudioPlaybackBus.h

@@ -22,6 +22,7 @@ namespace MiniAudio
 
         virtual void Play() = 0;
         virtual void Stop() = 0;
+        virtual void Pause() = 0;
         virtual void SetLooping(bool loop) = 0;
         virtual bool IsLooping() const = 0;
         virtual void SetSoundAsset(AZ::Data::Asset<SoundAsset> soundAsset) = 0;

Gems/MiniAudio/Code/Source/Clients/MiniAudioPlaybackComponent.cpp

@@ -85,6 +85,7 @@ namespace MiniAudio
                 ->Attribute(AZ::Script::Attributes::Category, "MiniAudio Playback")
                 ->Event("Play", &MiniAudioPlaybackRequests::Play)
                 ->Event("Stop", &MiniAudioPlaybackRequests::Stop)
+                ->Event("Pause", &MiniAudioPlaybackRequests::Pause)
                 ->Event("SetLooping", &MiniAudioPlaybackRequests::SetLooping)
                 ->Event("IsLooping", &MiniAudioPlaybackRequests::IsLooping)
                 ->Event("GetSoundAsset", &MiniAudioPlaybackRequests::GetSoundAssetRef)

Gems/MiniAudio/Code/Source/Clients/MiniAudioPlaybackComponentController.cpp

@@ -85,12 +85,20 @@ namespace MiniAudio
     {
         if (m_sound)
         {
-            ma_sound_seek_to_pcm_frame(m_sound.get(), 0);
             ma_sound_start(m_sound.get());
         }
     }
 
     void MiniAudioPlaybackComponentController::Stop()
+    {
+        if (m_sound)
+        {
+            ma_sound_stop(m_sound.get());
+            ma_sound_seek_to_pcm_frame(m_sound.get(), 0);
+        }
+    }
+
+    void MiniAudioPlaybackComponentController::Pause()
     {
         if (m_sound)
         {
@@ -100,7 +108,7 @@ namespace MiniAudio
 
     float MiniAudioPlaybackComponentController::GetVolumePercentage() const
     {
-        return ma_sound_get_volume(m_sound.get());
+        return ma_sound_get_volume(m_sound.get()) * 100.f;
     }
 
     void MiniAudioPlaybackComponentController::SetVolumePercentage(float volume)

Gems/MiniAudio/Code/Source/Clients/MiniAudioPlaybackComponentController.h

@@ -45,6 +45,7 @@ namespace MiniAudio
         // MiniAudioPlaybackRequestBus
         void Play() override;
         void Stop() override;
+        void Pause() override;
         void SetVolumePercentage(float volume) override;
         float GetVolumePercentage() const override;
         void SetVolumeDecibels(float volumeDecibels) override;

Gems/MiniAudio/Code/Source/Tools/EditorMiniAudioPlaybackComponent.cpp

@@ -44,7 +44,12 @@ namespace MiniAudio
                     ->UIElement(AZ::Edit::UIHandlers::Button, "Stop Sound", "Stops playing the sound")
                     ->Attribute(AZ::Edit::Attributes::NameLabelOverride, "")
                     ->Attribute(AZ::Edit::Attributes::ButtonText, "Stop Sound")
-                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, &EditorMiniAudioPlaybackComponent::StopSoundInEditor);
+                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, &EditorMiniAudioPlaybackComponent::StopSoundInEditor)
+
+                    ->UIElement(AZ::Edit::UIHandlers::Button, "Pause Sound", "Pause playing the sound")
+                    ->Attribute(AZ::Edit::Attributes::NameLabelOverride, "")
+                    ->Attribute(AZ::Edit::Attributes::ButtonText, "Pause Sound")
+                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, &EditorMiniAudioPlaybackComponent::PauseSoundInEditor);
 
                 editContext->Class<MiniAudioPlaybackComponentController>("MiniAudioPlaybackComponentController", "")
                     ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
@@ -186,7 +191,6 @@ namespace MiniAudio
 
     AZ::Crc32 EditorMiniAudioPlaybackComponent::PlaySoundInEditor()
     {
-        m_controller.Stop();
         m_controller.Play();
         return AZ::Edit::PropertyRefreshLevels::None;
     }
@@ -197,6 +201,12 @@ namespace MiniAudio
         return AZ::Edit::PropertyRefreshLevels::None;
     }
 
+    AZ::Crc32 EditorMiniAudioPlaybackComponent::PauseSoundInEditor()
+    {
+        m_controller.Pause();
+        return AZ::Edit::PropertyRefreshLevels::None;
+    }
+
     AZ::Crc32 EditorMiniAudioPlaybackComponent::OnVolumeChanged()
     {
         m_controller.SetVolumePercentage(m_controller.GetConfiguration().m_volume / 100.f);

Gems/MiniAudio/Code/Source/Tools/EditorMiniAudioPlaybackComponent.h

@@ -37,6 +37,7 @@ namespace MiniAudio
 
         AZ::Crc32 PlaySoundInEditor();
         AZ::Crc32 StopSoundInEditor();
+        AZ::Crc32 PauseSoundInEditor();
         AZ::Crc32 OnVolumeChanged();
     };