Scripting API

Scripting API

AudioBus

Record in Abyss.Core, from Abyss.Core.

One bus of a game's mix, as settings/audio.json holds it.

public record AudioBus

Constructors

AudioBus

public AudioBus(ulong Id, string Name)

One bus of a game's mix, as settings/audio.json holds it.

Parameters

  • Id: Its identity, which stays with it as it is renamed: AudioMix.Master for Master.
  • Name: What it is called, which a game's code names it by.

Properties

Id

public ulong Id { get; init; }

Its identity, which stays with it as it is renamed: AudioMix.Master for Master.

Name

public string Name { get; init; }

What it is called, which a game's code names it by.

Volume

public float Volume { get; init; }

Its fader, in decibels, from AudioMix.LeastVolume to AudioMix.MostVolume.

Mute

public bool Mute { get; init; }

Whether it is muted.

Solo

public bool Solo { get; init; }

Whether it is soloed: while any bus is, only those on a soloed bus's way to the speakers are heard.

Send

public ulong Send { get; init; }

The bus it sends to, one before it; Master's is never read, it sending to the speakers.

Bypass

public bool Bypass { get; init; }

Whether its effects are bypassed: each turned dry.

Effects

public IReadOnlyList<BusEffect> Effects { get; init; }

Its effects, in the order they run before its fader.

FollowsTimeScale

public bool FollowsTimeScale { get; init; }

Whether its sounds, and those of every bus that sends to it, follow the game's time scale: played at their pitch times the scale, held while it is zero. Off, they play at their own speed whatever the game's time does — music, and an interface's sounds.

Methods

Equals

public bool Equals(AudioBus? other)

Whether two are the same bus, as it is now: every setting, and each effect.

Parameters

  • other

GetHashCode

public override int GetHashCode()