https://github.com/dinaraparanid/yt-url-extractor-kt
Extractor of media files from the YouTube for Android, based on Ktor library
https://github.com/dinaraparanid/yt-url-extractor-kt
android-library coroutines coroutines-flow kotlin kotlin-android ktor ktor-client youtube-extractor youtube-livestream youtube-music youtube-video
Last synced: 3 months ago
JSON representation
Extractor of media files from the YouTube for Android, based on Ktor library
- Host: GitHub
- URL: https://github.com/dinaraparanid/yt-url-extractor-kt
- Owner: dinaraparanid
- License: gpl-3.0
- Created: 2023-11-06T00:02:30.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-18T15:43:38.000Z (over 1 year ago)
- Last Synced: 2025-01-15T00:27:26.274Z (5 months ago)
- Topics: android-library, coroutines, coroutines-flow, kotlin, kotlin-android, ktor, ktor-client, youtube-extractor, youtube-livestream, youtube-music, youtube-video
- Language: Kotlin
- Homepage:
- Size: 96.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YtUrlExtractorKt
[](http://kotlinlang.org)
[](https://jitpack.io/#dinaraparanid/yt-url-extractor-kt)
## **Developer**
[Paranid5](https://github.com/dinaraparanid)
## **About Library**
Android library to extract media files from YouTube.
Library utilises Kotlin Coroutines and is built on top of [Ktor client library](https://ktor.io/) as an extension function.
## **Setup**
1. Add network permission to your manifest:
```
```
2. Add this code snippet to your build.graddle or settings.gradle file:
**Kotlin DSL:**
```kotlin
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
maven { setUrl("https://jitpack.io") } // <- add this
}
}
```
**Groovy DSL:**
```groovy
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
maven { url 'https://jitpack.io' } // <- add this
}
}
```
3. Add the dependency to your app level build.gradle:
```kotlin
dependencies {
implementation("com.github.dinaraparanid:yt-url-extractor-kt:x.y.z.w")
}
```
```groovy
dependencies {
implementation 'com.github.dinaraparanid:yt-url-extractor-kt:x.y.z.w'
}
```
## **Example**
1. Create Ktor client:
```Kotlin
private const val USER_AGENT =
"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.98 Safari/537.36"
fun KtorClient() = HttpClient(OkHttp) {
install(UserAgent) {
agent = USER_AGENT
}
install(HttpRequestRetry)
install(HttpTimeout) {
connectTimeoutMillis = null
}
install(ContentNegotiation) {
json(Json { ignoreUnknownKeys = true })
}
install(Logging) {
logger = Logger.ANDROID
level = LogLevel.ALL
}
}
```
2. Extract files by URL with an extension function:
```Kotlin
val extractRes: Result = withTimeoutOrNull(timeMillis = 4500) {
ktorClient.extractYtFilesWithMeta(
context = context,
ytUrl = ytUrl
)
} ?: YtFailure(YtRequestTimeoutException())
val (
ytFiles: Map, // Itag to media file
liveStreamManifestsRes: Result, // DASH and HLS stream manifests
videoMetaRes: Result // Video metadata
) = when (val res = extractRes.getOrNull()) {
null -> onExtractionError(extractRes.exceptionOrNull()!!)
else -> res
}
val videoMeta: VideoMeta = when (val res = videoMetaRes.getOrNull()) {
null -> onExtractionError(videoMetaRes.exceptionOrNull()!!)
else -> res
}
val liveStreamManifests = when (val res = liveStreamManifestsRes.getOrNull()) {
null -> onExtractionError(liveStreamManifestsRes.exceptionOrNull()!!)
else -> res
}
// Extract desired url (e.g. itag = 140 for audio files)
val audioUrl: String? = when (videoMeta?.isLiveStream) {
true -> liveStreamManifests.hlsManifestUrl
else -> ytFiles[DEFAULT_AUDIO_TAG]?.url
}
if (audioUrl == null)
onExtractionError(YtFilesNotFoundException())
```
### Samples
1. [Streaming of audio and livestreaming with Exoplayer](https://github.com/dinaraparanid/Crescendo/blob/24ed03bc2d72006aa5637a9aade568746331778d/app/src/main/java/com/paranid5/crescendo/domain/services/stream_service/StreamService.kt#L694)
2. [Extract and cache audio files](https://github.com/dinaraparanid/Crescendo/blob/24ed03bc2d72006aa5637a9aade568746331778d/app/src/main/java/com/paranid5/crescendo/domain/services/video_cache_service/VideoCacheService.kt#L199)
## **System Requirements**
**Android 5.0** or higher
## **License**
*GNU Public License V 3.0*