IFrame player

Our web app https://app.syrinscape.com can be embedded directly in your site.

The player interface has a responsive design that should work at small and large sizes. The GM interface needs a large area.

Users will need to interact with the iframe (click) to activate the audio context. Our GM and player interfaces will prompt users to activate.

Get started

1. Ask the GM and any users who have Syrinscape accounts to provide you with their auth token, which they can get at https://syrinscape.com/online/cp/.

   Or request an auth token for each anonymous user:

   HTTP

   GET https://app.syrinscape.com/config/ HTTP/1.1
   accept: application/json
   

2. Request the session ID for the GM:

   HTTP

   GET https://app.syrinscape.com/config/ HTTP/1.1
   accept: application/json
   authorization: token {TOKEN}
   

3. Distribute the GM's session ID to all users via your own means.

4. Load our player interface in an iframe:

   HTML

   <iframe src="https://app.syrinscape.com/{SESSION_ID}/player/?auth_token={TOKEN}"></iframe>
   

   Optionally configure a device name:

   HTML

   <iframe src="...&device_name={DEVICE_NAME}"></iframe>
   

   Info

   If no device name is provided, we will use the Syrinscape account nickname for authenticated users or a random name for anonymous users.

5. Control the session via HTTP or load our GM interface instead of the player interface:

   HTML

   <iframe src="https://app.syrinscape.com/{SESSION_ID}/?auth_token={TOKEN}"></iframe>
   

   Info

   The GM interface requires a much larger iframe. You can also open it in a new window.