Skip to main content

dart_plex 0.3.2 copy "dart_plex: ^0.3.2" to clipboard
dart_plex: ^0.3.2 copied to clipboard

Dart client for Plex Media Server and plex.tv. Supports JWT sign-in, library browsing, playlists, streaming, search and more, on Android, iOS, Linux, macOS, Windows and the web.

example/dart_plex_example.dart

// Copyright © 2026 & onwards, Alessandro Di Ronza <ales.drnz@gmail.com>.
// All rights reserved.
// Use of this source code is governed by BSD 3-Clause license that can be found in the LICENSE file.

import 'package:dart_plex/dart_plex.dart';

Future<void> main() async {
  final plex = PlexClient(
    credentials: const PlexCredentials(
      clientIdentifier: 'example-client-id',
      product: 'MyApp',
      version: '1.0.0',
      device: 'CLI',
      deviceName: 'example',
      platform: 'macOS',
    ),
    // Opt in to resending GET/HEAD after network failures, 502/503/504/429.
    retryPolicy: const PlexRetryPolicy(),
  );

  try {
    // Sign in with a device key; persist key and token with
    // session.toJson() to skip this next time.
    final key = await PlexDeviceKey.generate();
    var pin = await plex.account.createJwtPin(key: key);
    print('Sign in at ${plex.account.authAppUrl(pin)}');
    while (!pin.isAuthenticated) {
      if (pin.isExpired) return;
      await Future<void>.delayed(const Duration(seconds: 1));
      pin = await plex.account.pollJwtPin(id: pin.id, key: key);
    }
    await plex.useJwt(
      PlexJwtSession(key: key, token: PlexJwt.parse(pin.authToken!)),
    );

    final resources = await plex.account.fetchResources();
    final server = resources.firstWhere((r) => r.owned && r.isServer);
    final connection = await plex.connectToResource(server);
    print(
      'Reached ${server.name} at ${connection.uri} (${connection.kind.name})',
    );

    final identity = await plex.server.identity();
    print('Connected to ${server.name} (PMS ${identity.version})');

    final sections = await plex.library.sections();
    for (final s in sections) {
      print('${s.title} (${s.type.name})');
    }

    final music = sections.where((s) => s.type == PlexLibraryType.music);
    if (music.isEmpty) return;

    // Walk the first 200 albums, 50 per request.
    final albums = PlexPaging.items(
      (start, size) async => (await plex.library.allByType(
        sectionId: music.first.id,
        type: PlexMetadataType.album,
        sort: PlexSort.titleSort,
        start: start,
        size: size,
      )).items,
      pageSize: 50,
      limit: 200,
    );
    await for (final album in albums) {
      final count = album.leafCount ?? 0;
      print('${album.parentTitle} - ${album.title} ($count tracks)');
    }

    // Start a 128 kbps AAC transcode of a recently added album's first track.
    final recent = await plex.library.recentlyAdded(
      sectionId: music.first.id,
      size: 1,
    );
    if (recent.isEmpty) return;
    final tracks = await plex.library.children(
      ratingKey: recent.first.ratingKey,
    );
    if (tracks.isEmpty) return;
    final transcode = await plex.streaming.startAudioTranscode(
      ratingKey: tracks.first.ratingKey,
      session: 'example-session',
      maxAudioBitrateKbps: 128,
    );
    print('Playable: ${transcode.decision.isPlayable}\n${transcode.url}');
    await plex.streaming.stopUniversal(session: transcode.session);
  } on PlexException catch (e) {
    print('Plex call failed: $e (transient: ${e.isTransient})');
  } finally {
    plex.close();
  }
}
6
likes
160
points
1.28k
downloads
screenshot

Documentation

API reference

Publisher

verified publisherales-drnz.com

Weekly Downloads

Dart client for Plex Media Server and plex.tv. Supports JWT sign-in, library browsing, playlists, streaming, search and more, on Android, iOS, Linux, macOS, Windows and the web.

Repository (GitHub)
View/report issues

Topics

#plex #media-server #music #streaming #api-client

License

BSD-3-Clause (license)

Dependencies

cryptography, http, meta, web_socket_channel

More

Packages that depend on dart_plex