A Dart SDK for fetching WebRTC ICE (STUN/TURN) credentials from the Turnix.io API, with support for advanced options like regions, TTL, client IP, and per-call parameters.

• ✅ A free account at https://turnix.io
• 🔐 A Bearer API token from the TURNIX dashboard

• Fetch STUN/TURN credentials in a single call with built-in endpoint.
• Support for optional parameters: initiatorClient, receiverClient, room, ttl, fixedRegion, preferredRegion, clientIp.
• Automatic parsing of multiple URLs per ICE server.
• Provides expiresAt timestamp and real-time timeLeft handling for seamless credential renewal.
• Pure-Dart implementation: works in server-side Dart environments and anywhere dart:io is available.
• Retrieve Available Regions: list supported TURN regions (slug, city, name, status flags) via TurnixIO.getAvailableRegions.

Add turnix_dart as a dependency in your pubspec.yaml:

dependencies:
  turnix_dart: ^0.1.6

Then run:

dart pub get

Import the package:

import 'package:turnix_dart/turnix_dart.dart';

Fetch credentials:

final creds = await TurnixIO.getIceCredentials(
  apiToken: 'YOUR_API_TOKEN',
  room: 'chat-room-42',
  ttl: 600,
  clientIp: '203.0.113.5',
);

// Configure your RTCPeerConnection:
final pc = await createPeerConnection({
  'iceServers': creds.iceServers.map(
    (s) => {
      'urls': s.urls,
      if (s.username != null) 'username': s.username,
      if (s.credential != null) 'credential': s.credential,
    },
  ).toList(),
});

Use this method to fetch all TURN regions supported by Turnix. Each Region includes:

• slug: identifier (e.g. us-east)
• nat2: country code
• city and name
• lat, lon coordinates
• isOnline and isOperational flags

// Fetch regions
final regions = await TurnixIO.getAvailableRegions(
  apiToken: 'YOUR_API_TOKEN',
);

// Print JSON-encoded list
print(
  'Available regions: ${jsonEncode(regions.map((region) => region.toString()).join(","))}',
);

All parameters are optional. Pass only those you need:

The IceCredentials object exposes:

• iceServers: a list of IceServer(urls, username?, credential?) for your RTCPeerConnection.
• expiresAt: a DateTime after which credentials are invalid.

Schedule refreshes by comparing expiresAt to DateTime.now():

final now = DateTime.now();
final timeLeft = creds.expiresAt.difference(now);
if (timeLeft < Duration(seconds: 30)) {
  creds = await TurnixIO.getIceCredentials(apiToken: 'YOUR_API_TOKEN');
}

See the example/ directory for a demo script showing usage and credential parsing.

Contributions and issues are welcome! Please open a PR or issue on GitHub.

This package is released under the MIT License. See LICENSE for details.

MIT License

Copyright (c) YEAR Turnix

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.