chirpsdk 0.4.0

ChirpSDK (Beta) #

Send data with sound.

Getting Started #

Sign up at the Chirp Developer Hub

Copy and paste your Chirp app key, secret and chosen configuration into the example application

await ChirpSDK.init(_appKey, _appSecret);
await ChirpSDK.setConfig(_appConfig);
await ChirpSDK.start();

Please see the example for a more detailed run through of how to use the Chirp SDK. For example the Chirp SDK async methods must called inside a Future async parent method.

Permissions #

To grant iOS apps permission to use the microphone, you will need to add a Privacy - Microphone Usage Description statement to the Info.plist in the Runner xcode project.

For Android you will need to edit the AndroidManifest.xml file to include

<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

Sending #

Chirp SDKs accept data as an array of bytes, creating a versatile interface for all kinds of data. However in most cases, Chirp is used to send a short identifier. Here is an example of how to send a short string with the Chirp SDK.

String identifier = "hello";
var payload = new Uint8List.fromList(identifier.codeUnits);
await ChirpSDK.send(payload);

It is worth noting here that the send method will not block until the entire payload has been sent, but just as long as it takes to pass the message to the SDK. Please use the onSent callback for this purpose.

Receiving #

To receive data you can listen for received events like so

ChirpSDK.onReceived.listen((e) {
    String identifier = new String.fromCharCodes(e.payload);
});

A received event includes the payload and the channel for multichannel configurations. There are several other callbacks available which are illustrated in the example.

Contributions #

This project aims to be a community driven project and is open to contributions. Please file any issues and pull requests at GitHub Thank you!

Chirp SDK Flutter #

0.4.0 - beta #

  • Upgrade to Android v3.9.5
  • Upgrade to iOS v3.5.2

0.3.0 - 03/05/19 #

  • Upgrade to Android v3.8.0

0.2.0 - 03/05/19 #

  • Upgrade to iOS v3.5.0

0.1.1 - 01/03/19 #

  • Upgrade to Android v3.6.1

0.1.0 - 22/01/19 #

  • Bringing out of experimental status

0.0.1 - 22/01/19 #

  • Initial release using
    • iOS v3.4.3
    • Android v3.6.0

example/README.md

ChirpSDK Example #

Demonstrates how to use the ChirpSDK plugin.

Getting Started #

This project is a starting point for a Flutter application using Chirp.

Use this package as a library

1. Depend on it

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


dependencies:
  chirpsdk: ^0.4.0

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:chirpsdk/chirpsdk.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
64
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
82
Learn more about scoring.

We analyzed this package on Sep 20, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.0
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.2

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test