Scripting API

Scripting API

ImportedAudio

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

What an import of a sound clip made: how long it is, how much of it there is, and what it was made from.

public readonly record struct ImportedAudio

Remarks

Laid out to match the engine's own ImportedAudio, thirty-two bytes.

Constructors

ImportedAudio

public ImportedAudio(ulong Bytes, ulong Frames, uint SampleRate, uint Channels, uint SourceRate, uint SourceChannels)

What an import of a sound clip made: how long it is, how much of it there is, and what it was made from.

Parameters

  • Bytes: How long the import is, in bytes.
  • Frames: How many frames it holds: a sample of each channel.
  • SampleRate: Its sample rate, in hertz.
  • Channels: How many channels it has.
  • SourceRate: The source's sample rate, in hertz.
  • SourceChannels: How many channels the source has.

Laid out to match the engine's own ImportedAudio, thirty-two bytes.

Properties

Bytes

public ulong Bytes { get; init; }

How long the import is, in bytes.

Frames

public ulong Frames { get; init; }

How many frames it holds: a sample of each channel.

SampleRate

public uint SampleRate { get; init; }

Its sample rate, in hertz.

Channels

public uint Channels { get; init; }

How many channels it has.

SourceRate

public uint SourceRate { get; init; }

The source's sample rate, in hertz.

SourceChannels

public uint SourceChannels { get; init; }

How many channels the source has.