Plugin PY

Go to the main Plugins page.

Go to the complete Plugin List.

Plugin Description

By leveraging the power of Iron Python, the "PY" plugin allows us to run python scripts in VoxCommando. Scripts can interact with VoxCommando, reading and settings variables, triggering events and executing other actions.

Actions for the PY plugin

ExecString

PY.ExecString
evaluates and executes the python code

• Parameters: 1

1. Code : Python code to execute [string]

ExecFile

PY.ExecFile
Loads the python file at <Path> and executes it

• Parameters: 1

1. Path : path to python file to execute [string]

GetVar

PY.GetVar
Tries to return the value of <VarName> as a string
Does not work for complex variables such as collections (lists, tuples, dictionaries etc.)

• Parameters: 1

1. VarName : Name to variable to retrieve value for [string]

GetList

PY.GetList
Tries to return the values of <VarName> as a set of matches.
Only works if <VarName> points to a list of strings.

• Parameters: 1

1. VarName : [']

ReInit

PY.ReInit
Completely reinitializes the python engine, erasing all objects from memory.