Fishjam Android Client

Android client library for Fishjam.

Documentation

Documentation is available here.

Installation

Add jitpack repo to your build.gradle:

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

Add the dependency:

 dependencies {
   implementation 'com.github.fishjam-dev:android-client-sdk:<<version>>'
 }

Usage

Make sure you have:

• Running Fishjam server.
• Created room and token of peer in that room. You can use dashboard example to create room and peer token.

You can refer to our minimal example on how to use this library.

Development

1. Set FISHJAM_SOCKET_URL in ~/.gradle/gradle.properties to your dev backend.
2. Run ktlint to format code (if missing, install it with brew install ktlint)
3. Run release-it to release. Follow the prompts, it should add a commit and a git tag and jitpack should pick it up automatically and put the new version in the jitpack repo.

Contributing

We welcome contributions to this SDK. Please report any bugs or issues you find or feel free to make a pull request with your own bug fixes and/or features.`

Fishjam Ecosystem

Client SDKs	React, React Native, iOS, Android
Server SDKs	Elixir, Python, OpenAPI
Services	Videoroom - an example videoconferencing app written in elixir Dashboard - an internal tool used to showcase Fishjam's capabilities
Resources	Fishjam Book - theory of the framework, Docs, Tutorials
Membrane	Fishjam is based on Membrane, Discord
Compositor	Compositor - Membrane plugin to transform video
Protobufs	If you want to use Fishjam on your own, you can use our protobufs

Copyright and License

Copyright 2023, Software Mansion

Licensed under the Apache License, Version 2.0