Copyright © 2025-2026 Candy ArtsMedia Stop
The Media_Stop command stops one or more media players, and the Dialogue stops waiting for them. By default, the player is cleared; with a Stop_Frame, a video or image player stops on a frame and remains on screen instead.
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.
Stop_Frame
Description:
The frame each player stops on. Audio has no frames to display: on an audio player, any number stops the playback and leaves its file loaded.
Values:
• Clear or X (case-insensitive): Unload the file. Video and image players are also hidden, and the dialogue UI returns to its default z index.
• 0: Stop on the current frame. Video and image players remain on screen, the dialogue UI retains its z index, and Media_Resume doesn't restart them.
• -1: Stop on the last frame, with the same behavior as 0.
• Positive number: Stop on that frame, counted from 1, with the same behavior as 0.
• Empty: Clear.
Loops
Description:
Stops the playback once it has played this many loops, counted from its start, rather than at once. It replaces the Loops and Duration of the Line that started the playback, and the playback then stops on this Line's Stop_Frame. The Dialogue doesn't wait for it. A point that has already passed stops the playback at once, where it is; so does media that isn't playing (held by a Loops of 0, finished or already stopped). A static image has no loops: its Loops is ignored, and only its Duration counts, from when the image was shown.
Values:
• Empty or null: No loops: stop at once, unless Duration is set.
• 0 or a positive number: The number of loops, counted from the start of the playback.
Duration
Description:
The time the playback continues after those loops before it stops, counted on playback as the Duration of a Play command is: paused time doesn't count. With an empty Loops, it counts from the start of the playback.
Values:
• Number of seconds: Such as 2.5.
• Timestamp: In the format SS.xx, MM:SS.xx or HH:MM:SS.xx, such as 01:30.5.
• f=N: N frames, on video and animated image players only.
• 0, null or empty: No duration: Loops alone decides.
FPS
Description:
Video players only. The frame rate used to convert a Stop_Frame number into a position, and that an f= Duration counts with, overriding the video's own.
Values:
• Frames per second: Such as 24.
• Empty: The video's own frame rate.
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.