Skip to content

Latest commit

 

History

History
86 lines (67 loc) · 3.3 KB

README.md

File metadata and controls

86 lines (67 loc) · 3.3 KB

YouTubeExtractor

A helper to extract the streaming URL from a YouTube video using RxJava, Retrofit, Moshi, and others.

Build Status

Gradle Dependency

Add this in your root build.gradle file (not your module build.gradle file):

allprojects {
	repositories {
		...
		maven { url "https://jitpack.io" }
	}
}

Then, add the library to your project build.gradle

dependencies {
    implementation 'com.github.Commit451:YouTubeExtractor:latest.version.here'
}

Usage

If you are familiar with RxJava, the extractor returns a Single:

val extractor = YouTubeExtractor.Builder()
            .build()
extractor.extract("9d8wWcJLnFI")
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe({ extraction ->
        bindVideoResult(extraction)
    }, { t ->
        onError(t)
    })

Note: the above example also requires RxAndroid for AndroidSchedulers

You can also extract the result right away:

// Don't do this on the main thread!
val extraction = extractor.extract("9d8wWcJLnFI")
    .blockingGet()

Video Playback

This library was only created to extract video stream URLs from YouTube, not provide a video player. ExoMedia is a great library for playing the video streams to the user. See the sample app for an example.

ProGuard/R8

This library uses OkHttp, Moshi and Rhino under the hood, so you may need to apply their rules.

Notes

This library is intentionally being kept pretty "lightweight", with the main priority being the stream URLs.

Known Failure Points:

  • Videos that are age restricted
  • Videos that are audio only

It is worth noting that YouTube "alternatives" such as NewPipe are often removed from the Play Store due to licensing, so be cautious of this and other rules when using this library. We are not responsible for misfortune that comes from using this library.

Alternatives

There are lots of different libraries that are dedicated to YouTube playback, each with its own pros and cons. This library is dedicated primarily to loading video stream URLs. If you need something more, check out some of these other libraries:

License

Copyright 2020 Commit 451

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.