Skip to content

Android SDK

Current version: v1.0.0

Native Android player built with Jetpack Compose and ExoPlayer (Media3).

Requirements

  • Android Studio (latest)
  • Minimum SDK 23 (Android 6.0)
  • Kotlin 1.9+
  • An active xStreams stream ID and token endpoint

Installation

Option A: Download the AAR

  1. Download from CDN:
    https://cdn.xstreams.io/sdk/android/xstreams-player-1.0.0.aar
  2. Copy it into your project's libs/ folder.
  3. Add to your build.gradle.kts:
    kotlin
    implementation(files("libs/xstreams-player-1.0.0.aar"))
  4. Sync Gradle.

Option B: Maven (coming soon)

kotlin
implementation("com.xstreams:player:1.0.0")

Usage

kotlin
import com.xstreams.player.XStreamsPlayer
import com.xstreams.player.XStreamsPlayerConfig
import com.xstreams.player.XStreamsPlayerView

// In your Composable:
val config = XStreamsPlayerConfig(
    streamId = "YOUR_STREAM_ID",
    tokenEndpoint = "https://api.yoursite.com/api/v1/ssai/YOUR_STREAM_ID/token/",
    streamKey = "sk_abc123...",
)

val player = remember { XStreamsPlayer(config) }

XStreamsPlayerView(player = player)

// Start playback:
player.play()

// Clean up:
DisposableEffect(Unit) {
    onDispose { player.destroy() }
}

Features

  • HLS live playback via ExoPlayer (Media3)
  • Ad break support (SSAI)
  • Picture-in-Picture
  • Background audio
  • Quality selection
  • Silent token refresh
  • Jetpack Compose UI

See also

Live streaming infrastructure for developers.