Class ScriptingAPI

A DeepAR Scripting API interop namespace.

Hierarchy

ScriptingAPI

Index

Methods

hasVar getVarType getBoolVar getIntVar getDoubleVar getStringVar setBoolVar setIntVar setDoubleVar setStringVar deleteVar clearVars

Methods

hasVar

hasVar(name, slot?): boolean
Check if variable with the given name is already created.
Parameters
- name: string
  
  The variable name.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns boolean
boolean True if the variable is already created, false otherwise.

getVarType

getVarType(name, slot?): VarType
Get the type of the variable with the given name.
Parameters
- name: string
  
  The variable name.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns VarType
VarType The variable type.

getBoolVar

getBoolVar(name, slot?): boolean
Get boolean variable with the given name.
Parameters
- name: string
  
  The variable name.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns boolean
boolean Value of the variable with the specified name.

getIntVar

getIntVar(name, slot?): number
Get int variable with the given name.
Parameters
- name: string
  
  The variable name.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns number
int Value of the variable with the specified name.

getDoubleVar

getDoubleVar(name, slot?): number
Get the double variable with the given name.
Parameters
- name: string
  
  The variable name.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns number
double Value of the variable with the specified name.

getStringVar

getStringVar(name, slot?): string
Get the string variable with the given name.
Parameters
- name: string
  
  The variable name.
- slot: number = 0
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns string
string Value of the variable with the specified name.

setBoolVar

setBoolVar(name, value, slot?): boolean
Set the boolean variable with the given name.
Parameters
- name: string
  
  The variable name.
- value: boolean
  
  Value to be set.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns boolean
True if the variable is created, false if the variable already exists and the new value is set.

setIntVar

setIntVar(name, value, slot?): boolean
Set the int variable with the given name.
Parameters
- name: string
  
  The variable name.
- value: number
  
  Value to be set.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns boolean
True if the variable is created, false if the variable already exists and the new value is set.

setDoubleVar

setDoubleVar(name, value, slot?): boolean
Set the double variable with the given name.
Parameters
- name: string
  
  The variable name.
- value: number
  
  Value to be set.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns boolean
True if the variable is created, false if the variable already exists and the new value is set.

setStringVar

setStringVar(name, value, slot?): boolean
Set the string variable with the given name.
Parameters
- name: string
  
  The variable name.
- value: string
  
  Value to be set.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns boolean
True if the variable is created, false if the variable already exists and the new value is set.

deleteVar

deleteVar(name, slot?): boolean
Delete variable with the given name.
Parameters
- name: string
  
  The variable name.
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns boolean
boolean True if the variable is deleted, false otherwise.

clearVars

clearVars(slot?): boolean
Clear all variables or variables from the specified effect.
Parameters
- Optional slot: string
  
  The slot of the effect in which to search the variable. If it is not given, variable will be searched for in all the effects.
Returns boolean
boolean True if one or more variables are deleted, false otherwise.

Generated using TypeDoc