https://github.com/voximplant/flutter_voximplant
Voximplant Flutter SDK
https://github.com/voximplant/flutter_voximplant
client-sdk flutter voximplant
Last synced: 12 days ago
JSON representation
Voximplant Flutter SDK
- Host: GitHub
- URL: https://github.com/voximplant/flutter_voximplant
- Owner: voximplant
- License: mit
- Created: 2019-09-30T16:18:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-24T14:05:38.000Z (26 days ago)
- Last Synced: 2025-05-08T22:57:21.623Z (12 days ago)
- Topics: client-sdk, flutter, voximplant
- Language: Dart
- Homepage:
- Size: 593 KB
- Stars: 9
- Watchers: 10
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# flutter_voximplant
Voximplant Flutter SDK for embedding voice and video communication into Flutter applications.
## Demo
https://github.com/voximplant/flutter_demos
## Install
Add `flutter_voximplant` as a dependency in your pubspec.yaml file.
### iOS
Add the following entry to your `Info.plist` file, located in `/ios/Runner/Info.plist`:
```
NSMicrophoneUsageDescription
Microphone is required to make audio calls
NSCameraUsageDescription
Camera is required to make video calls
```
This entry allows your app to access the microphone and cameras.
### Android
It is required to add Java 8 support.
Open `android/app/build.gradle` file and add the following lines to ‘android’ section:
```
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
```
## Usage
To get started, you'll need to [register](https://manage.voximplant.com/auth/sign_up/) a free Voximplant developer account.
#### Initialization
Client is the main class of the SDK that provides access to Voximplant’s functions,
the `Voximplant().getClient()` method is used to get its instance:
```dart
import 'package:flutter_voximplant/flutter_voximplant.dart';
VIClient client = Voximplant().getClient();
```
#### Connect and log in to the Voximplant Cloud
The `VIClient.getClientState()` method is used to get the current state of connection
to the Voximplant cloud and perform the actions according to it.
When initializing and connecting the SDK to the Voximplant cloud, you need to specify the node to connect to.
Your node is bound to your Voximplant account.
To find which node your account belongs to, log in to your control panel and see
the [Credentials for working with API, SDK, SIP](https://manage.voximplant.com/) section on the main dashboard.
```dart
const accountNode = VINode.NodeX;
Future loginWithPassword(String username, String password) async {
VIClientState clientState = await _client.getClientState();
if (clientState == VIClientState.LoggedIn) {
return _displayName;
}
if (clientState == VIClientState.Disconnected) {
await _client.connect(node: accountNode);
}
VIAuthResult authResult = await _client.login(username, password);
_displayName = authResult.displayName;
return _displayName;
}
```
#### Make calls
To initiate a call we need the `VIClient.call` method.
There is a `VICallSettings` class which could contain custom data and extra headers (SIP headers).
Since the call can behave in different ways, there is a group of call events.
They can be triggered by the `VICall` class instance as the class contains all the functionality for call management.
```dart
Future makeAudioCall(String number) async {
VICall call = await _client.call(number);
call.onCallDisconnected = _onCallDisconnected;
call.onCallFailed = _onCallFailed;
call.onCallConnected = _onCallConnected;
call.onCallRinging = _onCallRinging;
call.onCallAudioStarted = _onCallAudioStarted;
return call;
}
_onCallConnected(VICall call, Map? headers) {
print('Call connected');
}
```
#### Receiving calls
`Client.onIncomingCall` is used to get incoming calls.
There are three methods for an incoming call: answer, decline and reject. An audio stream can be sent only after the answer method call.
```dart
CallService._() {
_client = Voximplant().getClient();
_client.onIncomingCall = _onIncomingCall;
}
_onIncomingCall(VIClient client, VICall call, bool video, Map? headers) async {
await call.answer();
}
```
#### Mid-call operations
Audio call can be put on/off hold
```dart
_hold() async {
try {
await _call.hold(!_isOnHold);
setState(() {
_isOnHold = !_isOnHold;
});
} catch (e) {
}
}
```
#### Audio device management
`VIAudioDeviceManager` class API allow to:
- get all available audio devices
- get currently selected audio device
- select audio device
- handle active audio device changes and new audio devices (for example, Bluetooth headset or wired headset connection). These changes trigger the appropriate events.
All types of audio devices are represented in the `VIAudioDevice` enum.
Note that there are platform specific nuances in audio device management.
To select an audio device:
```dart
_selectAudioDevice(VIAudioDevice device) async{
VIAudioDeviceManager audioDeviceManager = Voximplant().getAudioDeviceManager();
audioDeviceManager.onAudioDeviceChanged = _onAudioDeviceChange;
await audioDeviceManager.selectAudioDevice(device);
}
_onAudioDeviceChange(VIAudioDeviceManager audioDeviceManager, AudioDevice audioDevice) {
// audio device is changed
}
```