npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tilde-nlp/asr-api-client

v4.0.21

Published

Library with services for communicating with Tilde TSP platform

Downloads

89

Readme

asr-api-client library

Library is created for implementing dictation. It is written with typescript and also includes typescript models.

Core methods of asrClient

beginVoiceRecognition - starts recording (asks permission for mic if needed) and creates connection with asr api.

endVoiceRecognition(forceCloseWebsocket = false) - stops recording and closes socket if forceCloseWebsocket param is set to true. If forceCloseWebsocket is set to false, it will close connection on next final result.

Real time oscilogram

Library also provides possibility to draw real time oscilogram that will be drawn into <canvas> element. To be able to create this visualization, you need to add <canvas></canvas> element to your html and pass elements ID to visualizer configuration.

Examples

Couple small examples for easier integration. Remember to replace variable placeholders with your own values.

Plain js without any visualization

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Tilde speech recognition example</title>
    <!-- Include Tilde asr api client -->
    <script src="https://unpkg.com/@tilde-nlp/asr-api-client@latest/index.js"></script>
</head>

<body>
    <script language="javascript">
      // set up config
        var config = {
            url: "wss://services.tilde.com/service/asr/ws/${SYSTEM_NAME}/?contentType=audio/x-raw&sampleRate=44100&channelCount=1&x-api-key=${API_KEY}",
            onResult: result => { if (result.final) console.log(result) }, // partial or final result
            onRecordingStartStop: isRecording => console.log(isRecording), // boolean value emitted whenever isRecording changes
            onError: error => console.error(error) // error callback
        }
        // Create asr client
        var asrClient = new window["asr-api-client"].AsrClient(config);
        // Start voice recognition
        asrClient.beginVoiceRecognition();
    </script>
</body>

</html>

Plain js with audio visualization

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Tilde speech recognition example</title>
    <!-- Include Tilde asr api client -->
    <script src="https://unpkg.com/@tilde-nlp/asr-api-client@latest/index.js"></script>
</head>

<body>
    <script language="javascript">
        // set up config
        var config = {
            url: "wss://services.tilde.com/service/asr/ws/${SYSTEM_NAME}/?contentType=audio/x-raw&sampleRate=44100&channelCount=1&x-api-key=${API_KEY}",
            onResult: result => { if (result.final) console.log(result) }, // partial or final result
            onRecordingStartStop: (isRecording, ctx) => {
                // start drawing audio oscilogram if neccesarry
                if (isRecording) {
                    ctx.audioVisualizer?.visualizeAudio();
                }
            }, // boolean value emitted whenever isRecording changes
            onError: error => console.error(error), // error callback
            // configuration if you want to add real time oscillogram, if not, you do not have to set this value
            visualizerConfig: {
                // id of container where to put visualizer
                visualizerId: "audio-visualizer",
                // optional param - visualization color. Default value: "#811331"
                strokeStyle: "#811331"
            }
        }
        // Create asr client
        var asrClient = new window["asr-api-client"].AsrClient(config);
        // Start voice recognition
        asrClient.beginVoiceRecognition();
    </script>
</body>
<!--necessary if you need real time oscilogram-->
<canvas id="audio-visualizer"></canvas>

</html>