Quickstart
SyncStream is the easiest way to bring Spotify & Apple Music into your app.
Prerequisites
Before integrating SyncStream, ensure your project meets the following requirements:
React version 18 or higher
TypeScript version 5 or higher
Installation
You can install SyncStream using npm or yarn. Choose your preferred package manager and run the following command:
npm install @syncstreamai/syncstream
Set Up Your App with SyncStream
After installing the package, import the SyncstreamProvider
component into your project and wrap your app with it. The SyncStreamProvider should wrap any component or page that will use SyncStream. It is recommended to place it as close to the root of your application as possible.
Example NextJS or Create React App:
Property Descriptions
SyncstreamProvider Component
In the examples above, notice that the SyncstreamProvider
component takes one property:
Property | Description |
---|---|
clientId | (Required) Your app or artist's client ID assigned by your SyncStream point-of-contact. |
signInRequired | (Optional) Use this to add a blur overlay and prevent the user from accessing the site without first connecting a streaming provider. |
OneTap Component
In the examples above, notice that the OneTap
component takes two properties:
Property | Description |
---|---|
spotifyDefaultLink | Optional.
|
The URI, or Uniform Resource Indicator, is a unique code that identifies a specific element on Spotify or Apple Music, such as an artist, album, track, playlist, or user. Click here to convert any Spotify song or album URL into a URI. Please refer to the Spotify documentation for more information about this.
Just use syncstream-ai
! 🎉
use syncstream-ai
! 🎉Once you've wrapped your app with the SyncstreamProvider, you can now use the it throughout your components and pages via the OneTap
!
Last updated