flutter_twilio_voice 0.0.3

  • Readme
  • Changelog
  • Example
  • Installing
  • 80

flutter_twilio_voice #

Provides an interface to Twilio's Programmable Voice SDK to allow voice-over-IP (VoIP) calling into your Flutter applications.

Configure Server to Generate Access Token #

View Twilio Documentation on Access Token Generation: https://www.twilio.com/docs/iam/access-tokens

Make a Call #

 await FlutterTwilioVoice.makeCall(to: "$client_identifier_or_number_to_call",
                   accessTokenUrl: "https://${YOUR-SERVER-URL}/accesstoken");

Mute a Call #

 await FlutterTwilioVoice.muteCall(isMuted: true);

Toggle Speaker #

 await FlutterTwilioVoice.toggleSpeaker(speakerIsOn: true);

Hang Up #

 await FlutterTwilioVoice.hangUp();

Client Setup to Receive Calls #

 await FlutterTwilioVoice.receiveCalls(clientIdentifier: 'alice');

Listen for Call Events #

FlutterTwilioVoice.phoneCallEventSubscription.listen((data) 
    {
      setState(() {
        _callStatus = data.toString();
      });
    }, onError: (error) {
      setState(() {
        print(error);
      });
    });
    

To Do #

  1. Android Support
  2. Propagate Events and Call Status Notifications to Flutter

0.0.3 #

  • metadata changes and display Name for call to

0.0.2 - 2019-07-26 #

  • modified makeCall parameter order and added some samples

0.0.1 - 2019-07-26 #

  • initial release with iOS implementation.

example/lib/main.dart

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:flutter_twilio_voice/flutter_twilio_voice.dart';


void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  String _eventMessage;

  TextEditingController _controller;

  @override
  void initState() {
    super.initState();

    initPlatformState();
    _controller = TextEditingController();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String platformVersion;
    // Platform messages may fail, so we use a try/catch PlatformException.
    try {
      platformVersion = await FlutterTwilioVoice.platformVersion;
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  void _onEvent(Object event) {

    setState(() {

      _eventMessage = "Battery status: ${event == 'charging' ? '' : 'dis'}charging.";

    });

  }




  void _onError(Object error) {

    setState(() {

      _eventMessage = 'Battery status: unknown.';

    });

  }


  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: SafeArea(child: Center(
          child: Column(children: <Widget>[
           
            Padding(
              padding: EdgeInsets.all(10),
              child: Text('Running on: $_platformVersion\n'),),
            TextFormField(controller: _controller, decoration: InputDecoration(labelText: 'Client Identifier or Phone Number'),),
            SizedBox(height: 10,),
            RaisedButton(child: Text("Make Call"), onPressed: () async {
              FlutterTwilioVoice.phoneCallEventSubscription.listen(_onEvent, onError: _onError);
              FlutterTwilioVoice.receiveCalls("alice");
              FlutterTwilioVoice.makeCall(to: "555555555", accessTokenUrl: "https://{SERVER_URL}/accesstoken", toDisplayName: "James Bond" );
            },)
          ],),
        )),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_twilio_voice: ^0.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_twilio_voice/flutter_twilio_voice.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
64
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
80
Learn more about scoring.

We analyzed this package on Jul 2, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.9+1
  • Flutter: 1.17.3

Analysis suggestions

Package does not support Flutter platform linux

Because of import path [package:flutter_twilio_voice/flutter_twilio_voice.dart]

Package does not support Flutter platform macos

Because of import path [package:flutter_twilio_voice/flutter_twilio_voice.dart]

Package does not support Flutter platform web

Because of import path [package:flutter_twilio_voice/flutter_twilio_voice.dart]

Package does not support Flutter platform windows

Because of import path [package:flutter_twilio_voice/flutter_twilio_voice.dart]

Package not compatible with SDK dart

because of import path [flutter_twilio_voice]

Health issues and suggestions

Document public APIs. (-1 points)

10 out of 10 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/flutter_twilio_voice.dart.

Run flutter format to format lib/flutter_twilio_voice.dart.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8 1.2.0
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8
Dev dependencies
flutter_test