baxcloud_core

Headless BaxCloud foundation for Flutter SDKs and UI kits.

Features

  • BaxConfigprojectId, apiKey, optional bundleId / appVersion / buildNumber
  • BaxApiClient — tokens, rooms, call invites, push-token registration
  • BaxRoomSession — room credential session helper
  • BaxcloudUser — shared identity + custom metadata map + update / copyWith
  • Call models (BaxCallInvitation, BaxPushPlatform, …)
  • Analytics device + location metadata on token requests (OS, platform, model, versions, locale, country/continent)

Installation

dependencies:
  baxcloud_core: ^0.1.4
flutter pub get

Quick start

import 'package:baxcloud_core/baxcloud_core.dart';

var user = BaxcloudUser(
  userId: 'u1',
  name: 'Ada',
  avatarUrl: 'https://example.com/ada.png',
  metadata: {'role': 'host', 'locale': 'en'},
);

// Later — patch profile / custom map (mergeMetadata defaults to true)
user = user.update(name: 'Ada Lovelace', metadata: {'plan': 'pro'});

final config = BaxConfig(
  projectId: 'your-project-id',
  apiKey: 'bax_pk_your_client_key',
);

final client = BaxApiClient(config: config);
final creds = await client.createToken(
  BaxTokenRequest(
    roomName: 'lobby',
    userId: user.userId,
    userName: user.name,
    avatarUrl: user.avatarUrl,
    metadata: user.metadata,
  ),
);

Prefer a client key (bax_pk_…) from the dashboard.

Documentation

Resource Link
UI Kits overview baxcloud.tech/docs/uikits
Calls UI Kit baxcloud.tech/docs/uikits/calls
API authentication baxcloud.tech/docs/api/authentication
Site baxcloud.tech

When calling the HTTP API yourself, use https://api.baxcloud.tech.

License

MIT — see LICENSE.

Libraries

baxcloud_core
BaxCloud core — headless API and session foundation.