Managing Your Tokens

To get started, log into your Dolby.io Real-time Streaming account and select Live Broadcast from the left menu. Here you can create and manage your stream tokens.

Your Dolby.io Real-time Streaming tokens are used for authenticating both publishers and viewers. It provides authentication to allow publishing a live stream to your account, and manages viewer permissions.

Creating a Publishing Token

Begin by creating a token using the Add (+) button. This will open a popup window on your screen containing various options for your new Token.

Let's go over each section in a bit more detail.

The Token Label gives you a simple labeling system you can use to keep track of your tokens. You can use it to label what the tokens are for, or identify testing tokens from your production ones, its entirely up to you.

When the Record Broadcast button is set to enabled, it will record all broadcasts using that token. After you stop your broadcast, you can find your recordings in the Recordings section of the dashboard.

The Secure Viewer button has two settings, "No Restrictions" (default) which allows anyone with the link to your viewer to watch your live broadcast without restriction or authorization. The alternate setting, "Token Required", restricts your broadcast and only allows users to view the stream if they provide the correct token authorization.

You can create a valid subscription token for your viewer via a simple API call here.

The next section deals with stream names which are used to differentiate your broadcasts from one another. You must use unique stream names in order for your multiple live broadcasts to work concurrently and not conflict. Those who are using the API instead of the dashboard must be cautious of this rule when generating your tokens. To create unique stream names in the dashboard, you simply need to choose how many stream names you want and the dashboard automatically generates unique names for you.

Stream names require the user of the token to broadcast with a specific stream name. This provides your broadcast path with a bit of obscurity protection in case your token was compromised.

The next option in this section, called the Wild Card (.*), gives your token the ability to use ANY arbitrary stream name in the publishing path. The only rule to note here is for anyone using their own viewer, they must know what stream name the broadcaster is using in order to view the stream correctly. To enable this from the dashboard UI, be sure the checkbox is selected before you click ok.

The last section allows you to make your token temporary by giving the token an expiration date.

Note:
While setting the date and time, be sure that it is set for the future or it will display an error.

Click on the arrows above and below each section respectively to set the expiration date. Once the date and time have passed, the token will automatically become invalid.

You will also see an Advanced tab, in this tab you can configure more advanced settings.
Allowed Origins: If specified only the domains in list will be allowed in requests to Director API with token. Wildcard subdomains are also allowed, e.g.: "*.demo.com". When unspecified (empty) there are no domain restrictions.
Allowed IP Addresses: May specify multiple IPv4 addresses or CIDR notated network blocks. If specified the token will only be usable by those addresses.
Cluster region: Specifies the cluster used for streaming. This setting is configured to use the default regional cluster set for the account. If Auto is selected, the regional cluster is selected based on the publisher's location. For more information, see Multi-region Support.
Geo-Blocking: Enables Geo-blocking for this specific Token. For more information, see GEO-blocking.
Multisource: Enables Multisource streaming. For more information, see Multisource streams.
Thumbnail previews: Enables previewing a thumbnail image of your video stream. Thumbnails are delivered via a webhook. For more information, see Thumbnail hooks.

For more on using this feature, see our API section here

After you have successfully created your token it will be displayed in a scrollable list.

The token credential can also be used to securely broadcast your live stream using any 3rd party application that can support the WebRTC connection protocol, such as modern web browsers, mobile SDKs, and your own custom applications.

Dolby.io Real-time Streaming also provides you with a special version of OBS that will allow you to broadcast your WebRTC HD feed from your desktop to the Dolby.io Real-time Streaming CDN.

To learn more about streaming to Dolby.io Real-time Streaming with OBS, read Using OBS.

Management Screen

Each token item has a quick action menu that provides you with options for doing most major processes like broadcasting, and deleting.

To learn more about this menu in detail see Using the Quick Action Menu on the How to Broadcast page.

Even though the quick action menu provides you with certain management control, the real control lies within the manage UI for each token.

To open the manage view simply click the settings button from the item’s action menu.

The manage screen allows you to edit and view details attached to your token including stream names, labels, status, stream id, disable token, renew token, broadcast live, record and delete.

It also shows the API information to broadcast from your own 3rd party applications with sample code to easily initiate a handshake with Dolby.io Real-time Streaming from your application.

Finally you can also see the recordings associated to that token.

In the next sections we will learn more about each feature and how to use it.

Stream Names

As mentioned earlier, when a stream name is specified it will require the user of the token to use a specific stream name in order to broadcast. Within the management view you are able to add and delete stream names as you see fit.

To add a new name simply click on the (+) CREATE button on Token Streams tab, which will initiate a popup similar to the add token interface, but here you have more detailed options.

The same rules for a new stream name also apply here. To delete a stream name simply select it from the list and click the remove button.

To delete a stream name simply select it from the list and click the trash button.

Token Settings

The token settings, like Token Label and Status, can be managed easily through the user interface. Below is a simple breakdown.

Record

The recording button allows you to record all your Live Broadcasts. You can enable this feature by toggling the record button to the "on" state. This can also be done from the Web Broadcaster when you click the Broadcast button.

Token Status

The token status shows us that the token is active or disabled. Although a temporary token changes this automatically, you can manually change it yourself by clicking the status button on the screen. This acts as a toggle function that switches the token’s status from enabled to disabled respectively.

Multisource

The Multisource feature allows you to use multiple input streams. You can enable this feature by toggling the Multisource button to the "on"state. For more information, see Multisource streams.

Thumbnail previews

Enables previewing a thumbnail image of your video stream. Thumbnails are delivered via a webhook. For more information, see Thumbnail hooks.

Cluster region

Specifies the cluster used for streaming. This setting is configured to use the default regional cluster set for the account. If Auto is selected, the regional cluster is selected based on the publisher's location. For more information, see Multi-region Support.

Security Settings

You can configure the Allowed origins, IP filter type, Allowed IP addresses, Secure viewer, and Geo-blocking settings.

Allowed origins

If specified only the domains in list will be allowed in requests to Director API with token. Wildcard subdomains are also allowed, e.g.: "*.demo.com". When unspecified (empty) there are no domain restrictions.

IP filter type

Allows you to filter by IP address or on usage. If "On Usage" is selected, it will bind the token to the first X IP addresses used. For more information, see Binding to an IP.

Allowed IP addresses

May specify multiple IPv4 addresses or CIDR notated network blocks. If specified the token will only be usable by those addresses.

Secure viewer

The Secure Viewer button has two settings, the default one "No Restrictions" allows anyone with the link to your viewer to watch your live broadcast without restriction or authorization. The alternate setting, "Token Required", restricts your broadcast and only allows viewers to subscribe to it if they provide the correct token authorization. To create a valid token see Subscription Tokens in our API Docs.

Note:
This will not disrupt any live feed that is currently broadcasting.

Geo-blocking

Enables Geo-blocking for this specific Token. For more information, see GEO-blocking.

Delete Token

You can delete the token by simply clicking on the delete button, on the Management screen:

Or directly from the item itself on the tokens list:

Recordings

The recordings section displays a limited view of the most latest recordings.

You can click on More Files button which will take you to the Recordings page and display all the video files associated to that stream name.

To learn more about the Recordings page see Recordings.

Publishing API

Using the online broadcaster is quick and convenient but you might want to use a third party application or develop your own. This is where you would use our API, as it gives you access to your Dolby.io Real-time Streaming services from outside of the dashboard.

The API section displays the unique publishing and viewing information to connect to the API as well as a couple quick examples to help you get started.

To learn how to use the API information see How to Broadcast in Javascript

Renewing Token

The renew token feature lets you generate a new serial number for your token. You can use this if you think the original token was compromised, or simply to ensure that any previous users will no longer be able to use the original token.

Note:
This cannot be undone. Once you have renewed the token’s serial number, the old one is gone. Please be sure you want to renew the token before proceeding.

Embed Player Code

Dolby.io Real-time Streaming provides a hosted, embeddable player that can be used within an iFrame on your website, or simply shared with your peers.

You can edit the hosted player on the Playback tab. This will provide you with an interface that allows you to manipulate the iFrame code to customize the hosted player.

Note:
In order for the Auto Play feature to work in browsers, the Mute at Start feature must also be enabled. This is a required security policy currently forced by browser vendors. https://developers.google.com/web/updates/2017/09/autoplay-policy-changes