Spotikit #

A Flutter plugin for controlling Spotify playback on Android via the Spotify App Remote SDK.

Version 2.0.0 — App Remote only. No Web API, no client secret required.

Highlights #

• Connect to the Spotify App Remote with just a clientId and redirectUri
• Play / pause / resume / next / previous / seek / skip ±N seconds
• Realtime playback state stream (track, artist, progress, paused status, image URL)
• No client secret, no OAuth server-side flow, no token management

Platform Support #

Prerequisites #

1. A Spotify Developer account.
2. Create an app → copy the Client ID.
3. Add a redirect URI (e.g. your.app://callback) in the dashboard.
4. The Spotify app must be installed on the device.

No client secret is needed. Spotikit handles the OAuth flow automatically via the Spotify Auth SDK — it opens the Spotify login screen on first use, then connects the App Remote.

Installation & Required Android Init #

1. Add to pubspec.yaml:

   dependencies:
     spotikit: ^2.0.0
   

2. Fetch packages:

   flutter pub get
   

3. Required (once per clone / after cleaning android dir): run the init script to download the Spotify App Remote AAR and insert the Gradle include:

   dart run spotikit:android_init
   

   To use a custom redirect URI:

   dart run spotikit:android_init --fallback-url=your.app://callback
   

4. (Optional) To clean and re-initialise:

   dart run spotikit:android_clean && dart run spotikit:android_init
   

5. Ensure minSdkVersion >= 21.

Intent Filter (only if using a custom scheme/host) #

<intent-filter>
  <action android:name="android.intent.action.VIEW" />
  <category android:name="android.intent.category.DEFAULT" />
  <category android:name="android.intent.category.BROWSABLE" />
  <data android:scheme="your.app" android:host="callback" />
</intent-filter>

Quick Start #

import 'package:spotikit/spotikit.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  final spotikit = Spotikit.instance;
  spotikit.configureLogging(loggingEnabled: true);

  await spotikit.initialize(
    clientId: 'YOUR_CLIENT_ID',
    redirectUri: 'your.app://callback',
  );

  // Opens the Spotify login screen (if not already authorized),
  // then connects the App Remote automatically.
  await spotikit.connectToSpotify();

  await spotikit.playUri(spotifyUri: 'spotify:track:4cOdK2wGLETKBW3PvgPWqT');

  spotikit.onPlaybackStateChanged.listen((state) {
    print('Now playing: ${state.name} by ${state.artist} — ${(state.progress * 100).toStringAsFixed(1)}%');
  });
}

Initialization #

await Spotikit.instance.initialize(
  clientId: 'YOUR_CLIENT_ID',
  redirectUri: 'your.app://callback',
  connectToRemote: true, // optionally connect immediately
);

Playback State Stream #

spotikit.onPlaybackStateChanged.listen((state) {
  print('Track : ${state.name}');
  print('Artist: ${state.artist}');
  print('Paused: ${state.isPaused}');
  print('Progress: ${state.positionMs}/${state.durationMs} ms');
  print('Image URL: ${state.imageUrl}');
});

SpotifyPlaybackState fields:

Control API #

Track Info #

getPlayingTrackInfo() returns a SpotifyTrackInfo? with fields:

Logging #

spotikit.configureLogging(
  loggingEnabled: true,       // verbose info logs (default: false)
  errorLoggingEnabled: true,  // error logs (default: true)
);

Error Handling #

Native issues surface as PlatformException. Spotikit wraps initialization failures in a SpotikitException.

Common error codes from native:

Dev Scripts #

dart run spotikit:android_init   # REQUIRED after adding plugin / fresh clone / cleaning android
dart run spotikit:android_clean  # Optional helper (then rerun android_init)

Roadmap #

• iOS support
• Shuffle / repeat control
• Queue management
• Volume control
• Context metadata

Contributing #

1. Fork / branch
2. Implement + update example / docs
3. flutter format . & fix analyser warnings
4. Open a PR with a description and test notes

License #

MIT © 2026 spotikit contributors

Attribution #

Uses the Spotify App Remote SDK. Not affiliated with or endorsed by Spotify AB.

Support #

Issues / ideas: https://github.com/ArdaKoksall/spotikit/issues

Enjoy building with Spotikit! 🎧