Skip to content

Commit 0d4d440

Browse files
author
TheShadow
committed
Added CHANGELOG, CREDITS, and README files
1 parent 0a8d626 commit 0d4d440

File tree

3 files changed

+56
-0
lines changed

3 files changed

+56
-0
lines changed

CHANGELOG.markdown

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#Java-Speech-API Changelog
2+
3+
##Changelog
4+
Changelog corresponds with a tagged and signed Git commit. This marks the changes.
5+
A tagged commit may or may not have a corresponding binary version available.
6+
Format: Tag: <Corresponding Tag>
7+
8+
* Version 1.00 (Tag: v1.00)
9+
* Initial Release

CREDITS.markdown

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#Java-Speech API Credits
2+
3+
##Credits
4+
The following people/organizations have helped provide functionality for the API,
5+
6+
* JavaFlacEncoder Project
7+
* Provided functionality to convert Wave files to FLAC format
8+
* This allowed for the FLAC audio to be sent to Google to be "recognized"
9+
* Created by Preston Lacey
10+
* Homepage: http://sourceforge.net/projects/javaflacencoder/
11+
* Google
12+
* Provided functionality for two main API functions
13+
* Recognizer
14+
* Allows for speech audio to be recognized to text
15+
* Synthesiser
16+
* Allows for text to speech translation
17+
* Homepage: http://google.com
18+
19+
I would like to thank the above so much for your work, this wrapper/API could not have been
20+
created without it.

README.markdown

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#Java-Speech-API
2+
3+
This is the project for the Java Speech API written in Java.
4+
5+
## Description
6+
This API is designed to be simple and efficient, using the speech engines created by Google
7+
to provide functionality for parts of the API. Essentially, it is an API written in Java,
8+
including a recognizer, synthesizer, and a microphone capture utility. The project uses
9+
Google services for the synthesizer and recognizer. While this requires an Internet
10+
connection, it provides a complete, modern, and fully functional speech API in Java.
11+
12+
##Features
13+
The API currently provides the following functionality,
14+
15+
* Microphone Capture API (Wrapped around the current Java API for simplicity)
16+
* A speech recognizer using Google's recognizer service
17+
* Converts WAVE files from microphone input to FLAC (using existing API, see CREDITS)
18+
* Retrieves Response from Google, including confidence score and text
19+
* A speech synthesiser using Google's synthesizer service
20+
* Retrieves synthesized text in an InputStream (MP3 data ready to be played)
21+
* Wave to FLAC API (Wrapped around the used API in the project, javaFlacEncoder, see CREDITS)
22+
23+
##Changelog
24+
See CHANGELOG.markdown for Version History/Changelog
25+
26+
##Credits
27+
See CREDITS.markdown for Credits

0 commit comments

Comments
 (0)