Create an account and get credentials
Set up your project and collect the stream key and token your app needs
To broadcast or view a stream, your app authenticates with Native Frame using a token and a stream key. This guide walks you through creating an account and collecting those credentials so you can start building.
Prerequisites
- An email address you can use to sign up for Native Frame.
Procedure
Stream your first video
No code required — the dashboard can publish and play a stream on its own, which is the fastest way to confirm your account works.
The dashboard is shared infrastructure: one dashboard serves every product built on the NativeFrame platform, so its address does not change from product to product. An older platform. link redirects to the same place and still works.
- Sign up or sign in to the dashboard at dashboard.nativeframe.com.
- Create a project to group your streams, tokens, and settings. If this is your first time, project creation is part of onboarding, so you will already have one. If you have onboarded before, open the projects dropdown in the side navigation and choose New project.
- Create a stream. Open your project, select the Streams tab, then Create stream in the top-right corner.
- Get your RTMP URL and stream key. On the Streams page, click the options button for your stream — the three-dot ⋮ button at the far right of its row — then expand Streaming URL. The RTMP URL starts with
rtmp://; your key is under Stream Key. - Start streaming. Paste the RTMP URL and stream key into streaming software and start streaming. Using OBS? Stream with OBS covers where those two values go, plus scene and audio setup.
- Watch it play. Back on the Streams page, click your stream — a red dot next to the name means it is live. Open the Stream Playback tab and choose Play Stream.
- Get a playback URL to play the stream outside the dashboard. Open the ⋮ options button again, expand Playback URL, and copy either JSON Manifest or Master HLS Manifest.
Get the credentials your app needs
Once you have seen a stream play, these are the values a Native Frame client needs to broadcast or view one from your own code.
- Copy your backend endpoint — the host your client connects to. It takes the form
https://your-subdomain.nativeframe.com, where the subdomain is specific to your account. - Generate an API token to authenticate your app.
Your stream key is the third value, and you already have it from Get your RTMP URL and stream key above.
Result
You have a stream that plays, and the credentials your own code needs to broadcast or view one.
| What you have | What it does | From |
|---|---|---|
| RTMP URL + stream key | Where streaming software publishes to, and the key that identifies the stream. | Get your RTMP URL and stream key |
| Playback URL | A JSON or HLS manifest for playing the stream outside the dashboard. | Get a playback URL |
| Backend endpoint | The host your client connects to, in the form https://your-subdomain.nativeframe.com. | Copy your backend endpoint |
| Authentication token (JWT) | Authorises the client. | Generate an API token |
If you only wanted to see a stream work, you are done. To build it into your own app, keep the stream key, backend endpoint, and token to hand: you supply all three when you build a broadcaster and a viewer in the Quickstart.