Music Kit

https://pub.dev/packages/music_kit
Admin
Music Kit is a Flutter plugin that provides access to and playback of Apple Music on Android and iOS...
Tokens:1,840
Snippets:21
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Initialize and Control Music Playback

Source: https://pub.dev/packages/music_kit/versions/1.2.1

Demonstrates how to import the package, instantiate the MusicKit object, set the playback queue, start playback, and listen for player state changes.

```dart
import 'package:music_kit/music_kit.dart';

var musicKit = MusicKit();

await musicKit.setQueue(item.type, item: item.toJson());

await musicKit.play();

musicKit.onMusicPlayerStateChanged.listen((MusicPlayerState state) {
  // Do something with new state
});
```

--------------------------------

### Install music_kit_platform_interface via CLI

Source: https://pub.dev/packages/music_kit_platform_interface/install

Use the Flutter CLI to add the package as a dependency to your project. This command automatically updates your pubspec.yaml file.

```bash
flutter pub add music_kit_platform_interface
```

--------------------------------

### Add dependency to pubspec.yaml

Source: https://pub.dev/packages/music_kit_platform_interface/install

Manually add the package to your project's configuration file to ensure the correct version is installed.

```yaml
dependencies:
  music_kit_platform_interface: ^1.2.0
```

--------------------------------

### Initialize and Control Music Playback

Source: https://pub.dev/packages/music_kit

Demonstrates how to instantiate the MusicKit service, set the playback queue, initiate playback, and listen for player state changes. Requires a valid developer token and user token for initialization.

```dart
import 'package:music_kit/music_kit.dart';

var musicKit = MusicKit();

// Set Queue
await musicKit.setQueue(item.type, item: item.toJson());

// Play
await musicKit.play();

// Be informed when the player state changes
musicKit.onMusicPlayerStateChanged.listen((MusicPlayerState state) {
  // Do something with new state
});
```

--------------------------------

### Initialize and Use MusicKit in Flutter

Source: https://pub.dev/packages/music_kit/versions/1.0.0

Demonstrates how to import, instantiate, and use the MusicKit plugin to control Apple Music playback. It includes setting the playback queue and handling player state changes.

```dart
import 'package:music_kit/music_kit.dart';

// Instantiate it
var musicKit = MusicKit();

// Set Queue
await musicKit.setQueue(item.type, item: item.toJson())

// Play
await musicKit.play();

// Be informed when the player state changes
musicKit.onMusicPlayerStateChanged.listen((MusicPlayerState state) {
  // Do something with new state
});

```

--------------------------------

### MusicKit Initialization and Playback

Source: https://pub.dev/packages/music_kit

Endpoints and methods for initializing the MusicKit instance and controlling media playback.

```APIDOC
## initialize(developerToken, musicUserToken)

### Description
Initializes the MusicKit instance with required authentication tokens. This must be called before any other MusicKit methods.

### Method
Dart Method

### Parameters
- **developerToken** (String) - Required - The Apple Music developer token.
- **musicUserToken** (String) - Optional - The user-specific Apple Music token.

## setQueue(type, item)

### Description
Sets the playback queue for the music player.

### Method
Dart Method

### Parameters
- **type** (String) - Required - The type of the media item.
- **item** (Map) - Required - The media item data in JSON format.

## play()

### Description
Starts playback of the currently set queue.

### Method
Dart Method

## onMusicPlayerStateChanged

### Description
A stream that emits events whenever the music player state changes.

### Response
- **state** (MusicPlayerState) - The new state of the music player.
```

--------------------------------

### Initialize MusicKit and Manage Playback State

Source: https://pub.dev/packages/music_kit/example

This snippet demonstrates how to initialize the MusicKit plugin, listen to stream updates for subscription and player states, and request necessary tokens for Apple Music access.

```dart
import 'package:flutter/material.dart';
import 'dart:async';
import 'package:music_kit/music_kit.dart';

class _MyAppState extends State<MyApp> {
  final _musicKitPlugin = MusicKit();
  MusicPlayerState? _playerState;
  late StreamSubscription<MusicPlayerState> _playerStateStreamSubscription;

  @override
  void initState() {
    super.initState();
    _playerStateStreamSubscription = _musicKitPlugin.onMusicPlayerStateChanged.listen((event) {
      setState(() {
        _playerState = event;
      });
    });
  }

  @override
  void dispose() {
    _playerStateStreamSubscription.cancel();
    super.dispose();
  }
}
```

--------------------------------

### Initialize and Control Apple Music Playback

Source: https://pub.dev/packages/music_kit/versions/1.1.0

This snippet demonstrates how to instantiate the MusicKit class, set a playback queue, initiate playback, and subscribe to player state changes. It requires the music_kit package to be imported and initialized within a Flutter environment.

```dart
import 'package:music_kit/music_kit.dart';

// Instantiate it
var musicKit = MusicKit();

// Set Queue
await musicKit.setQueue(item.type, item: item.toJson());

// Play
await musicKit.play();

// Be informed when the player state changes
musicKit.onMusicPlayerStateChanged.listen((MusicPlayerState state) {
  // Do something with new state
});
```

--------------------------------

### Configure Android Repository

Source: https://pub.dev/packages/music_kit

Add the JitPack repository to your Android build configuration to resolve the music_kit dependencies. This is a mandatory step for Android integration.

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

--------------------------------

### Import package in Dart

Source: https://pub.dev/packages/music_kit_platform_interface/install

Include the package in your Dart source files to access the platform interface definitions.

```dart
import 'package:music_kit_platform_interface/music_kit_platform_interface.dart';
```

--------------------------------

### Control Apple Music Playback

Source: https://pub.dev/packages/music_kit/example

This snippet shows how to interact with the MusicKit player by setting the shuffle mode, requesting authorization, and queuing media for playback.

```dart
TextButton(
  onPressed: () async {
    await _musicKitPlugin.setQueue(albumFolklore['type'], item: albumFolklore);
    await _musicKitPlugin.play();
  },
  child: const Text('Play an Album')
)
```
Tokens:
Raw