Close Menu

saystack

Welcome to the documentation page for SayStack! Here you will find detailed information about SayStack and how to use it. Whether you’re a developer or a user interested in understanding SayStack’s capabilities, this documentation will guide you through the process.

About SayStack

SayStack is a powerful speech recognition library designed to enable developers to integrate voice command functionality into their applications. With SayStack, you can effortlessly incorporate voice-based commands and enhance the user experience of your app.

Installation

To start using SayStack in your project, follow the steps below:

  • Step 1: Open Terminal or Command Prompt
  • Step 2: Navigate to your project directory
  • Step 3: Run the following command to install SayStack via CocoaPods:

pod 'SayStack'

Usage

Once you have SayStack installed, you can begin incorporating voice commands into your application. Below are a few usage examples to get you started:

Initialization

Before using SayStack, you need to initialize the library in your project. Here’s an example of how to do that:


import SayStack

let sayStack = SayStack()

Start Command Recognition

To start recognizing voice commands, call the following method:


sayStack.startRecognition()

Stop Command Recognition

If you want to stop recognizing voice commands, use the following method:


sayStack.stopRecognition()

Recognized Command Callback

SayStack provides a callback that gets triggered when a command is recognized. Here’s an example of how to handle it:


sayStack.completionBlock = { recognizedCommand in
// Handle the recognized command here
print(recognizedCommand)
}

Additional Functionalities

Besides basic command recognition, SayStack offers additional functionalities to enhance your application:

Custom Commands

You can define your own custom commands by utilizing the SayStack Command structure. Here’s an example:


let customCommand = SayStack.Command("say hello") {
// Custom command action here
print("Hello!")
}

sayStack.addCommand(customCommand)

Confidence Threshold

You can define a confidence threshold for voice command recognition. This allows you to control the accuracy required for the command to be considered valid. Here’s an example of how to set the threshold:


sayStack.confidenceThreshold = 0.8

Error Handling

SayStack provides error handling capabilities. You can define an error block to handle any errors that occur during command recognition. Here’s an example:


sayStack.errorBlock = { error in
// Error handling code here
print(error)
}

Conclusion

Congratulations! You now have a solid understanding of SayStack and how to integrate it into your projects. Use the provided information to unleash the power of voice commands in your applications, enhance user experiences, and create innovative solutions.

Additional Resources

For more information, resources, or to contribute to the SayStack project, please visit the SayStack GitHub repository: https://github.com/saystack/saystack