https://github.com/azu/voicod
Voice note editor
https://github.com/azu/voicod
Last synced: 5 months ago
JSON representation
Voice note editor
- Host: GitHub
- URL: https://github.com/azu/voicod
- Owner: azu
- License: mit
- Created: 2020-06-07T05:54:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-08-23T01:10:51.000Z (about 3 years ago)
- Last Synced: 2025-04-30T23:38:28.042Z (5 months ago)
- Language: TypeScript
- Homepage: https://voicod.pages.dev/
- Size: 565 KB
- Stars: 27
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# voicod
Voice note editor
## Usage
- Open
:memo: Require [SpeechRecognition](https://developer.mozilla.org/docs/Web/API/SpeechRecognition/SpeechRecognition) API supported browser like Google Chrome
## Parameters
- `?noSave`: no use localStorage
- Do not load previous text, and do not write current text to storage
## `x-callback` support
Voicod support `x-callback-url`.
- [1.0 DRAFT Spec | x-callback-url](http://x-callback-url.com/specifications/)
Parameters
- `x-success=`: open the url when click "OK" button
- `{{reuslt}}` placeholder will be replaced the result text
- `x-cancel=`: open the url when click "Cancel" button
- `x-error=`: open the url when occur error
- `{{errorMessage}}` placeholder will be replaced the error message
- `x-onetime`: when `x-onetime` is passed, open the `x-success`'s url automatically
Examples:
```
https://voicod.pages.dev/x-success=https%3A%2F%2Fgithub.com%2Fazu%2Fvoicod%2Fissues%2Fnew%3Ftitle%3D%7B%7Bresult%7D%7D
// → Open "https://github.com/azu/voicod/issues/new?title={{result}}" when click "OK" button
https://voicod.pages.dev/?x-onetime&x-success=https%3A%2F%2Fgithub.com%2Fazu%2Fvoicod%2Fissues%2Fnew%3Ftitle%3D%7B%7Bresult%7D%7D
// → Open "https://github.com/azu/voicod/issues/new?title={{result}}" after input your voice
```
## Changelog
See [Releases page](https://github.com/azu/voicod/releases).
## Running tests
Install devDependencies and Run `npm test`:
npm test
## Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, [please create an issue](https://github.com/azu/voicod/issues).
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Author
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu