How to install the Broadcaster Starter Kit and integrate existing Application Source Code

You haves already created your application. You are now going a install the starter kit (including Framework) for the first time and migrate your application source code in it.

For the this scenario, we shall make the following assumptions:

Broadcaster’s Station ID are: ABYZ and PQRS

Broadcaster’s application source code resides at:
/Public/detroit/
Broadcaster’s GSID looks like:
https://doi.org/10.666/AB-C911

Your main application source code resides at: /public/detroit
Your unique application configuration file (appList.json) resides at: /public/detroit/

Instructions

Install a fresh copy of the latest version of the Broadcaster Starter kit (including framework)

Integrating your existing Application Source Code:

Having installed and successfully run a fresh copy of the latest version of the Broadcaster Starter kit, it is now time to integrate your existing application source code.

The updated folder structure in Version 1.8 is designed on ‘Market/Station’ model. This makes integrating your existing application code very easy as it is simply a case of copy / pasting your entire application folder and editing two files (appsList.json and Bridge.json)

STEP 1

Copy your entire (existing) application folder
Paste this folder in /Public/ folder of your newly installed Broadcaster Starter kit.

STEP 2

Edit bridge.json file found under (/public/bridge-conf/1.0/). Either edit an existing service or add a new service with your own valid GSID value and point this new service to your own appList.json file. An example snippet for bridge.json is shown below:

"https://doi.org/10.666/AB-C911": {

            "bbandappList": "/detroit/appsList.json",

            "appDefault": {

				"appName": "abyz-trigger",

				"properties": {}

}

STEP 3

Now ensure that your appsList.json has your trigger application and your main application properly defined. Example snippets of appsList.json are show below:

For your trigger application:

"abyz-trigger": {

                "appRoot": "/run3tv-common/apps/triggers",

                "appEntry": "/cta.html",

                "properties": {

                    "linkApp": "ABYZ",

                    "hidden": false,

                    "timeout": 5,

                    "img": "/detroit/ABYZ/trigger/img/wxyz.png",

                    "hover": "/detroit/ABYZ/trigger/img/wxyz-hover.png"

}

and for your main application:

"ABYZ": {

                "appRoot": "/run3tv-common/apps/common-app",

                "appEntry": "/index.html",

                "properties": {

                    "back": {"properties": {"hidden": true}},

                    "menu": "/detroit/ABYZ/common-app/dynamic/menu/default-menu.json",

                    "settings": "/detroit/ABYZ/common-app/config/default-settings.json",

                    "menu-settings": "/detroit/ABYZ/common-app/config/menu-settings.json",

                    "style": "/detroit/ABYZ/common-app/css/default.css",

                    "amp": "/detroit/ABYZ/common-app/css/skin.css",

                    "resize": true,

                    "header": {"type": "channel", "title": {"en": "ABYZ", "es": "ABYZ"}, "id": "SRV3", "name": "ID-3", "logo": "/detroit/ABYZ/common-app/img/home-menu/channel.png"},

                    "panels-ttl": 300000,

                    "player-ttl": 15000

},

                "drm": null,

                "allowConfigDRM": true,

                "allowLocalStorage": true,

                "allowFrameworkStorage": true

}

This concludes the process of migrating your exiting application code into a newly installed Broadcaster Starter Kit.

Viewing in Local Emulator:

In order to view your newly added service in the local emulator, you need to add a new station in the emulator configuration file. Point this newly added station to your service that you just defined in bridge.json file (above).

Edit the atscCmd-2021.mc file found under /emulator/ folder appropriately. An example snippet showing how to add a new station and then point it to your new service is shown below:

        "com.run3tv.query.emulator": {

            "a3fa-appContextId": "tv:a3fa-apps.yottamedialabs.com",

            "a3fa-rmp": "https://your-server-url.com/assets/your-video.mp4",

            "a3fa-held": "http://localhost:5001/run3tv-common/"

},

        "org.atsc.query.service": {

            "service": ""https://doi.org/10.666/AB-C911""

},