Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osfunapps/connect-sdk-android-lite
Just my own implementation of the Connect-SDK-Android-Lite repository
https://github.com/osfunapps/connect-sdk-android-lite
Last synced: 27 days ago
JSON representation
Just my own implementation of the Connect-SDK-Android-Lite repository
- Host: GitHub
- URL: https://github.com/osfunapps/connect-sdk-android-lite
- Owner: osfunapps
- License: apache-2.0
- Created: 2023-12-13T15:01:45.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-13T18:54:16.000Z (about 1 year ago)
- Last Synced: 2023-12-14T16:42:28.671Z (about 1 year ago)
- Language: Java
- Size: 66.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# Connect SDK Android Lite
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.
This repository contains the lite version of the Connect SDK project, and does not include support for platforms that require heavy and/or external dependencies. For the full Connect SDK, clone the [main repository](https://github.com/ConnectSDK/Connect-SDK-Android).
For more information, visit our [website](http://www.connectsdk.com/).
* [General information about Connect SDK](http://www.connectsdk.com/discover/)
* [Platform documentation & FAQs](http://www.connectsdk.com/docs/android/)
* [API documentation](http://www.connectsdk.com/apis/android/)
## Dependencies
This project has the following dependencies.
* [Java-WebSocket library](https://github.com/TooTallNate/Java-WebSocket)
* [Connect-SDK-Android-Core](https://github.com/ConnectSDK/Connect-SDK-Android-Core) submodule
## Including Connect SDK in your app with Android Studio
Edit your project's build.gradle to add this in the "dependencies" section
```groovy
dependencies {
//...
compile 'com.connectsdk:connect-sdk-android-lite:1.6.0'
}
```
## 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-Lite.git
- cd Connect-SDK-Android-Lite
- 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:
```groovy
include ':app', ':Connect-SDK-Android-Lite'
```
3. Edit your project's build.gradle to add this in the "dependencies" section:
```groovy
dependencies {
//...
compile project(':Connect-SDK-Android-Lite')
}
```
4. Sync project with gradle files
5. Add permissions to your manifest
### Permissions to include in manifest
* Required for SSDP & Zeroconf discovery
- `android.permission.INTERNET`
- `android.permission.CHANGE_WIFI_MULTICAST_STATE`
* Required for interacting with devices
- `android.permission.ACCESS_NETWORK_STATE`
- `android.permission.ACCESS_WIFI_STATE`
* Required for storing device pairing information
- `android.permission.WRITE_EXTERNAL_STORAGE`
```xml
```
### 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
- DLNA service support `SRT` format only. Since there is no official specification for them, subtitles may not work on all DLNA-compatible devices. This feature has been tested and works on LG WebOS and Netcast TVs.
- Netcast service support `SRT` format only. It uses DLNA and has the same restrictions as DLNA service.
- WebOS service supports `WebVTT` format only. The server providing subtitles should support CORS headers.
## Contact
* Twitter [@ConnectSDK](https://www.twitter.com/ConnectSDK)
* Ask a question on Stack Overflow with the [Connect-SDK tag](https://stackoverflow.com/tags/connect-sdk) (or [TV tag](https://stackoverflow.com/tags/tv))
* General Inquiries [email protected]
* Developer Support [email protected]
* Partnerships [email protected]
## Credits
Connect SDK for Android makes use of the following open-source projects.
* [Java-WebSocket](https://github.com/TooTallNate/Java-WebSocket) (MIT)
* [JmDNS](http://jmdns.sourceforge.net) (Apache License, Version 2.0)
* [Android-DLNA](https://code.google.com/p/android-dlna/) (Apache License, Version 2.0)
## 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.