Yukar.Engine.Audio Class Reference

A class that manages playback of general audio such as BGM/SE/ME More...

Classes
class	SoundDef
	an instance of the loaded sound More...

Public Types
enum	SoundType { Map = 0 , Normal , Arnis }
	Playback type / Map, Normal is normal stereo, Arnis is 3D sound More...

Static Public Member Functions
static void	PlayDummy ()
static void	Initialize ()
static void	InitializeSETypeCount (int inNormalSECount, int inArnisSECount)
static void	Destroy ()
static string	GetSoundType (SoundType soundType)
static void	SetListenerMatrix (SharpKmyMath.Matrix4 mtx)
static void	SetDistanceScaleMaxDistance (float v)
static void	PlayBgm (Common.Resource.SoundResource rom, float volume=1.0f, float tempo=1.0f)
static void	SetBgmVolume (float volume)
static void	changeVolume ()
static void	PlayBgs (Common.Resource.SoundResource rom, float volume=1.0f, float tempo=1.0f)
static void	StopBgm ()
static void	StopBgs ()
static int	LoadSound (Common.Resource.SoundResource rom, bool getUniqueId=false)
	load sound More...
static void	UnloadSound (Common.Resource.SoundResource rom)
static void	PlaySound (int id, float pan=0f, float volume=1.0f, float tempo=1.0f, Audio.SoundType soundType=Audio.SoundType.Normal)
static void	PauseSound (int id)
	sound pose More...
static void	ResumeSound (int id)
	Resume a paused sound More...
static void	UnloadSound (int id)
static SoundDef	GetNowBgm (bool doClear=true)
static void	SwapBgm (SoundDef sound)
static bool	IsBgmPlaying ()
static SoundDef	GetNowBgs ()
static Common.Resource.ResourceItem	GetNowBgsRom ()
static void	setMasterVolume (float bgm, float se)
static bool	IsSePlaying (int seId)
static bool	IsSePlaying (Common.Resource.SoundResource sound)
static int	GetSeId (Common.Resource.SoundResource sound, bool reverseOrder=false)
static Sound	CacheSound (SoundResource bgm)
static void	UncacheSound (Sound pre)
static void	UnloadAllSound ()
static void	StopAllSound ()
static void	StopSound (int loadedSeId)
static bool	GetLoopPoint (string path, out int loopStart, out int loopEnd)
static void	SetSePosition (int id, float x, float y, float z)
	Setting the playback position of the sound effect (When starting playback, the position must be set before PlaySound) More...
static void	SetSEVolume (int id, float volume=1)
	Sound effect volume setting More...

Detailed Description

A class that manages playback of general audio such as BGM/SE/ME

Member Enumeration Documentation

SoundType

enum Yukar.Engine.Audio.SoundType

Playback type / Map, Normal is normal stereo, Arnis is 3D sound

Enumerator
Map
Normal
Arnis

Member Function Documentation

CacheSound()

static Sound Yukar.Engine.Audio.CacheSound ( SoundResource  bgm )

static

changeVolume()

static void Yukar.Engine.Audio.changeVolume ( )

static

Destroy()

static void Yukar.Engine.Audio.Destroy ( )

static

GetLoopPoint()

static bool Yukar.Engine.Audio.GetLoopPoint ( string  path, out int  loopStart, out int  loopEnd  )

static

GetNowBgm()

static SoundDef Yukar.Engine.Audio.GetNowBgm ( bool  doClear = true )

static

GetNowBgs()

static SoundDef Yukar.Engine.Audio.GetNowBgs ( )

static

GetNowBgsRom()

static Common.Resource.ResourceItem Yukar.Engine.Audio.GetNowBgsRom ( )

static

GetSeId()

static int Yukar.Engine.Audio.GetSeId ( Common.Resource.SoundResource  sound, bool  reverseOrder = false  )

static

GetSoundType()

static string Yukar.Engine.Audio.GetSoundType ( SoundType  soundType )

static

Initialize()

static void Yukar.Engine.Audio.Initialize ( )

static

InitializeSETypeCount()

static void Yukar.Engine.Audio.InitializeSETypeCount ( int  inNormalSECount, int  inArnisSECount  )

static

IsBgmPlaying()

static bool Yukar.Engine.Audio.IsBgmPlaying ( )

static

IsSePlaying() [1/2]

static bool Yukar.Engine.Audio.IsSePlaying ( Common.Resource.SoundResource  sound )

static

IsSePlaying() [2/2]

static bool Yukar.Engine.Audio.IsSePlaying ( int  seId )

static

LoadSound()

static int Yukar.Engine.Audio.LoadSound ( Common.Resource.SoundResource  rom, bool  getUniqueId = false  )

static

load sound

Parameters

rom
getUniqueId	If false, just return the ID if it has already been loaded

Returns

PauseSound()

static void Yukar.Engine.Audio.PauseSound ( int  id )

static

sound pose

Parameters

id	ID of the sound

PlayBgm()

static void Yukar.Engine.Audio.PlayBgm ( Common.Resource.SoundResource  rom, float  volume = 1.0f, float  tempo = 1.0f  )

static

PlayBgs()

static void Yukar.Engine.Audio.PlayBgs ( Common.Resource.SoundResource  rom, float  volume = 1.0f, float  tempo = 1.0f  )

static

PlayDummy()

static void Yukar.Engine.Audio.PlayDummy ( )

static

PlaySound()

static void Yukar.Engine.Audio.PlaySound ( int  id, float  pan = 0f, float  volume = 1.0f, float  tempo = 1.0f, Audio.SoundType  soundType = Audio.SoundType.Normal  )

static

ResumeSound()

static void Yukar.Engine.Audio.ResumeSound ( int  id )

static

Resume a paused sound

Parameters

id	ID of the sound

SetBgmVolume()

static void Yukar.Engine.Audio.SetBgmVolume ( float  volume )

static

SetDistanceScaleMaxDistance()

static void Yukar.Engine.Audio.SetDistanceScaleMaxDistance ( float  v )

static

SetListenerMatrix()

static void Yukar.Engine.Audio.SetListenerMatrix ( SharpKmyMath.Matrix4  mtx )

static

setMasterVolume()

static void Yukar.Engine.Audio.setMasterVolume ( float  bgm, float  se  )

static

SetSePosition()

static void Yukar.Engine.Audio.SetSePosition ( int  id, float  x, float  y, float  z  )

static

Setting the playback position of the sound effect (When starting playback, the position must be set before PlaySound)

Parameters

id	sound effect ID
x	X-coordinate
y	Y coordinate
z	Z-coordinate

SetSEVolume()

static void Yukar.Engine.Audio.SetSEVolume ( int  id, float  volume = 1  )

static

Sound effect volume setting

Parameters

id	sound effect ID
volume	volume

StopAllSound()

static void Yukar.Engine.Audio.StopAllSound ( )

static

StopBgm()

static void Yukar.Engine.Audio.StopBgm ( )

static

StopBgs()

static void Yukar.Engine.Audio.StopBgs ( )

static

StopSound()

static void Yukar.Engine.Audio.StopSound ( int  loadedSeId )

static

SwapBgm()

static void Yukar.Engine.Audio.SwapBgm ( SoundDef  sound )

static

UncacheSound()

static void Yukar.Engine.Audio.UncacheSound ( Sound  pre )

static

UnloadAllSound()

static void Yukar.Engine.Audio.UnloadAllSound ( )

static

UnloadSound() [1/2]

static void Yukar.Engine.Audio.UnloadSound ( Common.Resource.SoundResource  rom )

static

UnloadSound() [2/2]

static void Yukar.Engine.Audio.UnloadSound ( int  id )

static