Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

cordova-plugin-voiceit

Package Overview
Dependencies
Maintainers
1
Versions
51
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cordova-plugin-voiceit

This plugin is a Cordova VoiceIt plugin for that encapsulates VoiceIt's Voice Authentication API

  • 1.2.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
54
increased by800%
Maintainers
1
Weekly downloads
 
Created
Source

Cordova VoiceIt Plugin

An Apache Cordova plugin that lets you easily integrate VoiceIt's Voice Authentication API into your Cordova Based iOS and Android apps.

For more information on VoiceIt and its features, see the website and getting started docs

Supported Platforms

  • Android
  • iOS

Getting Started

To use the VoiceIt Cordova Plugin in your Cordova Project, if you haven't already, please Sign Up for a free Developer Id at http://voiceit.tech. Then follow the installation instructions below.

Installation

First please cd into your Cordova App's root directory via the terminal/command line and then run the following command:

$ cordova plugin add cordova-plugin-voiceit

API Calls

Here are code snippets that show you how you can call the Various VoiceIt API Calls inside of your Cordova Project JavaScript Files.

Create User

To create a new user call the createUser function like this with the following parameters: developerID, email, password, first name, last name

VoiceIt.createUser({
  developerID: "DEVELOPER_ID_HERE",
  email: "cordova@voiceit-tech.com",
  password: "password",
  firstName: "John",
  lastName: "Doe"
}, function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Set User

To update an existing user call the setUser function like this with the following parameters: developerID, email, password, first name, last name

VoiceIt.setUser({
  developerID: "DEVELOPER_ID_HERE",
  email: "cordova@voiceit-tech.com",
  password: "password",
  firstName: "John",
  lastName: "Doe"
}, function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Get User

To retrieve an existing user call the getUser function like this with the following parameters: developerID, email, password

VoiceIt.getUser({
  developerID: "DEVELOPER_ID_HERE",
  email: "cordova@voiceit-tech.com",
  password: "password"
}, function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Delete User

To delete an existing user call the deleteUser function like this with the following parameters: developerID, email, password

VoiceIt.deleteUser({
  developerID: "DEVELOPER_ID_HERE",
  email: "cordova@voiceit-tech.com",
  password: "password"
}, function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Create Enrollment

To create a new enrollment template for the specified user profile use the createEnrollment function like this with the following parameters: developerID, email, password.

Please Note: Unlike other wrappers, this createEnrollment function actually has recording inbuilt(supporting both Android and iOS platforms), it records the user saying their VoicePrint phrase for 5 seconds and then makes the Create Enrollment API call to send that audio file as an enrollment.

VoiceIt.createEnrollment({
  developerID: "DEVELOPER_ID_HERE",
  email: "cordova@voiceit-tech.com",
  password: "password"
}, function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Get Enrollments

To get a list of the existing enrollments simply call the getEnrollments method for the specific user like this with the following parameters: developerID, email, password

VoiceIt.getEnrollments({
  developerID: "DEVELOPER_ID_HERE",
  email: "cordova@voiceit-tech.com",
  password: "password"
}, function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Delete Enrollment

To delete an enrollment simply call the deleteEnrollment method for the specific user like this with the following parameters: developerID, email, password, enrollmentId

VoiceIt.getEnrollments({
  developerID: "DEVELOPER_ID_HERE",
  email: "cordova@voiceit-tech.com",
  password: "password",
  enrollmentId:"2461"
}, function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Authentication

To authenticate the user profile use the authentication method like this with the following parameters: email, password, accuracy of authentication (between 0-5, 0 being the most strict and 5 the most lax), number of accuracy passes (between 1-10), accuracy pass increment (between 1-5) and confidence level (between 85-100).

Please Note: Unlike other wrappers, this authentication function actually has recording inbuilt(supporting both Android and iOS platforms), it records the user saying their VoicePrint phrase for 5 seconds and then makes the Authentication API call to send that audio file in for authentication.

VoiceIt.authentication({
  developerID: "DEVELOPER_ID_HERE",
  email: "cordova@voiceit-tech.com",
  password: "password",
  accuracy: "0",
  accuracyPasses: "5",
  accuracyPassIncrement: "2",
  confidence: "85"
}, function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Playback

This is a special method for this plugin that simply plays back the most recent recording if called right after either the createEnrollment or authentication method.

VoiceIt.playback( function(response) {
  alert('Result: ' + response);
}, function(error) {
  alert('Error: ' + error);
});

Keywords

FAQs

Package last updated on 11 Dec 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc