Subscribe in a reader

For writing a Lua plugin see Lua Plugin.

class Frx

since 1.0.5

Description

This package (actually a lua table) is the connection between your script and VSTForx. An object of this table is globally embedded in the current lua context.

  --access example 
frx.wait(50)

Dependent on its lua context the package content (see fields) is slightly different. There are currently two possible context types:

View context
this context is active while loading the "vstforx-init.lua" script. Here you have access to the View and its objects.
Lua Plugin context
Within a Lua Plugin you have access to a related Plugin object.

Functions

void wait ( int milliseconds )
string serializePlugin ( )
void deserializePlugin ( string data )
int getGraphDelay ( )
void messageBox ( string message )
string showSelectFileDlg ( string startPath )
string showSelectDirectory ( string startPath )
string showSaveFileDlg ( string startPath )
void openSceneBrowser ( )
void openUrl ( string url )
void openSetup ( )
void openAbout ( )
string getVersionString ( )
table queryDB ( string query )
Timer addTimer ( string callbackExpr , int milliseconds , int numRepetitions )
void setPersistData ( string key , sequence data )
sequence getPersistData ( string key )
string showInputTextDlg ( string message , string text )
bool showYesNoDlg ( string message )
void runOnUIThread ( string expr )
void exec ( string expr )

Fields

View view
Plugin plug

Detailed Description

Functions

void wait ( int milliseconds )
since 1.0.5
Description
Waits for given milliseconds.
Parameters
milliseconds - milliseconds to wait
string serializePlugin ( )
since 1.0.5
Description
Serializes the VSTForx plugin state.
Return
the plugin state as string
void deserializePlugin ( string data )
since 1.0.5
Description
Restores the VSTForx plugin state.
Parameters
data - the plugin state string
int getGraphDelay ( )
since 1.0.5
Description
When the processing graph contains one or more plugins with an initial delay>0 we need to compensate these delays to keep all signals in sync. The graph delay is the resulting total delay aka the eventually initial delay of VSTForx.
Return
the graph delay in samples
void messageBox ( string message )
since 1.0.5
Description
Shows a message box.
Parameters
message - the message string
string showSelectFileDlg ( string startPath )
since 1.0.5
Description
Shows a "select file" dialog.
Parameters
startPath - the start path
Return
the path of the selected file
string showSelectDirectory ( string startPath )
since 1.0.5
Description
Shows a "select file" dialog.
Parameters
startPath - the start path
Return
the path of the selected file
string showSaveFileDlg ( string startPath )
since 1.0.5
Description
Shows a "save file" dialog.
Parameters
startPath - the start path
Return
the path of the selected file
void openSceneBrowser ( )
since 1.0.5
Description
opens the "Scene Browser"
void openUrl ( string url )
since 1.0.5
Description
Opens the default browser and navigates to the given url.
Parameters
url - a url
void openSetup ( )
since 1.0.5
Description
Opens the setup dialog.
void openAbout ( )
since 1.0.5
Description
Opens the about splash screen.
string getLastSceneBrowserSelection ( )
since 1.0.5
Description
Return
the selection path which was set before the browser was closed
int getVersionInteger ( )
since 1.0.5
Description
Return
the VSTForx version number as int e.g 105 for 1.0.5
string getVersionString ( )
since 1.0.5
Description
Return
the VSTForx version number as string
table queryDB ( string query )
since 1.0.5
Description
Performs a sqlite query on VSTForx's database.
Parameters
query - the query string
Return
a result table -> { {"column": value}, ... }
Timer addTimer ( string callbackExpr , int milliseconds , int numRepetitions )
since 1.0.5
Description
Creates a Timer object.
Parameters
callbackExpr - a lua expression which will be executed when the timer expires
milliseconds - the timer time in milliseconds
numRepetitions - the number of repetitions. If this value is -1 then the timer dosen't stop to repeat.
Return
the timer
void setPersistData ( string key , sequence data )
since 1.0.5
Description
Set persist user data for a given key. Example:
  function onViewEvent(evName, evObj) 
if evName=="on saving view state" then
frx.setPersistData("magicKey", {"some crazy value", 24})
end
end
frx.view:addViewListener("onViewEvent")
Parameters
key - the key
data - the data value sequence e.g {"first value","second value", 100}
sequence getPersistData ( string key )
since 1.0.5
Description
Parameters
key - the key
Return
the persist user data for a key.
string showInputTextDlg ( string message , string text )
since 1.0.5
Description
Shows a "input text" dialog.
Parameters
message - a message
text - the default input text
Return
the input text
bool showYesNoDlg ( string message )
since 1.0.5
Description
Shows a "yes or no" question dialog.
Parameters
message - the question message
Return
true if yes was selected
void runOnUIThread ( string expr )
since 1.0.5
Description
Some functions dosen't work when called from another thread than the UI thread. E.g. open a dialog during a timer callback. In that case this function will help. Example:
  function onTimer()
runOnUIThread("messageBox('HI')")
end
Parameters
expr - a command string. This has to be a valid lua expression.
void exec ( string expr )
since 1.0.5
Description
Executes a lua expression.
Parameters
expr - the lua expression

Fields

View view
Description
a View object
available for View context only
Plugin plug
Description
a Plugin object
available for Lua Plugin context only

Comments   

0 #48 argument essay 2018-04-04 02:38
argumentative essay papers writing persuasive essay conclusion for a persuasive essay writing argument essays argumentation persuasion essay: https://argumentativeessay365.org/ argument writing persuasive speech paper: https://argumentativeessay365.org/ writing to argue argumentative essay articles: https://argumentativeessay365.org/ argumentative essay outlines writing an argumentative paper: https://argumentativeessay365.org/
Quote
0 #47 argument essay 2018-04-03 20:19
argumentative essays: https://argumentativeessay365.org/ argument papers: https://argumentativeessay365.org/ this essay will argue: https://argumentativeessay365.org/ write persuasive essay good persuasive writing: https://argumentativeessay365.org/ buy argumentative essay teaching argumentative essay persuasion essay: https://argumentativeessay365.org/ piece of persuasive writing: https://argumentativeessay365.org/ persuasive essay guidelines: https://argumentativeessay365.org/ essay on essay writing: https://argumentativeessay365.org/
Quote
0 #46 argument essay 2018-04-03 12:32
internet argumentative essay: https://argumentativeessay365.org/ how to write an persuasive essay this essay will argue writing a good persuasive essay: https://argumentativeessay365.org/ argumentatif essay: https://argumentativeessay365.org/ purchase argumentative essay: https://argumentativeessay365.org/ introduction for an argumentative essay: https://argumentativeessay365.org/ adoption argumentative essay: https://argumentativeessay365.org/ essay persuasive: https://argumentativeessay365.org/ argumentative and persuasive essay persuasive and argumentative writing
Quote
0 #45 argument essay 2018-04-03 07:04
argumentative essay papers argument essays: https://argumentativeessay365.org/ argument and persuasion essay: https://argumentativeessay365.org/ argumentative speeches: https://argumentativeessay365.org/ essay argument: https://argumentativeessay365.org/ write an argumentative essay simple argumentative essay argumentative text persuasive essay guidelines: https://argumentativeessay365.org/ conclusion for a persuasive essay an argumentative research paper
Quote
0 #44 argument essay 2018-04-02 23:34
help with argumentative essay: https://argumentativeessay365.org/ introductions for persuasive essays a argumentative essay: https://argumentativeessay365.org/ argumentative essay on argumentative position: https://argumentativeessay365.org/ good conclusions for persuasive essays argumentative writing: https://argumentativeessay365.org/ persuasive essay titles: https://argumentativeessay365.org/ persuasive writing pieces research paper argumentative persuasive essy: https://argumentativeessay365.org/
Quote
0 #43 argument essay 2018-04-02 16:55
argumentative essay unit: https://argumentativeessay365.org/ argument essay introduction: https://argumentativeessay365.org/ introduction of an argumentative essay persuasive essay strategies: https://argumentativeessay365.org/ owl argumentative essay: https://argumentativeessay365.org/ write a persuasive paragraph essay of argumentation: https://argumentativeessay365.org/ argumentative introduction paragraph: https://argumentativeessay365.org/ academic writing essays: https://argumentativeessay365.org/ writing essay help written essay papers
Quote
0 #42 fiets kopen 28 inch 2018-03-31 05:26
Hij is 152 cm, en heeft een gewone 28" herenfiets.
Quote
0 #41 MadgeChief 2018-03-28 18:39
I have checked your page and i have found some duplicate content, that's why you don't rank high in google's search
results, but there is a tool that can help you to create 100% unique articles, search for;
boorfe's tips unlimited content
Quote
0 #40 argumentative essay 2018-03-24 13:09
argumentative essay argumentative essay: https://argumentativeessay365.org/
Quote
0 #39 João Eduardo 2018-03-23 12:51
Eu como olhando seu web site . Muito obrigado !
Quote

Add comment


Security code
Refresh