Last updated
Last updated
Before integrating the Webplayer, ensure your project meets the following requirements:
version 18 or higher
version 5 or higher
You can install the Webplayer using npm or yarn. Choose your preferred package manager and run the following command:
npm install @syncstreamai/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 or :
SyncstreamProvider Component
In the examples above, notice that the SyncstreamProvider
component takes one property:
OneTap Component
In the examples above, notice that the OneTap
component takes two properties:
use Recoup's Webplayer
! 🎉Once you've wrapped your app with the SyncstreamProvider, you can now use it throughout your components and pages via the OneTap
!
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. to convert any Spotify song or album URL into a URI. Please refer to the for more information about this.
campaignId
(Required) Your campaign ID assigned by Recoup.
signInRequired
(Optional) Use this to add a blur overlay and prevent the user from accessing the site without first connecting a streaming provider.
spotifyDefaultLink
Optional.
Spotify URI of the context to play. Valid contexts are albums, artists & playlists. "spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"
A JSON array of the Spotify track URIs to play. For example: ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]
Recoup's Webplayer is the easiest way to bring Spotify & Apple Music into your app.