com.mapbox.api.speech.v1

Class MapboxSpeech

java.lang.Object

com.mapbox.core.MapboxService<okhttp3.ResponseBody,SpeechService>

com.mapbox.api.speech.v1.MapboxSpeech

public abstract class MapboxSpeech
extends com.mapbox.core.MapboxService<okhttp3.ResponseBody,SpeechService>

The Speech API is a text-to-speech API with a server-side caching layer in front of AWS Polly. The only requirements are text to dictate, and a Mapbox access token. For 3-step-ahead client-side caching, cache directory is required.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxSpeech.Builder This builder is used to create a MapboxSpeech instance, with details about how the API calls should be made (input/output format, language, etc.).

Field Summary

Fields inherited from class com.mapbox.core.MapboxService

MAX_URL_SIZE, okHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxSpeech()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	baseUrl()
static MapboxSpeech.Builder	builder() Creates a builder for a MapboxSpeech object with a default cache size of 10 MB.
okhttp3.OkHttpClient	getOkHttpClient()
protected retrofit2.Call<okhttp3.ResponseBody>	initializeCall()

Methods inherited from class com.mapbox.core.MapboxService

cancelCall, cloneCall, enableDebug, enqueueCall, executeCall, getCall, getCallFactory, getGsonBuilder, getRetrofit, getService, isEnableDebug, setCallFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapboxSpeech

protected MapboxSpeech()

Method Detail

initializeCall

protected retrofit2.Call<okhttp3.ResponseBody> initializeCall()

Specified by:

initializeCall in class com.mapbox.core.MapboxService<okhttp3.ResponseBody,SpeechService>

baseUrl

protected abstract java.lang.String baseUrl()

Specified by:

baseUrl in class com.mapbox.core.MapboxService<okhttp3.ResponseBody,SpeechService>

getOkHttpClient

public okhttp3.OkHttpClient getOkHttpClient()

Overrides:

getOkHttpClient in class com.mapbox.core.MapboxService<okhttp3.ResponseBody,SpeechService>

builder

public static MapboxSpeech.Builder builder()

Creates a builder for a MapboxSpeech object with a default cache size of 10 MB.

Returns:

a builder to create a MapboxSpeech object

Since:

3.0.0