com.mapbox.api.speech.v1

Interface SpeechService

public interface SpeechService

Interface that defines the speech service.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<okhttp3.ResponseBody>	getCall(java.lang.String text, java.lang.String textType, java.lang.String language, java.lang.String outputFormat, java.lang.String accessToken) Constructs the html call using the information passed in through the MapboxSpeech.Builder.

Method Detail

getCall

@GET(value="/voice/v1/speak/{text}")
retrofit2.Call<okhttp3.ResponseBody> getCall(@Path(value="text")
                                                                                  java.lang.String text,
                                                                                  @Query(value="textType")
                                                                                  java.lang.String textType,
                                                                                  @Query(value="language")
                                                                                  java.lang.String language,
                                                                                  @Query(value="outputFormat")
                                                                                  java.lang.String outputFormat,
                                                                                  @Query(value="access_token")
                                                                                  java.lang.String accessToken)

Constructs the html call using the information passed in through the MapboxSpeech.Builder.

Parameters:

text - text to dictate

textType - text type, either "text" or "ssml" (default is "text")

language - language locale, default is "en-us"

outputFormat - output format, either "mp3" or "json", default is "mp3"

accessToken - Mapbox access token

Returns:

the MapboxSpeech response in a Call wrapper

Since:

3.0.0