Skip to content

PlatformAPI reference

Struct AudioFormat

Namespace: MicroEngine.Platform
Assembly: MicroEngine.Platform.dll
Guide: The platform host

The PCM format a sink plays: interleaved 32-bit float samples, Channels per frame, at SampleRate frames per second.

C#
public readonly struct AudioFormat : IEquatable<AudioFormat>

Implements

IEquatable<AudioFormat>

Constructors

AudioFormat(int, int)

The PCM format a sink plays: interleaved 32-bit float samples, Channels per frame, at SampleRate frames per second.

C#
public AudioFormat(int SampleRate, int Channels)

Parameters

SampleRate int

Frames per second.

Channels int

Samples per frame (2 for stereo).

Properties

Channels

Samples per frame (2 for stereo).

C#
public int Channels { get; init; }

Property Value

int

SampleRate

Frames per second.

C#
public int SampleRate { get; init; }

Property Value

int

Methods

Deconstruct(out int, out int)

C#
public void Deconstruct(out int SampleRate, out int Channels)

Parameters

SampleRate int

Channels int

Equals(object)

C#
public override bool Equals(object obj)

Parameters

obj object

Returns

bool

Equals(AudioFormat)

C#
public bool Equals(AudioFormat other)

Parameters

other AudioFormat

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(AudioFormat, AudioFormat)

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

Parameters

left AudioFormat

right AudioFormat

Returns

bool

operator !=(AudioFormat, AudioFormat)

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

Parameters

left AudioFormat

right AudioFormat

Returns

bool