Skip to main content

Directory and File Structure

This section explains the directory and file structure of the AmiVoice API client library.

Client Library​

The source code for the client library is located in the src directory of each language's directory.

  • Hrp/{language}/src/
  • Wrp/{language}/src/

Sample Programs​

We provide source code for sample console applications using the client library. For JavaScript, we also provide sample programs for web pages.

Hrp​

  • Hrp/{language}/HrpSimpleTester

    • Sample applications for Hrp in each language: Java, C#, C++, Python, and PHP. These run on the console.
    • These are simple applications that allow you to specify only the minimum, commonly used parameters necessary for speech recognition. For execution methods, please see HrpSimpleTester.

  • Hrp/javascript/hrp.html

    • This is the main web page for the Hrp.js sample application. It runs in the browser.
    • It can recognize specified audio files and real-time audio data recorded from the microphone.

  • Hrp/curl

    • This includes audio files and curl command samples used in the tutorial.
    • It contains script files that perform speech recognition using only curl commands as samples for the HTTP interface.

Wrp​

  • Wrp/{language}/WrpSimpleTester

    • Sample applications for Wrp in each language: Java, C#, C++, Python, and PHP. These run on the console.
    • These are simple applications that allow you to specify only the minimum, commonly used parameters necessary for speech recognition. For execution methods, please see WrpSimpleTester.

  • Wrp/javascript/wrp.html

    • This is the main web page for the Wrp.js sample program. It runs in the browser.
    • It recognizes real-time audio data recorded from the microphone. Communication details and other information are displayed on the screen in real-time.

Files and Directories​

The structure of all published files and directories is as follows:

# https://github.com/advanced-media-inc/amivoice-api-client-library
amivoice-api-client-library
├── Hrp
│   ├── cpp
│   │   ├── Hrp.sln
│   │   ├── HrpSimpleTester.cpp
│   │   ├── HrpSimpleTester.vcxproj
│   │   ├── HrpTester.cpp
│   │   ├── HrpTester.vcxproj
│   │   ├── bin
│   │   ├── run.bat
│   │   ├── run.sh
│   │   └── src
│   ├── cs
│   │   ├── Hrp.sln
│   │   ├── HrpSimpleTester.config
│   │   ├── HrpSimpleTester.cs
│   │   ├── HrpSimpleTester.csproj
│   │   ├── HrpTester.config
│   │   ├── HrpTester.cs
│   │   ├── HrpTester.csproj
│   │   ├── bin
│   │   ├── run.bat
│   │   └── src
│   ├── curl
│   │   ├── run.bat
│   │   └── run.sh
│   ├── java
│   │   ├── Hrp.jar
│   │   ├── HrpSimpleTester.class
│   │   ├── HrpSimpleTester.java
│   │   ├── HrpTester.class
│   │   ├── HrpTester.java
│   │   ├── run.bat
│   │   ├── run.sh
│   │   └── src
│   ├── javascript
│   │   ├── do.css
│   │   ├── do.js
│   │   ├── hrp.html
│   │   ├── hrp.js
│   │   ├── recorder.js
│   │   ├── encoder_opus.js
│   │   ├── encoder_opus.wasm
│   │   ├── encoder_adpcm.js
│   │   └── encoder_opus_ogg.js
│   ├── php
│   │   ├── HrpSimpleTester.php
│   │   ├── HrpTester.php
│   │   ├── run.bat
│   │   ├── run.sh
│   │   └── src
│   └── python
│       ├── HrpSimpleTester.py
│       ├── HrpTester.py
│       ├── run.bat
│       ├── run.sh
│       └── src
├── Wrp
│   ├── cpp
│   │   ├── Wrp.sln
│   │   ├── WrpSimpleTester.cpp
│   │   ├── WrpSimpleTester.vcxproj
│   │   ├── WrpTester.cpp
│   │   ├── WrpTester.vcxproj
│   │   ├── bin
│   │   ├── run.bat
│   │   ├── run.sh
│   │   └── src
│   ├── cs
│   │   ├── Wrp.sln
│   │   ├── WrpSimpleTester.config
│   │   ├── WrpSimpleTester.cs
│   │   ├── WrpSimpleTester.csproj
│   │   ├── WrpTester.config
│   │   ├── WrpTester.cs
│   │   ├── WrpTester.csproj
│   │   ├── bin
│   │   ├── run.bat
│   │   └── src
│   ├── java
│   │   ├── Wrp.jar
│   │   ├── WrpSimpleTester.class
│   │   ├── WrpSimpleTester.java
│   │   ├── WrpTester.class
│   │   ├── WrpTester.java
│   │   ├── run.bat
│   │   ├── run.sh
│   │   └── src
│   ├── javascript
│   │   ├── do.css
│   │   ├── do.js
│   │   ├── recorder.js
│   │   ├── wrp.html
│   │   ├── wrp.js
│   │   ├── encoder_opus.js
│   │   ├── encoder_opus.wasm
│   │   ├── encoder_adpcm.js
│   │   └── encoder_opus_ogg.js
│   ├── php
│   │   ├── WrpSimpleTester.php
│   │   ├── WrpTester.php
│   │   ├── run.bat
│   │   ├── run.sh
│   │   └── src
│   └── python
│       ├── WrpSimpleTester.py
│       ├── WrpTester.py
│       ├── run.bat
│       ├── run.sh
│       └── src
├── audio
│   ├── test.wav
│   ├── test2.wav
│   └── www.wav
├── curl-ca-bundle.crt
└── readme.txt