MusicSegmentAsset

class

Core/Vixen.Audio/Assets/MusicAsset.cs:40

csharp

public record class MusicSegmentAsset

One piece of music, as a file declares it.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

The tempo is written down rather than derived. It is what the composer wrote, and it is the only thing that makes a bar line a real position — a segment whose declared tempo disagrees with its recording transitions in the wrong place, and nothing can detect that but an ear.

Fields and properties (9)

public string Name
What it is called, and what a transition names it by.
public ContentReference<AudioClip>? Clip
The audio.
public float BeatsPerMinute
Its tempo.
public int BeatsPerBar
The top of its time signature.
public MusicTempoChangeAsset[] TempoChanges
Where it changes tempo or metre, if it does.
public bool Sustains
Whether it vamps rather than moving on, until gameplay releases it.
public int LoopCount
How many times it repeats before moving on. Zero plays it once; negative is forever.
public string Next
Which segment follows when it runs out. Empty stops.
public MusicMarkerAsset[] Markers
Named places in it, for gameplay to hang on.

Methods (1)

public MusicSegment ToSegment()
The segment this describes.

Used by (6)

MusicAssetVixen.Audio
MusicBuilderVixen.Audio
MusicPlayerTestsVixen.Audio.Tests
TypeRegistrationVixen.Audio
Vixen_Audio_Assets_MusicAssetSerializerVixen.Audio
Vixen_Audio_Assets_MusicSegmentAssetSerializerVixen.Audio