diff --git a/doc/C-API.rst b/doc/C-API.rst index b76c06b8..1fd8bd4e 100644 --- a/doc/C-API.rst +++ b/doc/C-API.rst @@ -1,4 +1,4 @@ -.. _c-usage: +.. _c-api: C API ===== diff --git a/doc/DEPLOYMENT.rst b/doc/DEPLOYMENT.rst index 964e4606..0d60b2be 100644 --- a/doc/DEPLOYMENT.rst +++ b/doc/DEPLOYMENT.rst @@ -16,7 +16,7 @@ You can deploy 🐸STT models either via a command-line client or a language bin * :ref:`The Node.JS package + language binding ` * :ref:`The Android libstt AAR package ` * :ref:`The command-line client ` -* :ref:`The native C API ` +* :ref:`The C API ` .. _download-models: @@ -172,7 +172,7 @@ This will link all .aar files in the ``libs`` directory you just created, includ Using the command-line client ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The pre-built binaries for the ``stt`` command-line (compiled C++) client are available in the ``native_client.tar.xz`` archive for your desired platform. You can download the archive from our `releases page `_. +The pre-built binaries for the ``stt`` command-line (compiled C++) client are available in the ``native_client.*.tar.xz`` archive for your desired platform (where the * is the appropriate identifier for the platform you want to run on). You can download the archive from our `releases page `_. Assuming you have :ref:`downloaded the pre-trained models `, you can use the client as such: @@ -182,6 +182,15 @@ Assuming you have :ref:`downloaded the pre-trained models `, yo See the help output with ``./stt -h`` for more details. +.. _c-usage: + +Using the C API +^^^^^^^^^^^^^^^ + +Alongside the pre-built binaries for the ``stt`` command-line client described :ref:`above `, in the same ``native_client.*.tar.xz`` platform-specific archive, you'll find the ``coqui-stt.h`` header file as well as the pre-built shared libraries needed to use the 🐸STT C API. You can download the archive from our `releases page `_. + +Then, simply include the header file and link against the shared libraries in your project, and you should be able to use the C API. Reference documentation is available in :ref:`c-api`. + Installing bindings from source ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^