Video.GetVolume

OverviewExamples

number Video.GetVolume (

string ObjectName )

Description

Retrieves the current volume level of a video object. The volume is represented as a number between 0 and 100.

Parameters

ObjectName

(string) The name of the video object.

Returns

(number) The current volume level of the video object. The returned value is a number between 0 and 100, where 0 is silent and 100 is the loudest. If an error occurs, -1 is returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.