Difference between revisions of "Plugin Audio"
(Created page with "Go to the main '''Plugins''' page. Go to the complete '''Plugin List'''. =Plugin Description= Actions to play back various types of audio files on specific output ...") |
m (1 revision) |
(No difference)
|
Latest revision as of 11:24, 13 January 2021
Go to the main Plugins page.
Go to the complete Plugin List.
Contents
Plugin Description
Actions to play back various types of audio files on specific output devices.
Actions for the Audio plugin
Play
Audio.Play
Plays the audio file at <FilePath>
Supported formats: wav, mp3, wma, avi
If <DeviceName> is not specified then the audio will be played on the currently selected Device, which can be set in the plugin options, or with Audio.SetOutputName.
If <DeviceName> is specified then the audio will be played on that device but the current output will not be changed for subsequent plays.
- Parameters: 1-2
- FilePath : Path to audio file [string]
- DeviceName : Name of output device to use [string]
SetOutputName
- Parameters: 1
- OutputName : [string]
SetOutputNum
Audio.SetOutputNum
-1 sets the audio output device to the windows default output.
0 is the first device
1 is the second device etc.
Setting the device does not change the windows default output.
- Parameters: 1
- OutputNum : [integer]
Pause
Resume
Stop
GenXML
Audio.GenXML
Generates a payloadXML file containing all known audio outputs and their GUIDs and saves it to <Filename>
- Parameters: 1
- Filename : Path and filename to save xml file to [string]