Plugin Audio

From VoxCommando
Jump to: navigation, search

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 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
  1. FilePath : Path to audio file [string]
  2. DeviceName : Name of output device to use [string]

SetOutputName

Audio.SetOutputName


  • Parameters: 1
  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
  1. OutputNum : [integer]

Pause

Audio.Pause

Resume

Audio.Resume

Stop

Audio.Stop

GenXML

Audio.GenXML
Generates a payloadXML file containing all known audio outputs and their GUIDs and saves it to <Filename>

  • Parameters: 1
  1. Filename : Path and filename to save xml file to [string]