audioGetVolume (Function)

Retrieves the volume level used by an audio node.

The volume level does not refer to an absolute level and may vary between different device types.

Input:

node: SINT Default 0

The audio node to get the volume for.

Available nodes:

Output:

volume: SINT

The volume of the node, where 0 is the lowest and 100 is the highest volume.

mute: BOOL

Tells if the node is muted or not.

Returns: INT

Declaration:

FUNCTION audioGetVolume : INT;
VAR_INPUT
  node   : SINT := 0;
  volume : ACCESS SINT;
  mute   : ACCESS BOOL;
END_VAR;

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
  vol   : SINT;
  muted : BOOL;

END_VAR;
...
BEGIN
  ...
  // Get the volume for Line-out
  IF audioGetVolume(node:=1, volume := vol, mute := muted) = 0 THEN
    IF muted THEN
        DebugFmt(message := "Muted. Volume: \1", v1:= vol);
    ELSE
        DebugFmt(message := "Unmuted. Volume: \1", v1:= vol);
    END_IF;
  END_IF;
  ...
END;
 
END_PROGRAM;