Copyright © 2025-2026 Candy ArtsMedia Volume
The Media_Volume command sets the volume of audio and video players, instantly or with a fade. All fades in the Line start together. By default the Dialogue continues while the fades run; with a fade time prefixed with !, the Dialogue waits until that fade completes. A new fade replaces any fade already running on the player.
Keys
Every key also accepts a ¢ expression instead of a fixed value, unless its description says otherwise. See CandyRef Expressions.
Players
Description:
The media players to act on. Each key is a player's name, and its value is a Dictionary of settings for that player (see below), or an empty Dictionary for none. A single Line can control several players, each with its own settings. An entry that can't be found is reported and skipped, without affecting the others.
Values:
• Player name: A key of the Engine's media_players_paths, such as Music or Video.
• ¢ expression: Can also return the player node itself, such as ¢$UI/Radio.
Player Settings
Each player in Players accepts the following keys. Image players have no volume, so only audio and video players are affected.
Volume
Description:
The player's new volume.
Values:
• Number: The volume in dB, such as -6 (-80 is silent).
• +=N / -=N: Raise or lower the current volume by N dB, such as -=12.
• Empty: Not valid. An error is reported, and the volume is left unchanged.
Time
Description:
The duration of the fade to the new volume.
Values:
• Number of seconds: Fade over that duration.
• 0 or empty: Change the volume instantly.
• !N: Fade over N seconds, and hold the Dialogue until the fade completes, such as !2.
Take_Hold
Description:
Whether this command takes hold of the player, if it is Public. While an Engine holds it, its Public Mode determines what other Engines can do with it: nothing (Exclusive), only the commands it lists (Semi-Exclusive), or anything (Free). The hold lasts until the playback ends or is stopped.
Values:
• Empty: The player decides, from its own list of commands that take hold.
• 1: Take hold, even if the player doesn't list this command.
• -1: Never take hold.