Package org.openhab.core.model.script.actions

Class Audio

java.lang.Object

org.openhab.core.model.script.actions.Audio

@NonNullByDefault
public class Audio
extends Object

The static methods of this class are made available as functions in the scripts. This allows a script to use audio features.

Author:

Kai Kreuzer - Initial contribution, Christoph Weitkamp - Added parameter to adjust the volume

Constructor Summary

Constructors

Constructor	Description
Audio()

Method Summary

Modifier and Type	Method	Description
static void	decreaseMasterVolume(float percent)
static float	getMasterVolume()
static void	increaseMasterVolume(float percent)
static void	playSound(String filename)
static void	playSound(String filename, float volume)
static void	playSound(String sink, String filename)
static void	playSound(String sink, String filename, float volume)
static void	playSound(String sink, String filename, PercentType volume)
static void	playSound(String filename, PercentType volume)
static void	playStream(String url)
static void	playStream(String sink, String url)
static void	setMasterVolume(float volume)
static void	setMasterVolume(PercentType percent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Audio

public Audio()

Method Details

playSound

public static void playSound(String filename)

playSound

public static void playSound(String filename,
 PercentType volume)

playSound

public static void playSound(String filename,
 float volume)

playSound

public static void playSound(String sink,
 String filename)

playSound

public static void playSound(String sink,
 String filename,
 PercentType volume)

playSound

public static void playSound(String sink,
 String filename,
 float volume)

playStream

public static void playStream(String url)

playStream

public static void playStream(String sink,
 String url)

getMasterVolume

public static float getMasterVolume()
                             throws IOException

Throws:

IOException

setMasterVolume

public static void setMasterVolume(float volume)
                            throws IOException

Throws:

IOException

setMasterVolume

public static void setMasterVolume(PercentType percent)
                            throws IOException

Throws:

IOException

increaseMasterVolume

public static void increaseMasterVolume(float percent)
                                 throws IOException

Throws:

IOException

decreaseMasterVolume

public static void decreaseMasterVolume(float percent)
                                 throws IOException

Throws:

IOException