https://github.com/bertrandmartel/youtubetv
:tv: YouTube embedded player library for Android TV
https://github.com/bertrandmartel/youtubetv
android-library android-tv webview youtube-iframe youtube-player-api
Last synced: 8 days ago
JSON representation
:tv: YouTube embedded player library for Android TV
- Host: GitHub
- URL: https://github.com/bertrandmartel/youtubetv
- Owner: bertrandmartel
- License: mit
- Created: 2016-11-10T17:47:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-24T19:47:43.000Z (over 6 years ago)
- Last Synced: 2025-04-19T20:17:31.420Z (25 days ago)
- Topics: android-library, android-tv, webview, youtube-iframe, youtube-player-api
- Language: Java
- Homepage:
- Size: 2.76 MB
- Stars: 61
- Watchers: 5
- Forks: 23
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# YoutubeTV library
[](https://circleci.com/gh/bertrandmartel/youtubetv)
[ ](https://bintray.com/bertrandmartel/maven/youtubetv/_latestVersion)
[](https://maven-badges.herokuapp.com/maven-central/fr.bmartel/youtubetv)
[](https://www.codacy.com/app/bertrandmartel/youtubetv?utm_source=github.com&utm_medium=referral&utm_content=bertrandmartel/youtubetv&utm_campaign=Badge_Grade)
[](http://javadoc-badge.appspot.com/fr.bmartel/youtubetv)
[](LICENSE.md)
YouTube embedded player library for Android TV
## Purpose
* to embed Youtube videos in your own Android TV application with [Youtube Player API for iframe Embeds](https://developers.google.com/youtube/iframe_api_reference)
* to provide an alternative to [the lack of Youtube Android Player API on Android TV platform](https://code.google.com/p/gdata-issues/issues/detail?id=6998)
Download YoutubeTv library Showcase from Google Play :
[](https://play.google.com/store/apps/details?id=fr.bmartel.youtubetv.showcase)
## Features
* a custom view `YoutubeTvView` that embeds a Webview with Youtube iframe
* a custom fragment `YoutubeTvFragment` that holds a `YoutubeTvView` with a media control bar (`PlaybackOverlayFragment`)
* all Javascript API for [iframe Embeds](https://developers.google.com/youtube/iframe_api_reference) are available from `YoutubeTvView`
* video autoplay
* a video thumbnail is shown at the beginning waiting for the player to be ready
* a loading progress bar is shown waiting for the `PLAY` status
## Include in your project
with Gradle, from jcenter :
```
compile 'fr.bmartel:youtubetv:1.2'
```
Minimum SDK : 21
## YoutubeTvView
`YoutubeTvView` is the custom view that holds Youtube iframe inside a `Webview`.
#### Layout
```
```
#### Attribute list
| attribute name | format | default value | description |
|----------------|-------------|---------------|----------------|
| yt_videoId | string | | Youtube video Id |
| yt_playlistId | string | | playlist Id (if video is part of a playlist) |
| yt_videoQuality | enum | hd1080 | suggested quality |
| yt_showNowPlayingCard | boolean | true | define if now playing card must be shown or not |
| yt_showRelatedVideos | boolean | false | display related video when video ends |
| yt_showVideoInfo | boolean | false | show video info before playing video |
| yt_showControls | enum | none | define if iframe control bar is shown (auto/always/none) |
| yt_autoHide | enum | alwaysVisible | control iframe control bar visibility (auto/always/none) |
| yt_closedCaptions | boolean | false | display closed captions |
| yt_closedCaptionLangPref | string | | closed captions preference language |
| yt_playerLanguage | string | | youtube player language |
| yt_videoAnnotation | boolean | false | display video annotations |
| yt_debug | boolean | false | active/disactive debug mode |
| yt_loadingBackgroundColor | integer | #00000000 | set loading background color |
| yt_autoplay | boolean | true | autoplay the video or initiate on click |
| yt_userAgentString | string | iphone(*) | user agent string used for the Webview |
| yt_showBorder | boolean | false | define if a thin border is shown when the View is selected |
| yt_borderWidth | integer | 2 | selection border width in dp (no effect if showBorder not set) |
| yt_borderColor | color | Color.BLUE | selection border color (no effect if showBorder not set)
| yt_thumbnailQuality | enum | maxresdefault | suggested quality for the thumbnail displayed before the video plays |
| yt_javascriptTimeout | integer | 1500 | timeout value in ms for Javascript API that return values from JS side |
(*) There is currently a bug on regular `android` user agent string that restricts video quality to `large` and below. The bug doesn't affect `desktop`, `iphone` or `ipad` user agent string. So, in order to have quality `hd720` or `hd1080` we must change user agent string.
* suggested `videoQuality`
* auto
* tiny
* small
* medium
* large
* hd720
* hd1080
* highres
* hd1440
* hd2160
* suggested `thumbnailQuality`
* auto
* hqdefault
* mqdefault
* sddefault
* maxresdefault
## YoutubeTvFragment
`YoutubeTvFragment` holds a `YoutubeTvView` with a `PlaybackOverlayFragment` that is used to display a media control bar.
#### Usage
* in your `Activity`'s `onCreate` :
```
FragmentTransaction fTransaction = getFragmentManager().beginTransaction();
Bundle args = new Bundle();
args.putString("videoId", "gdgHZi347hU");
args.putString("videoQuality", "hd1080");
YoutubeTvFragment mYtFragment = YoutubeTvFragment.newInstance(args);
fTransaction.replace(R.id.youtube_fragment, mYtFragment);
fTransaction.commit();
```
## Proguard
The following is required to keep Javascript interface from obfuscation :
```
-keep class fr.bmartel.youtubetv.JavascriptInterface { *; }
-keepclassmembers,allowobfuscation class fr.bmartel.youtubetv.JavascriptInterface.** {
;
}
```
## External libraries
* YoutubeTv library
* [leanback-v17](https://developer.android.com/reference/android/support/v17/leanback/package-summary.html)
* Showcase application
* [leanback-v17](https://developer.android.com/reference/android/support/v17/leanback/package-summary.html)
* [gson](https://github.com/google/gson)
* [picasso](https://github.com/square/picasso)
## License
The MIT License (MIT) Copyright (c) 2016 Bertrand Martel