#include <BSSoundHandle.h>

Public Types
enum	: std::uint32_t { kInvalidID = static_cast<std::uint32_t>(-1) }

enum class	AssumedState { kInitialized = 0 , kPlaying = 1 , kStopped = 2 , kPaused = 3 }

enum class	LoopType { kNone = 0 , kWholeFile = 1 , kEnvFast = 2 , kEnvSlow = 3 }

Public Member Functions
	BSSoundHandle ()

	~BSSoundHandle ()=default

bool	FadeInPlay (std::uint16_t a_fadeTimeMS)

bool	FadeOutAndRelease (std::uint16_t a_fadeTimeMS)

std::uint64_t	GetDuration ()

bool	IsPlaying () const

bool	IsValid () const

bool	SetFrequency (float a_frequency)

bool	SetPosition (NiPoint3 a_pos)

void	SetObjectToFollow (NiAVObject *a_node)

void	SetOutputModel (const BSISoundOutputModel *a_outputModel)

bool	SetVolume (float a_volume)

bool	Stop ()

bool	Play ()

bool	Pause ()

Public Attributes
std::uint32_t	soundID

bool	assumeSuccess

std::uint8_t	pad05

std::uint16_t	pad06

REX::EnumSet< AssumedState, std::uint32_t >	state

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : std::uint32_t

Enumerator
kInvalidID

◆ AssumedState

enum class RE::BSSoundHandle::AssumedState

strong

Enumerator
kInitialized
kPlaying
kStopped
kPaused

◆ LoopType

enum class RE::BSSoundHandle::LoopType

strong

Enumerator
kNone
kWholeFile
kEnvFast
kEnvSlow

Constructor & Destructor Documentation

◆ BSSoundHandle()

RE::BSSoundHandle::BSSoundHandle ( )

◆ ~BSSoundHandle()

RE::BSSoundHandle::~BSSoundHandle ( )

default

Member Function Documentation

◆ FadeInPlay()

bool RE::BSSoundHandle::FadeInPlay ( std::uint16_t a_fadeTimeMS )

◆ FadeOutAndRelease()

bool RE::BSSoundHandle::FadeOutAndRelease ( std::uint16_t a_fadeTimeMS )

◆ GetDuration()

std::uint64_t RE::BSSoundHandle::GetDuration ( )

◆ IsPlaying()

bool RE::BSSoundHandle::IsPlaying ( ) const

◆ IsValid()

bool RE::BSSoundHandle::IsValid ( ) const

◆ Pause()

bool RE::BSSoundHandle::Pause ( )

◆ Play()

bool RE::BSSoundHandle::Play ( )

◆ SetFrequency()

bool RE::BSSoundHandle::SetFrequency ( float a_frequency )

◆ SetObjectToFollow()

void RE::BSSoundHandle::SetObjectToFollow ( NiAVObject * a_node )

◆ SetOutputModel()

void RE::BSSoundHandle::SetOutputModel ( const BSISoundOutputModel * a_outputModel )

◆ SetPosition()

bool RE::BSSoundHandle::SetPosition ( NiPoint3 a_pos )

◆ SetVolume()

bool RE::BSSoundHandle::SetVolume ( float a_volume )

◆ Stop()

bool RE::BSSoundHandle::Stop ( )

Member Data Documentation

◆ assumeSuccess

bool RE::BSSoundHandle::assumeSuccess

◆ pad05

std::uint8_t RE::BSSoundHandle::pad05

◆ pad06

std::uint16_t RE::BSSoundHandle::pad06

◆ soundID

std::uint32_t RE::BSSoundHandle::soundID

◆ state

REX::EnumSet<AssumedState, std::uint32_t> RE::BSSoundHandle::state

The documentation for this struct was generated from the following file:

CommonLibSSE/include/RE/B/BSSoundHandle.h

Public Types

Public Member Functions

Public Attributes