Show / Hide Table of Contents

Class Music

Contains snapshots and mixers that are related to the Music AudioMixer

These snapshots are used to change what music channels are being played in a scene

See this table for more info on what groups/mixers do what : https://1drv.ms/x/s!Aj62egREH4PTxx1MpsfuioqJtSCH?e=7kmAV0

Inheritance
object
Music
Namespace: WeaverCore
Assembly: WeaverCore.dll
Syntax
public static class Music

Properties

| Edit this page View Source

ActionAndSubSnapshot

Declaration
public static AudioMixerSnapshot ActionAndSubSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

ActionGroup

Declaration
public static AudioMixerGroup ActionGroup { get; }
Property Value
Type Description
AudioMixerGroup
| Edit this page View Source

ActionOnlySnapshot

Declaration
public static AudioMixerSnapshot ActionOnlySnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

ActionSnapshot

Declaration
public static AudioMixerSnapshot ActionSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

ActiveMusicCue

Declaration
public static MusicCue ActiveMusicCue { get; }
Property Value
Type Description
MusicCue
| Edit this page View Source

ExtraGroup

Declaration
public static AudioMixerGroup ExtraGroup { get; }
Property Value
Type Description
AudioMixerGroup
| Edit this page View Source

HKDecline2Snapshot

Declaration
public static AudioMixerSnapshot HKDecline2Snapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

HKDecline3Snapshot

Declaration
public static AudioMixerSnapshot HKDecline3Snapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

HKDecline4Snapshot

Declaration
public static AudioMixerSnapshot HKDecline4Snapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

HKDecline5Snapshot

Declaration
public static AudioMixerSnapshot HKDecline5Snapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

HKDecline6Snapshot

Declaration
public static AudioMixerSnapshot HKDecline6Snapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

MainAltGroup

Declaration
public static AudioMixerGroup MainAltGroup { get; }
Property Value
Type Description
AudioMixerGroup
| Edit this page View Source

MainGroup

Declaration
public static AudioMixerGroup MainGroup { get; }
Property Value
Type Description
AudioMixerGroup
| Edit this page View Source

MainOnlySnapshot

Declaration
public static AudioMixerSnapshot MainOnlySnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

MasterGroup

Declaration
public static AudioMixerGroup MasterGroup { get; }
Property Value
Type Description
AudioMixerGroup
| Edit this page View Source

MusicMixer

Declaration
public static AudioMixer MusicMixer { get; }
Property Value
Type Description
AudioMixer
| Edit this page View Source

NormalAltSnapshot

Declaration
public static AudioMixerSnapshot NormalAltSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

NormalFlangeSnapshot

Declaration
public static AudioMixerSnapshot NormalFlangeSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

NormalFlangierSnapshot

Declaration
public static AudioMixerSnapshot NormalFlangierSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

NormalGramaphoneSnapshot

Declaration
public static AudioMixerSnapshot NormalGramaphoneSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

NormalSnapshot

Declaration
public static AudioMixerSnapshot NormalSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

NormalSoftSnapshot

Declaration
public static AudioMixerSnapshot NormalSoftSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

NormalSofterSnapshot

Declaration
public static AudioMixerSnapshot NormalSofterSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

OffSnapshot

Declaration
public static AudioMixerSnapshot OffSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

SilentFlangeSnapshot

Declaration
public static AudioMixerSnapshot SilentFlangeSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

SilentSnapshot

Declaration
public static AudioMixerSnapshot SilentSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

SubAreaSnapshot

Declaration
public static AudioMixerSnapshot SubAreaSnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot
| Edit this page View Source

SubGroup

Declaration
public static AudioMixerGroup SubGroup { get; }
Property Value
Type Description
AudioMixerGroup
| Edit this page View Source

TensionGroup

Declaration
public static AudioMixerGroup TensionGroup { get; }
Property Value
Type Description
AudioMixerGroup
| Edit this page View Source

TensionOnlySnapshot

Declaration
public static AudioMixerSnapshot TensionOnlySnapshot { get; }
Property Value
Type Description
AudioMixerSnapshot

Methods

| Edit this page View Source

ApplyMusicSnapshot(AudioMixerSnapshot, float, float)

Applies a snapshot to change what music channels are being played

Declaration
public static void ApplyMusicSnapshot(AudioMixerSnapshot snapshot, float delayTime, float transitionTime)
Parameters
Type Name Description
AudioMixerSnapshot snapshot

The snapshot to be applied

float delayTime

The delay before the music pack is applied

float transitionTime

The time it will take to transition to the new snapshots

| Edit this page View Source

ApplyMusicSnapshot(SnapshotType, float, float)

Applies a music snapshot to change what music channels are being played

Declaration
public static void ApplyMusicSnapshot(Music.SnapshotType snapshot, float delayTime, float transitionTime)
Parameters
Type Name Description
Music.SnapshotType snapshot

The snapshot to be applied

float delayTime

The delay before the music pack is applied

float transitionTime

The time it will take to transition to the new snapshots

| Edit this page View Source

GetGroup(GroupType)

Declaration
public static AudioMixerGroup GetGroup(Music.GroupType type)
Parameters
Type Name Description
Music.GroupType type
Returns
Type Description
AudioMixerGroup
| Edit this page View Source

GetSnapshot(SnapshotType)

Declaration
public static AudioMixerSnapshot GetSnapshot(Music.SnapshotType type)
Parameters
Type Name Description
Music.SnapshotType type
Returns
Type Description
AudioMixerSnapshot
| Edit this page View Source

PlayMusicCue(MusicCue, float, float, bool)

Declaration
public static void PlayMusicCue(MusicCue musicCue, float delayTime = 0, float transitionTime = 0, bool applySnapshot = true)
Parameters
Type Name Description
MusicCue musicCue
float delayTime
float transitionTime
bool applySnapshot
| Edit this page View Source

PlayMusicPack(MusicPack)

Applies a music pack to change what music channels are being played

Declaration
public static void PlayMusicPack(MusicPack pack)
Parameters
Type Name Description
MusicPack pack

The pack to be applied

| Edit this page View Source

PlayMusicPack(MusicPack, float, float, bool)

Applies a music pack to change what music channels are being played

Declaration
public static void PlayMusicPack(MusicPack pack, float delayTime, float snapshotTransitionTime, bool applySnapshot = true)
Parameters
Type Name Description
MusicPack pack

The pack to be applied

float delayTime

The delay before the music pack is applied

float snapshotTransitionTime

The time it will take to transition to the new snapshots

bool applySnapshot

Should the snapshots in the music pack also be applied?

  • Edit this page
  • View Source
☀
☾
In this article
Back to top
Generated by DocFX
☀
☾