Installation
The atmoky WebSDK comes as a node.js package and can be installed using npm
.
Setup npm
First you need to setup npm
to point to atmoky's private package registry and add your access token. To do so, open a terminal window and run the following commands:
# let npm know where to find @atmokyaudio packages
npm config set @atmokyaudio:registry https://gitlab.com/api/v4/projects/36729375/packages/npm/
# add access token
npm config set -- "//gitlab.com/api/v4/projects/36729375/packages/npm/:_authToken" "<your_token>"
info
In order to obtain an access token, please contact sales.
Install the SDK
Once npm
is set up, you can install the atmoky WebSDK package:
npm install @atmokyaudio/websdk
The latest version of the package will then be downloaded and installed. Once finished, you can import the package as follows:
import { * } from `@atmokyaudio/websdk`
Optional: Install Developer Tools
Optionally, you can also install the Developer Tools:
npm install @atmokyaudio/websdk-dev-tools
For info about the features and how to use them, see Developer Tools