Package Exports

@speechly/browser-client
@speechly/browser-client/core/speechly.es.js
@speechly/browser-client/core/speechly.umd.min.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@speechly/browser-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

The Fast, Accurate, and Simple Voice Interface API

Website | Docs | Discussions | Blog | Podcast

Speechly browser client

With the browser-client you can add voice features to any website. It handles authentication, audio capture, network streaming and connection management with the Speechly Voice API.

Check out the browser-client-example repository for a demo app built using this client.

NOTE: If you are using React, you can use our React client instead. It provides the same functionalities, but provides a programming model that is idiomatic to React.

Usage with Node

Install the package:

# Using Yarn
yarn add @speechly/browser-client

# Using NPM
npm install --save @speechly/browser-client

Start using the client:

import { Client, Segment } from '@speechly/browser-client'

// Create a new Client. NOTE: Configure and get your appId from https://api.speechly.com/dashboard
const client = new Client({appId: 'your-app-id'})

// Initialize the client - this will ask the user for microphone permissions and establish the connection to Speechly API.
// Make sure you call `initlialize` from a user action handler (e.g. from a button press handler).
await client.initialize()

// React to the updates from the API.
client.onSegmentChange((segment: Segment) => {
  console.log('Received new segment from the API:', segment.intent, segment.entities, segment.words, segment.isFinal)
})

// Start recording.
// Ideally this should be bound to e.g. a button press.
await client.startContext()

// Stop recording after a timeout.
// Ideally this should be bound to e.g. a button press.
setTimeout(async function() {
  await client.stopContext()
}, 3000)

Usage with browsers

This sample HTML loads Speechly's browser-client ES modules via a CDN that mirrors npm packages. The page displays a text field that you dictate text into. See browser's console log for raw segment feed from Speechly.

Please use a HTML server to view the example. Running it as a file will not work due to browser's security restrictions. For example run serve . on command line and open localhost:3000 in your browser.

<html>
  <body>

    <input id="textBox" type="text" placeholder="Hold to talk..." autofocus>

    <script type="module">
      // Load Speechly ES module from a CDN. Note script type="module"
      import { Client, ClientState } from "https://unpkg.com/@speechly/browser-client/core/speechly.es.js"

      const widget = document.getElementById("textBox")
      let clientState = ClientState.Disconnected;

      // Create a Speechly client instance.  NOTE: Configure and get your appId from https://api.speechly.com/dashboard
      const client = new Client({
        appId: "your-app-id",
        debug: true,
        logSegments: true,
      })

      client.onStateChange(state => {
        clientState = state;
      });

      client.onSegmentChange(segment => {
        // Clean up and concatenate words
        let transcript = segment.words.map(w => w.value.toLowerCase()).filter(w => w !== "").join(" ");
        // Add trailing period upon segment end.
        if (segment.isFinal) transcript += ".";
        widget.value = transcript;
      });

      const startListening = async () => {
        switch (clientState) {
          case ClientState.Disconnected:
            await client.initialize();
            // fall through
          case ClientState.Connected:
            widget.value = "Listening..."
            client.startContext();
            break;
        }
      }

      const stopListening = () => {
        switch (clientState) {
          case ClientState.Starting:
          case ClientState.Recording:
            client.stopContext();
            break;
        }
      }

      // Bind start listening to a widget hold, release anywhere to stop
      widget.addEventListener("mousedown", startListening)
      document.addEventListener("mouseup", stopListening)
    </script>
  </body>
  
</html>

Documentation

You can find the detailed browser-client API documentation in the GitHub repository.

You can also refer to Speechly Docs for more information.

Contributing

See contribution guide in CONTRIBUTING.md.