TtsSpan

Kotlin |Java

open class TtsSpan : ParcelableSpan

kotlin.Any
↳	android.text.style.TtsSpan

A span that supplies additional meta-data for the associated text intended for text-to-speech engines. If the text is being processed by a text-to-speech engine, the engine may use the data in this span in addition to or instead of its associated text. Each instance of a TtsSpan has a type, for example TYPE_DATE or TYPE_MEASURE. And a list of arguments, provided as key-value pairs in a bundle. The inner classes are there for convenience and provide builders for each TtsSpan type.

Summary

Nested classes
open	`Builder` A simple builder for TtsSpans.
open	`CardinalBuilder` A builder for TtsSpans of type `TYPE_CARDINAL`.
open	`DateBuilder` A builder for TtsSpans of type `TYPE_DATE`.
open	`DecimalBuilder` A builder for TtsSpans of type `TYPE_DECIMAL`.
open	`DigitsBuilder` A builder for TtsSpans of type `TYPE_DIGITS`.
open	`DurationBuilder` A builder for TtsSpans of type `TYPE_DURATION`.
open	`ElectronicBuilder` A builder for TtsSpans of type `TYPE_ELECTRONIC`.
open	`FractionBuilder` A builder for TtsSpans of type `TYPE_FRACTION`.
open	`MeasureBuilder` A builder for TtsSpans of type `TYPE_MEASURE`.
open	`MoneyBuilder` A builder for TtsSpans of type `TYPE_MONEY`.
open	`OrdinalBuilder` A builder for TtsSpans of type `TYPE_ORDINAL`.
open	`SemioticClassBuilder` A builder for TtsSpans, has setters for morphosyntactic features.
open	`TelephoneBuilder` A builder for TtsSpans of type `TYPE_TELEPHONE`.
open	`TextBuilder` A builder for TtsSpans of type `TYPE_TEXT`.
open	`TimeBuilder` A builder for TtsSpans of type `TYPE_TIME`.
open	`VerbatimBuilder` A builder for TtsSpans of type `TYPE_VERBATIM`.

Constants
static String	`ANIMACY_ANIMATE`
static String	`ANIMACY_INANIMATE`
static String	`ARG_ANIMACY` String argument supplying animacy information.
static String	`ARG_CASE` String argument supplying case information.
static String	`ARG_COUNTRY_CODE` Argument used to specify the country code of a telephone number.
static String	`ARG_CURRENCY` Argument used to specify the currency.
static String	`ARG_DAY` Argument used to specify the day of the month of a date.
static String	`ARG_DENOMINATOR` Argument used to specify the denominator of a fraction.
static String	`ARG_DIGITS` Argument used to specify a string of digits.
static String	`ARG_DOMAIN` Argument used to specify the domain part of a URI.
static String	`ARG_EXTENSION` Argument used to specify the extension part of a telephone number.
static String	`ARG_FRACTIONAL_PART` Argument used to specify the fractional part of a decimal.
static String	`ARG_FRAGMENT_ID` Argument used to specify the fragment id of a URI.
static String	`ARG_GENDER` String argument supplying gender information.
static String	`ARG_HOURS` Argument used to specify the hours of a time or duration.
static String	`ARG_INTEGER_PART` Argument used to specify the integer part of a decimal or fraction.
static String	`ARG_MINUTES` Argument used to specify the minutes of a time or duration.
static String	`ARG_MONTH` Argument used to specify the month of a date.
static String	`ARG_MULTIPLICITY` String argument supplying multiplicity information.
static String	`ARG_NUMBER` Argument used to specify a whole number.
static String	`ARG_NUMBER_PARTS` Argument used to specify the main number part of a telephone number.
static String	`ARG_NUMERATOR` Argument used to specify the numerator of a fraction.
static String	`ARG_PASSWORD` Argument used to specify the password part of a URI.
static String	`ARG_PATH` Argument used to specify the path part of a URI.
static String	`ARG_PORT` Argument used to specify the port number of a URI.
static String	`ARG_PROTOCOL` Argument used to specify the protocol of a URI.
static String	`ARG_QUANTITY` Argument used to choose the suffix (thousand, million, etc) that is used to pronounce large amounts of money.
static String	`ARG_QUERY_STRING` Argument used to specify the query string of a URI.
static String	`ARG_SECONDS` Argument used to specify the seconds of a time or duration.
static String	`ARG_TEXT` String supplying the text to be synthesized.
static String	`ARG_UNIT` Argument used to specify the unit of a measure.
static String	`ARG_USERNAME` Argument used to specify the username part of a URI.
static String	`ARG_VERBATIM` Argument used to specify a string where the characters are read verbatim, except whitespace.
static String	`ARG_WEEKDAY` Argument used to specify the weekday of a date.
static String	`ARG_YEAR` Argument used to specify the year of a date.
static String	`CASE_ABLATIVE`
static String	`CASE_ACCUSATIVE`
static String	`CASE_DATIVE`
static String	`CASE_GENITIVE`
static String	`CASE_INSTRUMENTAL`
static String	`CASE_LOCATIVE`
static String	`CASE_NOMINATIVE`
static String	`CASE_VOCATIVE`
static String	`GENDER_FEMALE`
static String	`GENDER_MALE`
static String	`GENDER_NEUTRAL`
static Int	`MONTH_APRIL`
static Int	`MONTH_AUGUST`
static Int	`MONTH_DECEMBER`
static Int	`MONTH_FEBRUARY`
static Int	`MONTH_JANUARY`
static Int	`MONTH_JULY`
static Int	`MONTH_JUNE`
static Int	`MONTH_MARCH`
static Int	`MONTH_MAY`
static Int	`MONTH_NOVEMBER`
static Int	`MONTH_OCTOBER`
static Int	`MONTH_SEPTEMBER`
static String	`MULTIPLICITY_DUAL`
static String	`MULTIPLICITY_PLURAL`
static String	`MULTIPLICITY_SINGLE`
static String	`TYPE_CARDINAL` The text associated with this span is a cardinal.
static String	`TYPE_DATE` The text associated with this span is a date.
static String	`TYPE_DECIMAL` The text associated with this span is a decimal number.
static String	`TYPE_DIGITS` The text associated with this span is a series of digits that have to be read sequentially.
static String	`TYPE_DURATION` The text associated with this span is a duration, consisting of a number of hours, minutes, and seconds specified with `ARG_HOURS`, `ARG_MINUTES`, and `ARG_SECONDS`.
static String	`TYPE_ELECTRONIC` The text associated with this span is a URI (can be used for URLs and email addresses).
static String	`TYPE_FRACTION` The text associated with this span is a fractional number.
static String	`TYPE_MEASURE` The text associated with this span is a measure, consisting of a number and a unit.
static String	`TYPE_MONEY` The text associated with this span is an amount of money.
static String	`TYPE_ORDINAL` The text associated with this span is an ordinal.
static String	`TYPE_TELEPHONE` The text associated with this span is a telephone number.
static String	`TYPE_TEXT` This span type can be used to add morphosyntactic features to the text it spans over, or synthesize a something else than the spanned text.
static String	`TYPE_TIME` The text associated with this span is a time, consisting of a number of hours, minutes, and seconds specified with `ARG_HOURS`, `ARG_MINUTES`, and `ARG_SECONDS`.
static String	`TYPE_VERBATIM` The text associated with this span is a series of characters that have to be read verbatim.
static Int	`WEEKDAY_FRIDAY`
static Int	`WEEKDAY_MONDAY`
static Int	`WEEKDAY_SATURDAY`
static Int	`WEEKDAY_SUNDAY`
static Int	`WEEKDAY_THURSDAY`
static Int	`WEEKDAY_TUESDAY`
static Int	`WEEKDAY_WEDNESDAY`

Public constructors
`TtsSpan(src: Parcel!)`
`TtsSpan(type: String!, args: PersistableBundle!)`

Public methods
open Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open PersistableBundle!	`getArgs()` Returns a bundle of the arguments set.
open Int	`getSpanTypeId()` Return a special type identifier for this span class.
open String!	`getType()` Returns the type.
open Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Constants

ANIMACY_ANIMATE

Added in API level 21

static val ANIMACY_ANIMATE: String

Value: "android.animate"

ANIMACY_INANIMATE

Added in API level 21

static val ANIMACY_INANIMATE: String

Value: "android.inanimate"

ARG_ANIMACY

Added in API level 21

static val ARG_ANIMACY: String

String argument supplying animacy information. Can be ANIMACY_ANIMATE or ANIMACY_INANIMATE

Value: "android.arg.animacy"

ARG_CASE

Added in API level 21

static val ARG_CASE: String

String argument supplying case information. Can be any of CASE_NOMINATIVE, CASE_ACCUSATIVE, CASE_DATIVE, CASE_ABLATIVE, CASE_GENITIVE, CASE_VOCATIVE, CASE_LOCATIVE and CASE_INSTRUMENTAL

Value: "android.arg.case"

ARG_COUNTRY_CODE

Added in API level 21

static val ARG_COUNTRY_CODE: String

Argument used to specify the country code of a telephone number. Can be a string of digits optionally prefixed with a "+". Can be used with TYPE_TELEPHONE.

Value: "android.arg.country_code"

ARG_CURRENCY

Added in API level 21

static val ARG_CURRENCY: String

Argument used to specify the currency. Should be a ISO4217 currency code, e.g. "USD". Can be used with TYPE_MONEY.

Value: "android.arg.money"

ARG_DAY

Added in API level 21

static val ARG_DAY: String

Argument used to specify the day of the month of a date. The value should be provided as an integer in the range from 1 up to and including 31. Can be used with TYPE_DATE.

Value: "android.arg.day"

ARG_DENOMINATOR

Added in API level 21

static val ARG_DENOMINATOR: String

Argument used to specify the denominator of a fraction. The value can be a string of digits of any size optionally prefixed with a + or -. Can be used with TYPE_FRACTION.

Value: "android.arg.denominator"

ARG_DIGITS

Added in API level 21

static val ARG_DIGITS: String

Argument used to specify a string of digits. Can be used with TYPE_DIGITS.

Value: "android.arg.digits