Ara
Download

Search or run a command

Jump to a section or open an Ara link.

Struct · Ara

MusicSource

Plays a .music document's interactive score (segments, transitions, intensity layers) from this entity, non-spatial. Presentation intent: gameplay writes intensity and segment; the audio presenter follows them.

public struct MusicSource : IComponent<MusicSource>

Properties

TypeIndex

public static uint TypeIndex { get; }

Stable engine component index.

Fields

Music

public string Music;

The score (.music document).

Default: null.

Bus

public string Bus;

Mixer bus the stems play on.

Default: "music".

Intensity

public float Intensity;

Intensity from 0 to 1: stems whose range contains it are audible.

Range: [0, 1]. Default: 0.

Segment

public string Segment;

Segment to transition to (on the score's sync rule); empty follows the score.

Default: "".

Methods

Access

public static ref MusicSource Access(Entity entity, bool write);

No description yet.

Insert

public static void Insert(in Commands commands, Entity entity, in MusicSource value);

No description yet.

Contains

public static bool Contains(Entity entity);

No description yet.