No internet connection
  1. Home
  2. Support

Complete SoundFlow Javascript Documentation

By Charles Elmi @Charles_Elmi
    2022-11-01 16:12:42.039Z

    HI,

    I really would need (and can't find) a complete JavaScript API reference in order to freely create scripts.
    ATM it's just guesswork (or trial & error) which makes things inefficient.
    (If such exists, I'm happy to stand corrected).

    I saw that this was requested back in 2019: JavaScript API Reference

    My suggestion (just for reference) is to lay it out like GSAP has done with their stuff; https://greensock.com/docs/v3
    Or at least a compact list of all variables, methods, classes and their respective properties.

    Otherwise a super promising platform. Looking forward diving deep into this.
    //Charles

    • 4 replies
    1. S
      SoundFlow Bot @soundflowbot
        2022-11-01 16:12:42.998Z

        Thanks for contacting SoundFlow support.

        Please note, that the best way to get help with a script, macro or other content installed from the Store or content that you've made yourself, is to select the script/macro, then click the red Need help button, and then click "Get help with this script or macro".
        By using this method, we will get access to more information and so should be able to help you quicker.
        You can read more about how this works here: bit.ly/sfscripthelp

        If you're seeing an error that isn't related to scripts or macros, and you think this is a bug in SoundFlow, please file a Help/Issue bug report.
        You can see how to do this by going to bit.ly/sfhelpissue

        1. In reply toCharles_Elmi:
          Kitch Membery @Kitch2022-11-01 17:38:14.068Z

          Hi @Charles_Elmi,

          Thanks for reaching out.

          You can find complete reference of all Javascript functions here:
          https://soundflow.org/docs/api/globals

          You may also find the following two videos helpful. :-)

          1. In reply toCharles_Elmi:

            Hi Charles,

            We completely agree :) In fact, the new website we worked on over the summer and launched in September was the foundation for a lot of the work we're doing behind the scenes on improving the documentation.

            For now, this is the best we have:

            https://soundflow.org/docs/api/globals

            We also recommend learning the platform through making macros, and then using the "Convert to Script" feature.

            1. Oops cross posted with Kitch's reply.