搜索插件、代码仓与 APP 分类

插件详情v0.16.1

spotify

一个不完整的 Dart 库,用于与 Spotify Web API 进行交互。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
5530
喜欢数
102
Pub 分数
160

安装插件

flutter pub add spotify

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

一个 Dart 库,提供对 Spotify Web API 的部分集成,使 Flutter 应用能够与 Spotify 的音乐和音频服务进行交互。虽然功能尚不完整,但它提供了访问用户数据、播放列表、歌曲和搜索功能的基础功能。专为开发音乐类应用的开发者设计,支持 Android、iOS、Web、macOS、Windows 和 Linux 等多个平台。该库积极维护且开源,允许社区贡献。它是 Flutter 项目中实现更深入 Spotify 集成的起点。

适合场景

  • 音乐应用开发
  • 用户播放列表管理
  • 搜索曲目和艺术家
  • Spotify 认证流程
  • 音频内容发现

主要特点

  • 部分 Spotify Web API 支持
  • 跨平台兼容性
  • 开源且由社区驱动
  • 身份验证集成
  • 基本数据检索用于曲目和播放列表

适合对象

  • Flutter 开发人员构建音乐应用
  • 需要 Spotify 数据访问权限的项目
  • 跨平台音频应用
  • 初学者探索 Spotify API

使用建议

  • 功能集不完整
  • 需要手动处理缺失的端点
  • 有限的文档
  • 依赖外部 API 的更改
  • 未经额外验证,不适用于生产环境

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

spotify-dart Pub Dart CI

A Dart library for interfacing with the Spotify API.

Installation | Features | Quick Start | Authorization | Features & Bugs | Contributing

Installation

Add spotify to your pubspec.yaml:

dependencies:
  spotify: ^0.16.1

Alternatively, run

dart pub add spotify

and the latest version will be added automatically.

Finally, run dart pub get to install the package.

Features

This library provides comprehensive access to Spotify's Web API:

Core Content
  • Artists - Get artist info, top tracks, related artists, and albums
  • Tracks - Retrieve track details and metadata
  • Albums - Access album information and track listings
  • Playlists - Browse, get, create, and modify playlists
  • Shows & Episodes - Full podcast support
  • Search - Search across all content types (artists, tracks, albums, playlists, shows, episodes)
  • Browse - Discover new releases, featured playlists, and categories
  • Categories - Browse categories with market and locale support
User Features (requires authentication)
  • User Profile - Access current user information via me endpoint
  • Playback Control - Control playback, manage queue, get available devices
  • Library Management - Manage saved tracks, albums, shows, and episodes
  • User History - Access top items and recently played tracks
  • Following - Follow/unfollow artists and users
Additional Capabilities
  • Pagination - Efficient handling of large result sets with Pages<T> and CursorPages<T>
  • Market Support - Country-specific content filtering
  • Multiple Auth Flows - Client credentials and authorization code grant (with PKCE support)
  • OAuth Scopes - Comprehensive authorization scope management

Note: Related Artists, Audio Features, Audio Analysis, Featured Playlists, Category Playlists and Recommendation endpoints are deprecated by Spotify but still available in this library.

Quick Start

Simple Example (Client Credentials)
import 'package:spotify/spotify.dart';

void main() async {
  final credentials = SpotifyApiCredentials(clientId, clientSecret);
  final spotify = SpotifyApi(credentials);

  // Get artist info
  final artist = await spotify.artists.get('0OdUWJ0sBjDrqHygGUXeCF');
  print(artist.name); // 'Band of Horses'

  // Search for tracks
  var search = await spotify.search.get('metallica').first(2);
  print(search.first.items); // List of albums, artists, tracks, etc.
}
Working with Pagination

Many endpoints return paginated results:

// Get all tracks from an album
var tracks = await spotify.albums.getTracks(albumId).all();

// Get first N items
var featured = await spotify.playlists.featured.first(5);

// Stream through pages
await for (var page in spotify.playlists.getUsersPlaylists(userId).stream()) {
  print(page.items);
}

Authorization

This library supports multiple authorization flows:

  • Client Credentials Flow - For accessing public data (artists, albums, tracks, etc.)
  • Authorization Code Grant - For accessing user data and controlling playback
  • PKCE Support - Enhanced security for public clients

For detailed information on authorization flows, OAuth scopes, and advanced usage, see the wiki.

PKCE (Public Client) Authentication

For mobile apps and single-page applications that cannot securely store client secrets, use PKCE:

// Generate a secure code verifier
final verifier = SpotifyApi.generateCodeVerifier();

// Create PKCE credentials (no client secret needed!)
final credentials = SpotifyApiCredentials.pkce(
  'your-client-id',
  codeVerifier: verifier,
);

// Complete OAuth flow
final grant = SpotifyApi.authorizationCodeGrant(credentials);
final authUri = grant.getAuthorizationUrl(redirectUri, scopes: scopes);
// ... redirect user, get authorization code
final client = await grant.handleAuthorizationResponse(params);
final spotify = SpotifyApi.fromClient(client);

// Save credentials for later (including codeVerifier!)
final creds = await spotify.getCredentials();
// Store creds.codeVerifier along with other credential fields

// Restore later
final spotify = await SpotifyApi.asyncFromCredentials(restoredCreds);

See example/example_pkce.dart for a complete working example.

Features and bugs

Please file feature requests and bugs at the issue tracker.

Contributing

Contributions are welcome! Here's how to work on this project:

Development Setup
  1. Clone the repository
  2. Run dart pub get to install dependencies
Generating JSON Serializers

This project uses json_serializable for model serialization:

  • Run dart run build_runner build to generate serializers
  • Run dart run build_runner watch to continuously rebuild when files change
Code Quality

Before committing, ensure your code passes:

  • Formatting: dart format .
  • Analysis: dart analyze
Running Tests

Run the test suite:

dart test
Running Examples

To run the basic example:

dart run example/example.dart

You'll need to modify the file to include your Spotify client ID and secret.

For the authenticated example (accessing user data, playback control) run:

dart run example/example_auth.dart

This example will prompt you for a redirect URL and guide you through the OAuth flow to access features like currently playing tracks and available devices.

所属分类

依赖

依赖清单 4 项

源码仓库

使用此插件的项目

暂无相关数据。