Installing the SDK

Instructions for installing the SDK are language specific.

Go

The Go SDK supports Go modules and requires Go 1.12 or later. To use the SDK, import this package into your application:

import "github.com/cobaltspeech/sdk-cubic/grpc/go-cubic"

Python

The Python SDK depends on Python >= 3.5. You may use pip to perform a system-wide install, or use virtualenv for a local install.

pip install --upgrade pip
pip install "git+https://github.com/cobaltspeech/sdk-cubic#egg=cobalt-cubic&subdirectory=grpc/py-cubic"

C++

To use the Cubic SDK in a C++ project, you must first download the SDK from Github.

git clone https://github.com/cobaltspeech/sdk-cubic.git

To simplify the build process, the C++ SDK uses CMake, although it is possible to use a different build system with some additional work. Details for building and including the SDK in a C++ project are described in detail in this README file.

C#

The C# SDK utilizes the NuGet package manager. The package is called Cubic-SDK, under the owners name of CobaltSpeech.

NuGet allows 4 different ways to install. Further instructions can be found on the nuget webpage. Installing via the dotnet cli through the command:

dotnet add package Cubic-SDK

Java

Maven

The Cubic SDK is published to the jitpack repository. To build using Maven, add the following to your project’s pom.xml file:

1. Add jitpack to repository list

<repositories>
    <repository>
      <id>jitpack.io</id>
      <url>https://jitpack.io</url>
    </repository> 
    ...
  </repositories>

2. Add Cubic as a dependency

<dependencies>
    ...
    <dependency>
        <groupId>com.github.cobaltspeech</groupId>
        <artifactId>sdk-cubic</artifactId>
        <version>v1.6.4-java</version>
    </dependency>
</dependencies>

3. You should then be able to build your project with mvn package

Android

Using Gradle and JitPack

To use the pre-built SDK libraries, add JitPack in your root build.gradle at the end of repositories:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

Then add sdk-cubic as a dependency:

dependencies {
    implementation 'com.github.cobaltspeech:sdk-cubic:v1.6.4'
}

From Source Code

Building for Android from source requires more steps, so it is described on the Android Integrations page.

iOS

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding swift-cubic as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "git@github.com:cobaltspeech/sdk-cubic.git", .upToNextMajor(from: "1.6.4"))
]