Master Audio Support

Table of Contents

This page describes how to set up the Dialogue System with Dark Tonic's Master Audio (Master Audio is required.)

The support package adds a large number of sequencer commands to control all aspects of Master Audio.

Master Audio copyright © Dark Tonic Studios.

Master Audio Setup

To set up the Dialogue System with Master Audio, import the package Third Party Support ► Master Audio Support.

Example Scene

The example scene contains a menu of buttons. Each button will run a cutscene sequence that exercises a single Master Audio sequencer command.

Sequencer Commands

The Master Audio sequencer commands parallel the original Master Audio method names, with "MA" prepended to the front.

Bus

MAFadeBus(busName, targetVolume, fadeTime)

  • busName: 'all' or a bus name
  • targetVolume: 0..1
  • fadeTime: 0..10

MAMuteBus(busName)

  • busName: 'all' or a bus name

MAPauseBus(busName)

  • busName: 'all' or a bus name

MASetBusVolume(busName, targetVolume)

  • busName: 'all' or a bus name
  • targetVolume: 0..1

MASoloBus(busName)

  • busName: 'all' or a bus name

MAStopBus(busName)

  • busName: 'all' or a bus name

MAUnmuteBus(busName)

  • busName: 'all' or a bus name

MAUnpauseBus(busName)

  • busName: 'all' or a bus name

MAUnsoloBus(busName)

  • busName: 'all' or a bus name

Group

MAAddToDucking(soundGroupName, riseVolumeStart, [duckedVolMult], [unduckTime])

  • soundGroupName: name of sound group
  • riseVolumeStart: percentage of sound played to start unducking
  • duckedVolMult: percentage of original volume. Default: 0.5.
  • unduckTime: amount of time to return music to original volume. Default: 1.

MADisableDucking()

MAEnableDucking()

MAFadeGroup(soundGroupName, targetVolume, fadeTime)

  • soundGroupName: 'all' or a sound group name
  • targetVolume: 0..1
  • fadeTime: 0..10

MAFadeOutAllOfSound(soundGroupName, fadeTime)

  • soundGroupName: 'all' or a sound group name
  • fadeTime: 0..10

MAMuteGroup(soundGroupName)

  • soundGroupName: 'all' or a sound group name

MAPauseGroup(soundGroupName)

  • soundGroupName: 'all' or a sound group name

MARemoveFromDucking(soundGroupName)

  • soundGroupName: Name of sound group

MASetGroupVolume(soundGroupName, volume)

  • soundGroupName: 'all' or a sound group name
  • volume: 0..1

MASoloGroup(soundGroupName)

  • soundGroupName: 'all' or a sound group name

MAStopAllOfSound(soundGroupName)

  • soundGroupName: 'all' or a sound group name

MAStopTransformSound(subject, soundGroupName)

  • subject: 'speaker', 'listener' or object name. Default: speaker.
  • soundGroupName: 'all' or a sound group name

MAUnmuteGroup(soundGroupName)

  • soundGroupName: 'all' or a sound group name

MAUnpauseGroup(soundGroupName)

  • soundGroupName: 'all' or a sound group name

MAUnsoloGroup(soundGroupName)

  • soundGroupName: 'all' or a sound group name

MAVariationChangePitch(soundGroupName, variationName, pitch)

  • soundGroupName: sound group name
  • variationName: 'all' or a variation name
  • pitch: -3..3

MAPlaySound(soundGroupName, [variationName], [volume], [pitch], [wait], [subject], [follow])

  • soundGroupName: The name of the Sound Group to trigger a sound from.
  • variationName: Play a specific variation by name. If blank, a random variation is played.
  • volume: Volume percentage (0-1). Default: 1.
  • pitch: Pitch adjustment [-3..3]. Leave blank for no pitch change.
  • wait: Specify true to wait until the sound is done playing. Default: false.
  • subject: GameObject whose position you want the sound to emanate from. Leave blank to play the sound 2D.
  • follow: Specify true to follow the subject. Leave blank to not follow.

Master

MAFireCustomEvent(customEventName)

  • customEventName: name of custom event defined in Master Audio prefab

MAMuteEverything()

MAPauseEverything()

MASetMasterVolume(volume)

  • volume: 0..1

MAStopEverything()

MAUnmuteEverything()

MAUnpauseEverything()

Mixer

MAPauseMixer()

MAStopMixer()

MAUnpauseMixer()

Playlist

MAChangePlaylist(playlistName, [playlistControllerName])

  • playlistName: playlist to change to
  • playlistControllerName: (optional)

MAFadePlaylist(targetVolume, fadeTime, [playlistControllerName])

  • targetVolume: 0..1
  • fadeTime: 0..10
  • playlistControllerName: blank, 'all', or a playlist controller name

MAMutePlaylist([playlistControllerName])

  • playlistControllerName: blank, 'all', or a playlist controller name

MANextPlaylistClip([playlistControllerName])

  • playlistControllerName: blank, 'all', or a playlist controller name

MAPausePlaylist([playlistControllerName])

  • playlistControllerName: blank, 'all', or a playlist controller name

MAPlaylistClip(clip, [playlistControllerName])

  • clipName: clip to play
  • playlistControllerName: (optional)

MARandomPlaylistClip([playlistControllerName])

  • playlistControllerName: blank, 'all', or a playlist controller name

MAResumePlaylist([playlistControllerName])

  • playlistControllerName: blank, 'all', or a playlist controller name

MASetPlaylistVolume(volume)

  • volume: 0..1

MAStopPlaylist([playlistControllerName])

  • playlistControllerName: blank, 'all', or a playlist controller name

MAUnmutePlaylist([playlistControllerName])

  • playlistControllerName: blank, 'all', or a playlist controller name

<< Third Party Integration