Class ScriptingAPI

A DeepAR Scripting API interop namespace.

Hierarchy

  • ScriptingAPI

Methods

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

Methods

hasVar

  • Check if variable with the given name is already created.

    Returns

    boolean True if the variable is already created, false otherwise.

    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

getVarType

  • Get the type of the variable with the given name.

    Returns

    VarType The variable type.

    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

getBoolVar

  • Get boolean variable with the given name.

    Returns

    boolean Value of the variable with the specified 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

getIntVar

  • Get int variable with the given name.

    Returns

    int Value of the variable with the specified 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

getDoubleVar

  • Get the double variable with the given name.

    Returns

    double Value of the variable with the specified 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

getStringVar

  • Get the string variable with the given name.

    Returns

    string Value of the variable with the specified 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

setBoolVar

  • Set the boolean variable with the given name.

    Returns

    True if the variable is created, false if the variable already exists and the new value is set.

    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

setIntVar

  • Set the int variable with the given name.

    Returns

    True if the variable is created, false if the variable already exists and the new value is set.

    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

setDoubleVar

  • Set the double variable with the given name.

    Returns

    True if the variable is created, false if the variable already exists and the new value is set.

    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

setStringVar

  • Set the string variable with the given name.

    Returns

    True if the variable is created, false if the variable already exists and the new value is set.

    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

deleteVar

  • Delete variable with the given name.

    Returns

    boolean True if the variable is deleted, false otherwise.

    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

clearVars

  • Clear all variables or variables from the specified effect.

    Returns

    boolean True if one or more variables are deleted, false otherwise.

    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

Settings

Member Visibility

Theme

Generated using TypeDoc