패키지, 저장소 및 앱 카테고리 검색

패키지 상세v4.3.4

spotify_sdk

Spotify SDK 및 인증 라이브러리와 통신할 수 있는 플러터 플러그인

30일 다운로드
3.3천
좋아요
162
Pub 점수
160

패키지 설치

flutter pub add spotify_sdk

패키지 개요

공개 정보를 바탕으로 생성한 선택 가이드입니다.

spotify_sdk 패키지는 Flutter 플러그인으로, Spotify SDK 및 인증 라이브러리와의 통합을 가능하게 하여 개발자가 Flutter 애플리케이션 내에서 Spotify의 음악 서비스와 상호작용할 수 있도록 합니다. 사용자 인증, 재생 제어, Spotify의 풍부한 음악 데이터에 대한 접근을 용이하게 합니다. Spotify의 API와 원활한 통신을 위해 설계되어 앱에 음악 기능을 쉽게 통합할 수 있게 합니다. Android 및 iOS 플랫폼 모두를 지원하지만, 플랫폼별 설정이 필요할 수 있습니다. tobibusch.dev에서 유지보수되며 커뮤니티 기여를 위한 GitHub에 호스팅되어 있습니다.

사용 사례

  • Spotify 로그인 및 인증 통합
  • 앱 내에서 음악 재생 제어
  • 사용자의 플레이리스트 및 트랙 표시
  • 음악 탐색 기능 구축
  • 앱에서 곡 공유 활성화
  • 장치 간 재생 상태 동기화

주요 기능

  • Spotify OAuth2 인증
  • 재생 제어(재생/일시정지/탐색)
  • 사용자 프로필 및 플레이리스트에 대한 액세스
  • 트랙 및 앨범 메타데이터 지원
  • 실시간 재생 상태 업데이트
  • 크로스 플랫폼 호환성

적합한 대상

  • 음악 스트리밍 앱
  • 팟캐스트 플레이어 통합
  • 소셜 음악 공유 기능
  • 개인화된 플레이리스트 빌더
  • 스포티파이를 사용한 개발자 프로토타이핑
  • 오프라인 음악 동기화가 필요한 앱

고려 사항

  • Spotify 개발자 계정이 필요합니다
  • 스포티파이 대시보드에서 올바른 앱 등록이 필요합니다
  • 플랫폼별 구성이 필요합니다
  • Spotify의 API 범위 권한에 제한됨
  • 백그라운드 재생을 위해 추가 처리가 필요할 수 있습니다
  • 완전한 기능을 위해 외부 Spotify SDK에 의존합니다

원본 README

연결된 소스 저장소의 README 원문 스냅샷입니다. 최신 내용은 저장소에서 확인하세요.

spotify_sdk

pub.dev build build


Description

This is a flutter package that wraps the native iOS and Android Spotify "remote" SDKs as well as the Spotify Web Playback SDK for web. Since it wraps the native SDKs it has the same features and limitations.

[!IMPORTANT] Upgrading to 4.0.0? Check out the 4.0.0 Migration Guide for important migration instructions regarding Android zero-configuration setup, Spotify Android Auth SDK v5.0.0 manifest registration, and typed SpotifyException domain error handling.

Setup

Android

This package uses both the Spotify App Remote SDK and the Spotify Authentication Library.

From the Spotify Android SDK Quick Start, you need to do the following:

  1. Register your app in the Spotify Developer Portal. Add your package name, a SHA-1 fingerprint of your signing certificate, and a Redirect URI in the app settings on the dashboard.
  2. Register the Redirect Activity: Inside the <application> tag of your android/app/src/main/AndroidManifest.xml file, declare the RedirectUriReceiverActivity (note the .browser. in the package path required by Spotify Auth SDK v5.0.0):
<activity
    android:name="com.spotify.sdk.android.auth.browser.RedirectUriReceiverActivity"
    android:exported="true">
    <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="spotify-sdk"
            android:host="auth"/>
    </intent-filter>
</activity>

[!WARNING] You must use the exact class name com.spotify.sdk.android.auth.browser.RedirectUriReceiverActivity. The old manifestPlaceholders in app/build.gradle are no longer supported.

  1. No SDK Download Needed: The plugin automatically resolves, downloads, and configures the spotify-app-remote library AAR file during compilation. You do not need to manually download AAR files or edit your settings.gradle file.
iOS

Register your app in the spotify developer portal. You also need to register your Bundle ID as well as a Redirect URI.

Follow the instructions in the section Setup the iOS SDK of Spotify iOS SDK Quick Start.

Web
  1. Register your app in the spotify developer portal. You need to provide a redirect URL which points to a dedicated page on a website you own.

  2. Paste the following onto the webpage, which you linked to in your redirect URL.

<!DOCTYPE html>
<html>
  <head>
    <title>Authenticating Spotify</title>
  </head>
  <body>
	<p>Please wait while we authenticate Spotify...</p>
	<script type="text/javascript">
		if(window.opener) {
			window.opener.postMessage('?' + window.location.href.split('?')[1], "*");
		} else {
			window.close();
		}
	</script>
  </body>
</html>
  1. Optionally add this to your Flutter app web/index.html to avoid a Javascript TypeError: r.__extends is not a function error in development mode.
<script src="https://sdk.scdn.co/spotify-player.js"></script>
<script>
  window.onSpotifyWebPlaybackSDKReady = (evt) => {};
</script>

You need Spotify Premium to access the Web SDK.

Usage

To start using this package first import it in your Dart file.

import 'package:spotify_sdk/spotify_sdk.dart';

To connect to the Spotify app you can call connectToSpotifyRemote(...) or getAccessToken(...). In both of these methods you need the client id, which you will find in the Spotify developer dashboard and the redirect url you set there for that specific client.

await SpotifySdk.connectToSpotifyRemote(clientId: "", redirectUrl: "")

Subscribe to PlayerState or PlayerContext streams only after connecting successfully

SpotifySdk.subscribePlayerState();
SpotifySdk.subscribePlayerContext();

If you want to use the web api as well you have to use this method to get the access token. You can specify multiple scopes by separating them with a comma "," as shown below. For more information on scopes you can refer to Spotify Authorization Scopes Guide

final accessToken = await SpotifySdk.getAccessToken(clientId: "", redirectUrl: "", scope: "app-remote-control,user-modify-playback-state,playlist-read-private");

On Web you can use the token that you get from getAccessToken(...) and then pass it to connectToSpotifyRemote(...). This will avoid having to send user through two Spotify OAuth prompts. You should not persist this token, nor supply a different token, because the refresh token is only set interally by getAccessToken or connectToSpotifyRemote.

On iOS you can store the token that you get from getAccessToken(...) and then pass it to connectToSpotifyRemote(...) during the next session. This will avoid having to switch to the Spotify app for establishing the connection. This library does not handle storing the token. It is up to you to persist it wherever you see fit. Keep in mind that this feature is currently quite buggy in the native iOS SDK and has many side effects like random disconnections. Proceed with caution.

On iOS Spotify starts playing music when attempting connection. This is a default behavior and there is no official way to prevent this with the currently supported authentication flows. You have the option to pass a Spotify URI upon connection or set it to a blank string to play the last played song. There is an undocumented workaround if you don't want music to start playing which is to pass an invalid Spotify URI instead. This is not officially supported by the Spotify SDK or this library and it can fail or stop working at any time!

Have a look in the example for detailed insights on how you can use this package.

Token Swap & Utilities

If your application architecture uses an intermediate backend to exchange Spotify authorization codes and protect your Client Secret, you can retrieve the raw authorization code using getSwapToken(...):

final authorizationCode = await SpotifySdk.getSwapToken(
  clientId: "YOUR_CLIENT_ID",
  redirectUrl: "YOUR_REDIRECT_URL",
  scope: "app-remote-control,user-modify-playback-state",
);

You can also check if the native Spotify application is installed on the user's device:

final isInstalled = await SpotifySdk.isSpotifyInstalled();
Error Handling

The SDK provides strongly-typed domain exceptions extending SpotifyException:

try {
  await SpotifySdk.connectToSpotifyRemote(
    clientId: 'YOUR_CLIENT_ID',
    redirectUrl: 'YOUR_REDIRECT_URL',
  );
} on SpotifyNotInstalledException catch (e) {
  // Prompt user to install Spotify
} on SpotifyAuthenticationException catch (e) {
  // Handle auth failure or user cancellation
} on SpotifyConnectionException catch (e) {
  // Handle remote connection errors
} on SpotifyPlaybackException catch (e) {
  // Handle playback or track seek errors
} on SpotifyException catch (e) {
  // Handle any general Spotify error (e.message, e.code, e.cause)
}
Api
Connecting/Authenticating
Function Description Android iOS Web
connectToSpotifyRemote Connects the App to Spotify ✔ ✔ ✔
getAccessToken Gets the Access Token that you can use to work with the Web Api ✔ ✔ ✔
getSwapToken Gets an OAuth Authorization Code for custom token swap backend servers ✔ ✔ ✔
isSpotifyInstalled Checks if the Spotify application is installed on the device ✔ ✔ ✔
disconnect Disconnects the app connection ✔ ✔ ✔
subscribeConnectionStatus Subscribes to the current connection status. ✔ ✔ ✔
Player Api

The playerApi as described here.

Function Description Android iOS Web
getCrossFadeState Gets the current crossfade state ✔ ✔ ✔
getPlayerState Gets the current player state ✔ ✔ ✔
pause Pauses the current track ✔ ✔ ✔
play Plays the given spotifyUri ✔ ✔ ✔
queue Queues given spotifyUri ✔ ✔ ✔
resume Resumes the current track ✔ ✔ ✔
seekTo Seeks the current track to the given position in milliseconds ✔ ✔ ✔
seekToRelativePosition Adds to the current position of the track the given milliseconds ✔ ✔ ✔
setPodcastPlaybackSpeed Set playback speed for Podcast ✔ ❌ ❌
setRepeatMode Set the repeat mode ✔ ✔ ✔
setShuffle Set the shuffle mode ✔ ✔ ✔
skipNext Skips to next track ✔ ✔ ✔
skipPrevious Skips to previous track ✔ ✔ ✔
skipToIndex Skips to track at specified index in album or playlist ✔ ✔ ✔
subscribePlayerContext Subscribes to the current player context ✔ ✔ ✔
subscribePlayerState Subscribes to the current player state ✔ ✔ ✔
toggleRepeat Cycles through the repeat modes ✔ ✔ ✔
toggleShuffle Cycles through the shuffle modes ✔ ✔ ✔

On Web, an automatic call to play may not work due to media activation policies which send an error: "Authentication Error: Browser prevented autoplay due to lack of interaction". This error is ignored by the SDK so you can still present a button for the user to click to play or resume to start playback. See the Web SDK Troubleshooting guide for more details.

Images Api

The imagesApi as described here.

Function Description Android iOS Web
getImage Get the image from the given spotifyUri ✔ ✔ ✔
User Api

The userApi as described here.

Function Description Android iOS Web
addToLibrary Adds the given spotifyUri to the users library ✔ ✔ ✔
getCapabilities Gets the current users capabilities ✔ ✔ ✔
getLibraryState Gets the current library state ✔ ✔ ✔
removeFromLibrary Removes the given spotifyUri to the users library ✔ ✔ ✔
subscribeCapabilities Subscribes to the current users capabilities ✔ ✔ ✔
subscribeUserStatus Subscribes to the current users status ✔ ✔ ✔
Connect Api

The connectApi as described here.

Function Description Android iOS Web
switchToLocalDevice Switch to play music on this (local) device ✔ ❌ ✔

Migration

spotify-auth: moving from locally sourced aar to maven central

spotify-auth SDK is now retrieved via Maven Central instead of being sourced from an AAR file

  • Steps to remove the locally sourced spotify-auth SDK:
    • android/settings.gradle -> remove ':spotify-auth'
    • android/spotify-auth/build.gradle -> remove file
    • android/spotify-auth/spotify-auth-release-x.x.x.aar -> remove file

Official Spotify Docs

카테고리

의존성

의존성 목록 4 개

  • spotify_sdk_android^4.3.4
  • spotify_sdk_ios^4.3.4
  • spotify_sdk_platform_interface^4.3.4
  • spotify_sdk_web^4.3.4

소스 저장소

이 패키지를 사용하는 프로젝트