Class AudioHelpers
Inheritance
System.Object
AudioHelpers
Namespace: Content.Shared.Audio
Assembly: Content.Shared.dll
Syntax
public static class AudioHelpers : objectMethods
| Improve this Doc View SourceShiftSemitone(Int32)
Returns a pitch multiplier that shifts by the given number of semitones.
Declaration
public static AudioParams ShiftSemitone(int shift)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | shift | Number of semitones to shift, positive or negative. Clamped between -12 and 12 which correspond to a pitch multiplier of 0.5 and 2.0 respectively. |
Returns
| Type | Description |
|---|---|
| Robust.Shared.Audio.AudioParams |
WithSemitoneVariation(Int32, IRobustRandom)
Returns a pitch multiplier shifted by a random number of semitones within variation.
Declaration
public static AudioParams WithSemitoneVariation(int variation, IRobustRandom rand)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | variation | Max number of semitones to shift in either direction. Values above 12 have no effect. |
| Robust.Shared.Random.IRobustRandom | rand |
Returns
| Type | Description |
|---|---|
| Robust.Shared.Audio.AudioParams |
WithVariation(Single)
Returns a random pitch.
Declaration
public static AudioParams WithVariation(float amplitude)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | amplitude |
Returns
| Type | Description |
|---|---|
| Robust.Shared.Audio.AudioParams |
WithVariation(Single, IRobustRandom)
Returns a random pitch.
Declaration
public static AudioParams WithVariation(float amplitude, IRobustRandom rand)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | amplitude | |
| Robust.Shared.Random.IRobustRandom | rand |
Returns
| Type | Description |
|---|---|
| Robust.Shared.Audio.AudioParams |