LEAP Documentation 40220
Documentation for the LEAP project
AMusicPlayer Class Reference

#include <MusicPlayer.h>

Inheritance diagram for AMusicPlayer:

Public Member Functions

 AMusicPlayer ()
 
void Play (const FTrackPlayInfo &Track)
 
void Stop (float FadeOutTime=1.0f)
 
void Resume (float FadeInTime=1.0f)
 
void SetTrackList (const TArray< FTrackPlayInfo > &ListOfTracks, bool bShuffleTracks=true, bool bPlayTrack=true, bool bWaitForTrackToCompleteBeforeSwitching=true)
 
void PlayNextTrack ()
 
FString GetCurrentTrackInfo () const
 

Static Public Member Functions

static AMusicPlayerGetMusicPlayer (const UObject *WorldContextObject)
 

Protected Member Functions

virtual void BeginPlay () override
 
virtual void Tick (float DeltaSeconds) override
 
virtual void EndPlay (const EEndPlayReason::Type EndPlayReason) override
 
void OnTrack1PlaybackPercentChanged (const class USoundWave *PlayingSoundWave, const float PlaybackPercent)
 
void OnTrack2PlaybackPercentChanged (const class USoundWave *PlayingSoundWave, const float PlaybackPercent)
 
float GetRemainingTimeForTrack (UAudioComponent *const AudioComponent) const
 
float GetCurrentPlayTimeForTrack (UAudioComponent *const AudioComponent) const
 
float GetDurationForTrack (UAudioComponent *const AudioComponent) const
 
UAudioComponent * GetInactiveAudioComponent () const
 
UAudioComponent * GetActiveAudioComponent () const
 

Protected Attributes

UAudioComponent * MusicTrack1 = nullptr
 
UAudioComponent * MusicTrack2 = nullptr
 
UAudioComponent * ActiveAudioComponent = nullptr
 
bool bShuffle = true
 
int32 CurrentTrackIndex = 0
 
TArray< FTrackPlayInfoTracklist
 
FTrackPlayInfo CurrentTrack
 
float Track1CurrentPlaybackTime = 0.0f
 
float Track1CurrentTrackLength = 0.0f
 
float Track2CurrentPlaybackTime = 0.0f
 
float Track2CurrentTrackLength = 0.0f
 

Static Protected Attributes

static TMap< UWorld *, AMusicPlayer * > Singleton
 

Constructor & Destructor Documentation

◆ AMusicPlayer()

AMusicPlayer::AMusicPlayer ( )

Member Function Documentation

◆ BeginPlay()

void AMusicPlayer::BeginPlay ( )
overrideprotectedvirtual

◆ EndPlay()

void AMusicPlayer::EndPlay ( const EEndPlayReason::Type  EndPlayReason)
overrideprotectedvirtual

◆ GetActiveAudioComponent()

UAudioComponent * AMusicPlayer::GetActiveAudioComponent ( ) const
protected

◆ GetCurrentPlayTimeForTrack()

float AMusicPlayer::GetCurrentPlayTimeForTrack ( UAudioComponent *const  AudioComponent) const
protected

◆ GetCurrentTrackInfo()

FString AMusicPlayer::GetCurrentTrackInfo ( ) const

◆ GetDurationForTrack()

float AMusicPlayer::GetDurationForTrack ( UAudioComponent *const  AudioComponent) const
protected

◆ GetInactiveAudioComponent()

UAudioComponent * AMusicPlayer::GetInactiveAudioComponent ( ) const
protected

◆ GetMusicPlayer()

AMusicPlayer * AMusicPlayer::GetMusicPlayer ( const UObject *  WorldContextObject)
static

◆ GetRemainingTimeForTrack()

float AMusicPlayer::GetRemainingTimeForTrack ( UAudioComponent *const  AudioComponent) const
protected

◆ OnTrack1PlaybackPercentChanged()

void AMusicPlayer::OnTrack1PlaybackPercentChanged ( const class USoundWave *  PlayingSoundWave,
const float  PlaybackPercent 
)
protected

◆ OnTrack2PlaybackPercentChanged()

void AMusicPlayer::OnTrack2PlaybackPercentChanged ( const class USoundWave *  PlayingSoundWave,
const float  PlaybackPercent 
)
protected

◆ Play()

void AMusicPlayer::Play ( const FTrackPlayInfo Track)

◆ PlayNextTrack()

void AMusicPlayer::PlayNextTrack ( )

◆ Resume()

void AMusicPlayer::Resume ( float  FadeInTime = 1.0f)

◆ SetTrackList()

void AMusicPlayer::SetTrackList ( const TArray< FTrackPlayInfo > &  ListOfTracks,
bool  bShuffleTracks = true,
bool  bPlayTrack = true,
bool  bWaitForTrackToCompleteBeforeSwitching = true 
)

◆ Stop()

void AMusicPlayer::Stop ( float  FadeOutTime = 1.0f)

◆ Tick()

void AMusicPlayer::Tick ( float  DeltaSeconds)
overrideprotectedvirtual

Member Data Documentation

◆ ActiveAudioComponent

UAudioComponent* AMusicPlayer::ActiveAudioComponent = nullptr
protected

◆ bShuffle

bool AMusicPlayer::bShuffle = true
protected

◆ CurrentTrack

FTrackPlayInfo AMusicPlayer::CurrentTrack
protected

◆ CurrentTrackIndex

int32 AMusicPlayer::CurrentTrackIndex = 0
protected

◆ MusicTrack1

UAudioComponent* AMusicPlayer::MusicTrack1 = nullptr
protected

◆ MusicTrack2

UAudioComponent* AMusicPlayer::MusicTrack2 = nullptr
protected

◆ Singleton

TMap< UWorld *, AMusicPlayer * > AMusicPlayer::Singleton
staticprotected

◆ Track1CurrentPlaybackTime

float AMusicPlayer::Track1CurrentPlaybackTime = 0.0f
protected

◆ Track1CurrentTrackLength

float AMusicPlayer::Track1CurrentTrackLength = 0.0f
protected

◆ Track2CurrentPlaybackTime

float AMusicPlayer::Track2CurrentPlaybackTime = 0.0f
protected

◆ Track2CurrentTrackLength

float AMusicPlayer::Track2CurrentTrackLength = 0.0f
protected

◆ Tracklist

TArray<FTrackPlayInfo> AMusicPlayer::Tracklist
protected

The documentation for this class was generated from the following files: