Flutter SDK API Reference

flutter pub get

1import 'package:baxcloud_client/baxcloud_client.dart';
2
3final client = BaxCloudClient(
4  projectId: 'your-project-id',
5  apiKey: 'your-api-key',
6);

1final room = await client.createRoom(
2  BaxcloudCreateRoomOptions(
3    roomName: 'meeting-123',
4    liveType: BaxcloudLiveType.videoConference,
5    maxParticipants: 50,
6  ),
7);
8
9print('Room created: ${room.roomName}');

await client.deleteRoom('meeting-123');

final rooms = await client.listRooms();
print('Total rooms: ${rooms.length}');

final room = await client.getRoom('meeting-123');
print('Room info: ${room}');

1final token = await client.getToken(
2  BaxcloudRoomOptions(
3    roomName: 'meeting-123',
4    participant: BaxcloudUser(
5      userId: 'user-1',
6      name: 'Alice',
7      avatarUrl: 'https://example.com/avatar.jpg',
8      isHost: true,
9    ),
10    liveType: BaxcloudLiveType.videoConference,
11  ),
12);
13
14print('Access token: ${token.token}');

1final room = await client.connect(
2  BaxcloudRoomOptions(
3    roomName: 'meeting-123',
4    participant: BaxcloudUser(
5      userId: 'user-1',
6      name: 'Alice',
7      isHost: true,
8    ),
9    liveType: BaxcloudLiveType.videoConference,
10  ),
11);
12
13print('Connected to room: ${room.name}');

await client.disconnect();
print('Disconnected from room');

client.connectionState.listen((state) {
  print('Connection state: $state');
});

1await client.sendRealtimeMessage(
2  BaxcloudSendRealtimeMessageOptions(
3    roomName: 'meeting-123',
4    message: 'Hello everyone!',
5  ),
6);

1final recording = await client.startRecording(
2  BaxcloudStartRecordingOptions(
3    roomName: 'my-room',
4    fileType: 'MP4',
5  ),
6);
7
8print('Recording started: ${recording.egressId}');

await client.stopRecording(recording.egressId);
print('Recording stopped');

1// List all active recordings
2final activeRecordings = await client.listActiveRecordings();
3
4// List active recordings for a specific room
5final roomRecordings = await client.listActiveRecordings('my-room');

1final recordings = await client.listRecordings(
2  BaxcloudListRecordingsOptions(
3    status: 'COMPLETED',
4    page: 1,
5    limit: 20,
6  ),
7);
8
9print('Recordings: ${recordings.items}');
10print('Total: ${recordings.meta.total}');

final recording = await client.getRecording('recording-123');
print('Recording status: ${recording.status}');

1final result = await client.getRecordingDownloadUrl('recording-123', 7200);
2print('Download URL (expires in 2 hours): ${result['downloadUrl']}');

1import 'package:baxcloud_client/baxcloud_client.dart';
2
3class MyApp extends StatefulWidget {
4  @override
5  _MyAppState createState() => _MyAppState();
6}
7
8class _MyAppState extends State<MyApp> {
9  late BaxCloudClient client;
10  late BaxCloudRoomController controller;
11
12  @override
13  void initState() {
14    super.initState();
15    client = BaxCloudClient(
16      projectId: 'your-project-id',
17      apiKey: 'your-api-key',
18    );
19    
20    controller = BaxCloudRoomController.instance;
21    controller.initialize(client);
22  }
23
24  @override
25  Widget build(BuildContext context) {
26    return MaterialApp(home: MyScreen());
27  }
28}

1<key>NSCameraUsageDescription</key>
2<string>We need access to your camera for video calls</string>
3<key>NSMicrophoneUsageDescription</key>
4<string>We need access to your microphone for audio calls</string>

1<uses-permission android:name="android.permission.CAMERA" />
2<uses-permission android:name="android.permission.RECORD_AUDIO" />
3<uses-permission android:name="android.permission.INTERNET" />

1import 'package:permission_handler/permission_handler.dart';
2
3Future<void> requestPermissions() async {
4  final statuses = await [
5    Permission.camera,
6    Permission.microphone,
7  ].request();
8
9  if (statuses[Permission.camera]!.isDenied ||
10      statuses[Permission.microphone]!.isDenied) {
11    print('Permissions denied');
12  }
13}