Function: app.PlaySound

Plays a sound file.

Syntax

{
	"method": "app.PlaySound",
	"params": {
		"sound": "...",
		"loop": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> PlaySound( AdvString sound, std::optional<bool> loop = std::nullopt );
public Task<bool> PlaySoundAsync(string sound, bool? loop = null, CancellationToken ct = default);
playSound(sound: string, loop?: boolean | undefined): Promise<boolean>;

Parameters

sound : string

Name of the sound file relative to sounds folder.

loop : bool optional

Play sound in a loop.

Result : bool

Success.

Remarks

This method requires API control access.