Connect SDK Android

Build Status Code Coverage Maven Central Apache License, 2.0 Twitter

Connect SDK is an open source framework that connects your mobile apps with multiple TV platforms. Because most TV platforms support a variety of protocols, Connect SDK integrates and abstracts the discovery and connectivity between all supported protocols. This project can be built in Android Studio or directly with Gradle. Eclipse IDE is not supported since 1.5.0 version.

For more information, visit our website.

Dependencies

This project has the following dependencies, some of which require manual setup. If you would like to use a version of the SDK which has no manual setup, consider using the lite version of the SDK.

This project has the following dependencies.

Including Connect SDK in your app with Android Studio

Edit your project's build.gradle to add this in the "dependencies" section

dependencies {
    //...
    compile 'com.connectsdk:connect-sdk-android:1.6.0'
}

This prebuilt library doesn't have Amazon Fling SDK support, because it’s not available on maven. You need to set the project up from sources if you want to have Amazon Fling SDK support.

Including Connect SDK in your app with Android Studio from sources

  1. Open your terminal and execute these commands

    cd your_project_folder
git clone https://github.com/ConnectSDK/Connect-SDK-Android.git
cd Connect-SDK-Android
git submodule update --init

  2. On the root of your project directory create/modify the settings.gradle file. It should contain something like the following:

    include ':app', ':Connect-SDK-Android'

  3. Edit your project's build.gradle to add this in the "dependencies" section:

    dependencies {
    //...
    compile project(':Connect-SDK-Android')
}

  4. Setup FireTV submodule

  5. Sync project with gradle files

  6. Add permissions to your manifest

Permissions to include in manifest

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

Metadata for application tag

This metadata tag is necessary to enable Chromecast support.

<application ... >
    ...

    <meta-data
        android:name="com.google.android.gms.version"
        android:value="@integer/google_play_services_version" />

</application>

Proguard configuration

Add the following line to your proguard configuration file (otherwise DiscoveryManager won't be able to set any DiscoveryProvider).

-keep class com.connectsdk.**       { * ; }

Tests

Connect SDK has unit tests for some parts of the code, and we are continuing to increase the test coverage. These tests are based on third party libraries such as Robolectric, Mockito and PowerMock. You can easily run these tests with Gradle:

gradle test

Also the project has a target for generating test coverage report with Jacoco. Use this command for generating it.

gradle jacocoTestReport

The test coverage report will be in this folder Connect-SDK-Android/build/reports/jacoco/jacocoTestReport/html.

Limitations/Caveats

Subtitles

Contact

Credits

Connect SDK for Android makes use of the following projects, some of which are open-source.

These projects are used in tests:

License

Copyright (c) 2013-2015 LG Electronics.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.