Class SteamVoiceFilter

Base for applying filters to voice audio.

Inheritance

System.Object

SteamFilter

SteamVoiceFilter

Inherited Members

SteamFilter.Order

SteamFilter.CompareTo(SteamFilter)

Namespace: KaijuSolutions.SteamMultiplayerEngine

Syntax

public abstract class SteamVoiceFilter : SteamFilter

Properties

Global

If this is a global filter that is registered directly to the SteamManager and applied to all voice sources, or if this is being manually used for instance on a SteamUser. If you want to run the same filter on all voice sources, setting it as a global filter ensures it is run only once for performance instead of on a per-instance case.

Declaration

public bool Global { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Changed()

Called when the sorting order of this has changed.

Declaration

protected sealed override void Changed()

Overrides

SteamFilter.Changed()

Filter(ref Single[], ref UInt32, UInt64)

Apply the filter to the audio.

Declaration

public abstract void Filter(ref float[] sound, ref uint length, ulong id)

Parameters

Type	Name	Description
System.Single[]	sound	The received audio which has been uncompressed from a single-channel 16-bit PCM audio.
System.UInt32	length	The length of the received audio. The length of the array may be greater than this, and the audio data is from the start of the array to this.
System.UInt64	id	The ID of the player that the voice is from.