ISoundPlayer

Namespace: Murder.Core.Sounds
Assembly: Murder.dll

public abstract ISoundPlayer

⭐ Methods

Stop(bool, out SoundEventId[]&)

public abstract bool Stop(bool fadeOut, SoundEventId[]& stoppedEvents)

Parameters
fadeOut bool
stoppedEvents SoundEventId[]&

Returns
bool

Stop(T?, bool)

public abstract bool Stop(T? id, bool fadeOut)

Stop a specific sound event id. If is set, this will stop with a fadeout.

Parameters
id T?

fadeOut bool

Returns
bool

UpdateEvent(SoundEventId, SoundSpatialAttributes)

public abstract bool UpdateEvent(SoundEventId id, SoundSpatialAttributes attributes)

Update spatial attributes for a specific event instance.

Parameters
id SoundEventId

attributes SoundSpatialAttributes

Returns
bool

GetGlobalParameter(ParameterId)

public abstract float GetGlobalParameter(ParameterId parameter)

Parameters
parameter ParameterId

Returns
float

FetchAllPlugins()

public abstract ImmutableArray<T> FetchAllPlugins()

Fetch a list of all the plugins when serializing it.

Returns
ImmutableArray<T>

FetchAllBanks()

public abstract ImmutableDictionary<TKey, TValue> FetchAllBanks()

Fetch a list of all the banks when serializing it, separated by the supported platform.

Returns
ImmutableDictionary<TKey, TValue>

LoadContentAsync(PackedSoundData)

public abstract Task LoadContentAsync(PackedSoundData packedData)

This will load the actual bank content asynchonously.

Parameters
packedData PackedSoundData

Returns
Task

ReloadAsync()

public abstract Task ReloadAsync()

This will reload the content of all the fmod banks in the application.

Returns
Task

PlayEvent(SoundEventId, SoundProperties, T?)

public abstract ValueTask PlayEvent(SoundEventId id, SoundProperties properties, T? attributes)

Parameters
id SoundEventId
properties SoundProperties
attributes T?

Returns
ValueTask

Initialize(string)

public abstract void Initialize(string resourcesPath)

This will initialize the fmod libraries, but not load any banks.

Parameters
resourcesPath string

SetGlobalParameter(ParameterId, float)

public abstract void SetGlobalParameter(ParameterId parameter, float value)

Parameters
parameter ParameterId
value float

SetParameter(SoundEventId, ParameterId, float)

public abstract void SetParameter(SoundEventId instance, ParameterId parameter, float value)

Parameters
instance SoundEventId
parameter ParameterId
value float

SetVolume(T?, float)

public abstract void SetVolume(T? id, float volume)

Change volume.

Parameters
id T?
volume float

Update()

public abstract void Update()

UpdateListener(SoundSpatialAttributes)

public abstract void UpdateListener(SoundSpatialAttributes attributes)

Update listener information (e.g. position and facing).

Parameters
attributes SoundSpatialAttributes

Stop(bool, HashSet, out SoundEventId[]&)

public virtual bool Stop(bool fadeOut, HashSet<T> exceptForSoundsList, SoundEventId[]& stoppedEvents)

Parameters
fadeOut bool
exceptForSoundsList HashSet<T>
stoppedEvents SoundEventId[]&

Returns
bool

⚡