Skip to content

AudioAPI reference

Struct AudioStatistics

Namespace: MicroEngine.Audio
Assembly: MicroEngine.Audio.dll
Guide: Audio

What Statistics reports about the mixer’s voices.

C#
public readonly struct AudioStatistics : IEquatable<AudioStatistics>

Implements

IEquatable<AudioStatistics>

Constructors

AudioStatistics(int, int, int)

What Statistics reports about the mixer’s voices.

C#
public AudioStatistics(int ActiveVoices, int MaxVoices, int RefusedSounds)

Parameters

ActiveVoices int

Sounds playing now, music included.

MaxVoices int

Sounds that can play at once.

RefusedSounds int

Sounds the voice policy refused since the start because every voice played something of higher priority.

Properties

ActiveVoices

Sounds playing now, music included.

C#
public int ActiveVoices { get; init; }

Property Value

int

MaxVoices

Sounds that can play at once.

C#
public int MaxVoices { get; init; }

Property Value

int

RefusedSounds

Sounds the voice policy refused since the start because every voice played something of higher priority.

C#
public int RefusedSounds { get; init; }

Property Value

int

Methods

Deconstruct(out int, out int, out int)

C#
public void Deconstruct(out int ActiveVoices, out int MaxVoices, out int RefusedSounds)

Parameters

ActiveVoices int

MaxVoices int

RefusedSounds int

Equals(object)

C#
public override bool Equals(object obj)

Parameters

obj object

Returns

bool

Equals(AudioStatistics)

C#
public bool Equals(AudioStatistics other)

Parameters

other AudioStatistics

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(AudioStatistics, AudioStatistics)

C#
public static bool operator ==(AudioStatistics left, AudioStatistics right)

Parameters

left AudioStatistics

right AudioStatistics

Returns

bool

operator !=(AudioStatistics, AudioStatistics)

C#
public static bool operator !=(AudioStatistics left, AudioStatistics right)

Parameters

left AudioStatistics

right AudioStatistics

Returns

bool