https://github.com/jellyfin/jellyfin-sdk-kotlin

Kotlin SDK for Jellyfin, supporting Android and JVM targets
https://github.com/jellyfin/jellyfin-sdk-kotlin

android java jellyfin jvm kotlin ktor openapi3 sdk

Last synced: 3 days ago
JSON representation

Kotlin SDK for Jellyfin, supporting Android and JVM targets

• Host: GitHub
• URL: https://github.com/jellyfin/jellyfin-sdk-kotlin
• Owner: jellyfin
• License: lgpl-3.0
• Created: 2018-12-22T19:14:06.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T21:50:19.000Z (3 months ago)
• Last Synced: 2024-10-30T00:00:38.566Z (3 months ago)
• Topics: android, java, jellyfin, jvm, kotlin, ktor, openapi3, sdk
• Language: Kotlin
• Homepage: https://kotlin-sdk.jellyfin.org
• Size: 102 MB
• Stars: 87
• Watchers: 9
• Forks: 42
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        

Jellyfin Kotlin SDK

Part of the Jellyfin Project



---
































































---

The Kotlin SDK for Jellyfin implements the Jellyfin API to easily access servers. It is currently available

for the JVM and Android. Developer documentation is available at [kotlin-sdk.jellyfin.org].

[kotlin-sdk.jellyfin.org]: https://kotlin-sdk.jellyfin.org/guide/getting-started.html

## Contributing

We welcome contributions to the SDK. Open an issue or ask in our official chats if you plan to make bigger changes.

To validate binary compatibility we use the [Binary compatibility validator] tool from the Kotlin team. When creating

pull requests the api files need to be updated. Use the `apiDump` Gradle task to generate the api files. Add the changes

from this command to a separate commit to make the review process easier.

[Binary compatibility validator]: https://github.com/Kotlin/binary-compatibility-validator

## Testing

The SDK includes two example projects, the kotlin-cli and java-cli, to test various larger functions like server

discovery. Besides that we use unit tests to test smaller components, these can be executed with the `allTests` Gradle

task. We recommend adding new tests for changes to the

code.

### Testing in app

It is also possible to test a new version of the SDK in your own app. Use the `publishToMavenLocal` Gradle task to

publish the SDK to your local system, afterwards you can add `mavenLocal()` as repository and use the `latest-SNAPSHOT`

version for the SDK. This process is simplified in our official apps by adding an option to the `gradle.properties`

file.