Skip to main content

​
Requirements

  • Bright SDK for TizenOS requires Tizen 6.5 or newer
  • Latest Bright SDK version for Tizen (supports Tizen 2.4 and above)
  • Latest Tizen Studio installed
1

Create App ID on Dashboard

If you haven’t done this yet, log in to your dashboard and create your app ID first.Format: It generally consists of a 10-character alphanumeric package ID followed by a project name (e.g., brightdata.actionGames).
2

Extract SDK Framework

Download the latest Bright SDK from the Bright SDK Dashboard, unzip it.
  1. SDK Structure:
sample_app
└── sdk
    ├── consent
    │   └── brd_api.js
    └── service
        ├── peer_node
        ├── util
        ├── sdk_service.js
        ├── service.js
        └── Ver_conf.js
  1. SDK Overview:
    • sample_app - Demonstrates possible integration options. Represents the general architecture of Tizen TV applications and can also be used for Tizen Web Applications.
    • SDK Integration Components:
      1. service directory - The main engine containing all logic required to run the SDK. Must be copied next to your other services.
      2. brd_api.js - Frontend interface implementing the consent screen. Must be integrated with your application’s frontend.
3

Integrate Bright SDK in Your Code

  1. Prepare the Files: Copy Service Folder - copysdk/servicefolder to your project. Add Service to config.xml - Add the following to yourconfig.xml: 
<tizen:privilege name='http://tizen.org/privilege/alarm'/> 

<tizen:service id="brdsample0.Service">

    <tizen:content src="service/service.js"/>

    <tizen:name>WebUIService</tizen:name>

    <tizen:description>WebUIService</tizen:description>

    <tizen:metadata key="meta-key" value="meta-value"/>

    <tizen:category name="http://tizen.org/category/service"/>

</tizen:service>
Important: Replace brdsample0 with your package ID.
Package ID Naming Tip: After creating a Tizen app, we recommend changing the package ID to something more readable using your partner ID from the Control Panel.Examples:blUqHYQcnKEE.actionGames → brightdata.actionGamessuper_games → SuperGames (remove illegal characters)
The tizen_ prefix will be added automatically by the SDK.
  1. Embed SDK Dialog in Your Code: You can use sample_app as a reference. Import brd_api.js
    • Copy brd_api.js into your app directory.
    • Import it from the main file responsible for app initialization.
    • After brd_api.js execution, the brd_api global object will be available.
<!DOCTYPE html>
<html>
  <head>
...
    <script src=brd_api.js></script>
  </head>
  <body>
...
  </body>
</html>
  1. Add SDK Initialization: Call brd_api.init() after page load to access all SDK methods. Example: 
<!DOCTYPE html>
<html>
  <head>
...
    <script>
      window.onload = function(){
  var api_settings = {
    app_name: 'BrightData Tizen Sample',
          app_logo: 'icon_130.png',
        };
        try {
    brd_api.init(api_settings, {
            on_failure: function(message){
              console.log('init failure. Error: ', message);
            },
            on_success: function(){ console.log('init success'); },
          });
        } catch(e){
          console.error(e); 
        }
      };
    </script>
...
  </head>
  <body>
...
  </body>
</html>
Consent behavior:
  • On first call brd_api.init() will show a consent screen.
  • The user must agree or disagree.
  • Get the result by setting the on_status_change callback.
  • The consent screen handles TV remote control input.
  • You must disable your remote input processing when the consent screen is shown.
  • on_status_change will be called after the consent screen is closed.
4

Add Opt-In/Out Settings Option

SHARED CONTENT - will add
5

Custom Consent Screen (optional)

SHARED CONTENT - will add
6

App Performance

SHARED CONTENT - will add
7

Build Your App

Build your app using the Tizen CLI command.Important: Clean BuildRemove all dynamic files from the app and service folders before building. Examples: logs, service/data/*.*
8

Self-check your integration

SHARED CONTENT - will add
9

Update Your Terms of Service

SHARED CONTENT - will add
10

Submit Your Integration for review

SHARED CONTENT - will add

​
How to Update SDK

​
API Documentation