Scripting API

Scripting API

AudioShape

Record struct in Abyss.Core, from Abyss.Core.

What a clip's file holds: how many frames, at what rate, of how many channels, encoded how.

public readonly record struct AudioShape

Remarks

Laid out to match the engine's own AudioShape, twenty-four bytes.

Constructors

AudioShape

public AudioShape(ulong Frames, uint SampleRate, uint Channels, AudioCodec Codec, uint Reserved)

What a clip's file holds: how many frames, at what rate, of how many channels, encoded how.

Parameters

  • Frames: How many frames it holds.
  • SampleRate: Its sample rate, in hertz.
  • Channels: How many channels it has: one or two.
  • Codec: What it is encoded as.
  • Reserved: Nothing; zero.

Laid out to match the engine's own AudioShape, twenty-four bytes.

Properties

Frames

public ulong Frames { get; init; }

How many frames it holds.

SampleRate

public uint SampleRate { get; init; }

Its sample rate, in hertz.

Channels

public uint Channels { get; init; }

How many channels it has: one or two.

Codec

public AudioCodec Codec { get; init; }

What it is encoded as.

Reserved

public uint Reserved { get; init; }

Nothing; zero.

Length

public TimeSpan Length { get; }

How long it plays, at its own pitch.