Overload  1.1
Game engine with editor
Public Member Functions | List of all members
OvAudio::Core::AudioPlayer Class Reference

#include <AudioPlayer.h>

Public Member Functions

 AudioPlayer (AudioEngine &p_audioEngine)
 
std::unique_ptr< Tracking::SoundTrackerPlaySound (const Resources::Sound &p_sound, bool p_autoPlay=true, bool p_looped=false, bool p_track=false)
 
std::unique_ptr< Tracking::SoundTrackerPlaySpatialSound (const Resources::Sound &p_sound, bool p_autoPlay=true, bool p_looped=false, const OvMaths::FVector3 &p_position={0.0f, 0.0f, 0.0f}, bool p_track=false)
 

Detailed Description

Handle sounds playback

Constructor & Destructor Documentation

◆ AudioPlayer()

OvAudio::Core::AudioPlayer::AudioPlayer ( AudioEngine p_audioEngine)

Constructor

Parameters
p_audioEngine@project: Overload
Author
: Overload Tech. @restrictions: This software may not be resold, redistributed or otherwise conveyed to a third party.

Member Function Documentation

◆ PlaySound()

std::unique_ptr< OvAudio::Tracking::SoundTracker > OvAudio::Core::AudioPlayer::PlaySound ( const Resources::Sound p_sound,
bool  p_autoPlay = true,
bool  p_looped = false,
bool  p_track = false 
)

Play a sound in 2D and return a SoundTracker if tracking is asked

Parameters
p_sound
p_autoPlay
p_looped
p_track

◆ PlaySpatialSound()

std::unique_ptr< OvAudio::Tracking::SoundTracker > OvAudio::Core::AudioPlayer::PlaySpatialSound ( const Resources::Sound p_sound,
bool  p_autoPlay = true,
bool  p_looped = false,
const OvMaths::FVector3 p_position = {0.0f, 0.0f, 0.0f},
bool  p_track = false 
)

Play a sound in 3D and return a SoundTracker if tracking is asked

Parameters
p_sound
p_autoPlay
p_looped
p_position
p_track

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