Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/text/style/TtsSpan#nestedclasses) \| [Constants](https://developer.android.com/reference/android/text/style/TtsSpan#constants) \| [Inherited Constants](https://developer.android.com/reference/android/text/style/TtsSpan#inhconstants) \| [Ctors](https://developer.android.com/reference/android/text/style/TtsSpan#pubctors) \| [Methods](https://developer.android.com/reference/android/text/style/TtsSpan#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/text/style/TtsSpan#inhmethods)

# TtsSpan

*** ** * ** ***


`
public


class
TtsSpan
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/text/ParcelableSpan


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.text.style.TtsSpan |

<br />

*** ** * ** ***

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 `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DATE`
or `https://developer.android.com/reference/android/text/style/TtsSpan#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 ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.Builder<C extends https://developer.android.com/reference/android/text/style/TtsSpan.Builder<?>>` A simple builder for TtsSpans. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.CardinalBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_CARDINAL`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.DateBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DATE`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.DecimalBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DECIMAL`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.DigitsBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DIGITS`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.DurationBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DURATION`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.ElectronicBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.FractionBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_FRACTION`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.MeasureBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_MEASURE`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.MoneyBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_MONEY`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.OrdinalBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ORDINAL`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.SemioticClassBuilder<C extends https://developer.android.com/reference/android/text/style/TtsSpan.SemioticClassBuilder<?>>` A builder for TtsSpans, has setters for morphosyntactic features. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.TelephoneBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TELEPHONE`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.TextBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TEXT`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.TimeBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME`. |
| ` class` | `https://developer.android.com/reference/android/text/style/TtsSpan.VerbatimBuilder` A builder for TtsSpans of type `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_VERBATIM`. |

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

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/text/style/TtsSpan#TtsSpan(android.os.Parcel)(https://developer.android.com/reference/android/os/Parcel src) ` |
| ` https://developer.android.com/reference/android/text/style/TtsSpan#TtsSpan(java.lang.String,%20android.os.PersistableBundle)(https://developer.android.com/reference/java/lang/String type, https://developer.android.com/reference/android/os/PersistableBundle args) ` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/text/style/TtsSpan#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/android/os/PersistableBundle` | ` https://developer.android.com/reference/android/text/style/TtsSpan#getArgs()() ` Returns a bundle of the arguments set. |
| ` int` | ` https://developer.android.com/reference/android/text/style/TtsSpan#getSpanTypeId()() ` Return a special type identifier for this span class. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/text/style/TtsSpan#getType()() ` Returns the type. |
| ` void` | ` https://developer.android.com/reference/android/text/style/TtsSpan#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/text/ParcelableSpan ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/text/ParcelableSpan#getSpanTypeId()() ` Return a special type identifier for this span class. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Constants

### ANIMACY_ANIMATE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ANIMACY_ANIMATE
```

<br />

<br />

Constant Value:

"android.animate"


### ANIMACY_INANIMATE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ANIMACY_INANIMATE
```

<br />

<br />

Constant Value:

"android.inanimate"


### ARG_ANIMACY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_ANIMACY
```

String argument supplying animacy information. Can be
`https://developer.android.com/reference/android/text/style/TtsSpan#ANIMACY_ANIMATE` or
`https://developer.android.com/reference/android/text/style/TtsSpan#ANIMACY_INANIMATE`

<br />

Constant Value:

"android.arg.animacy"


### ARG_CASE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_CASE
```

String argument supplying case information. Can be any of
`https://developer.android.com/reference/android/text/style/TtsSpan#CASE_NOMINATIVE`, `https://developer.android.com/reference/android/text/style/TtsSpan#CASE_ACCUSATIVE`, `https://developer.android.com/reference/android/text/style/TtsSpan#CASE_DATIVE`,
`https://developer.android.com/reference/android/text/style/TtsSpan#CASE_ABLATIVE`, `https://developer.android.com/reference/android/text/style/TtsSpan#CASE_GENITIVE`, `https://developer.android.com/reference/android/text/style/TtsSpan#CASE_VOCATIVE`,
`https://developer.android.com/reference/android/text/style/TtsSpan#CASE_LOCATIVE` and `https://developer.android.com/reference/android/text/style/TtsSpan#CASE_INSTRUMENTAL`

<br />

Constant Value:

"android.arg.case"


### ARG_COUNTRY_CODE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_COUNTRY_CODE
```

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 `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TELEPHONE`.

<br />

Constant Value:

"android.arg.country_code"


### ARG_CURRENCY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_CURRENCY
```

Argument used to specify the currency. Should be a ISO4217 currency code,
e.g. "USD".
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_MONEY`.

<br />

Constant Value:

"android.arg.money"


### ARG_DAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_DAY
```

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 `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DATE`.

<br />

Constant Value:

"android.arg.day"


### ARG_DENOMINATOR

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_DENOMINATOR
```

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 `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_FRACTION`.

<br />

Constant Value:

"android.arg.denominator"


### ARG_DIGITS

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_DIGITS
```

Argument used to specify a string of digits.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DIGITS`.

<br />

Constant Value:

"android.arg.digits"


### ARG_DOMAIN

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_DOMAIN
```

Argument used to specify the domain part of a URI. For example
"source.android.com".
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`.

<br />

Constant Value:

"android.arg.domain"


### ARG_EXTENSION

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_EXTENSION
```

Argument used to specify the extension part of a telephone number. Can be
a string of digits.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TELEPHONE`.

<br />

Constant Value:

"android.arg.extension"


### ARG_FRACTIONAL_PART

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_FRACTIONAL_PART
```

Argument used to specify the fractional part of a decimal. The value can
be a string of digits of any size.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DECIMAL`.

<br />

Constant Value:

"android.arg.fractional_part"


### ARG_FRAGMENT_ID

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_FRAGMENT_ID
```

Argument used to specify the fragment id of a URI. Should be specified as
a string.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`.

<br />

Constant Value:

"android.arg.fragment_id"


### ARG_GENDER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_GENDER
```

String argument supplying gender information. Can be any of
`https://developer.android.com/reference/android/text/style/TtsSpan#GENDER_NEUTRAL`, `https://developer.android.com/reference/android/text/style/TtsSpan#GENDER_MALE` and
`https://developer.android.com/reference/android/text/style/TtsSpan#GENDER_FEMALE`.

<br />

Constant Value:

"android.arg.gender"


### ARG_HOURS

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_HOURS
```

Argument used to specify the hours of a time or duration. The hours should be
provided as an integer in the range from 0 up to and including 24 for
`https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME`.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME` or `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DURATION`.

<br />

Constant Value:

"android.arg.hours"


### ARG_INTEGER_PART

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_INTEGER_PART
```

Argument used to specify the integer part of a decimal or fraction. The
value can be a string of digits of any size optionally prefixed with
a - or +.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DECIMAL` and `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_FRACTION`.

<br />

Constant Value:

"android.arg.integer_part"


### ARG_MINUTES

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_MINUTES
```

Argument used to specify the minutes of a time or duration. The minutes should be
provided as an integer in the range from 0 up to and including 59 for
`https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME`.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME` or `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DURATION`.

<br />

Constant Value:

"android.arg.minutes"


### ARG_MONTH

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_MONTH
```

Argument used to specify the month of a date. The value should be
provided as an integer and can be any of `https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_JANUARY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_FEBRUARY`, `https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_MARCH`, `https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_APRIL`,
`https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_MAY`, `https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_JUNE`, `https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_JULY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_AUGUST`, `https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_SEPTEMBER`, `https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_OCTOBER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_NOVEMBER` and `https://developer.android.com/reference/android/text/style/TtsSpan#MONTH_DECEMBER`.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DATE`.

<br />

Constant Value:

"android.arg.month"


### ARG_MULTIPLICITY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_MULTIPLICITY
```

String argument supplying multiplicity information. Can be any of
`https://developer.android.com/reference/android/text/style/TtsSpan#MULTIPLICITY_SINGLE`, `https://developer.android.com/reference/android/text/style/TtsSpan#MULTIPLICITY_DUAL` and
`https://developer.android.com/reference/android/text/style/TtsSpan#MULTIPLICITY_PLURAL`

<br />

Constant Value:

"android.arg.multiplicity"


### ARG_NUMBER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_NUMBER
```

Argument used to specify a whole number. The value can be a string of
digits of any size optionally prefixed with a - or +.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_CARDINAL` and `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ORDINAL`.

<br />

Constant Value:

"android.arg.number"


### ARG_NUMBER_PARTS

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_NUMBER_PARTS
```

Argument used to specify the main number part of a telephone number. Can
be a string of digits where the different parts of the telephone number
can be separated with a space, '-', '/' or '.'.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TELEPHONE`.

<br />

Constant Value:

"android.arg.number_parts"


### ARG_NUMERATOR

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_NUMERATOR
```

Argument used to specify the numerator of a fraction. The value can be a
string of digits of any size optionally prefixed with a - or +.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_FRACTION`.

<br />

Constant Value:

"android.arg.numerator"


### ARG_PASSWORD

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_PASSWORD
```

Argument used to specify the password part of a URI. Should be set as a
string.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`.

<br />

Constant Value:

"android.arg.password"


### ARG_PATH

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_PATH
```

Argument used to specify the path part of a URI. For example
"source/index.html".
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`.

<br />

Constant Value:

"android.arg.path"


### ARG_PORT

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_PORT
```

Argument used to specify the port number of a URI. Should be specified as
an integer.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`.

<br />

Constant Value:

"android.arg.port"


### ARG_PROTOCOL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_PROTOCOL
```

Argument used to specify the protocol of a URI. Examples are "http" and
"ftp".
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`.

<br />

Constant Value:

"android.arg.protocol"


### ARG_QUANTITY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_QUANTITY
```

Argument used to choose the suffix (thousand, million, etc) that is used
to pronounce large amounts of money. For example it can be used to
disambiguate between "two thousand five hundred dollars" and
"two point five thousand dollars".
If implemented, engines should support at least "1000", "1000000",
"1000000000" and "1000000000000".
Example: if the `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_INTEGER_PART` argument is "10", the
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_FRACTIONAL_PART` argument is "4", the `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_QUANTITY`
argument is "1000" and the `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CURRENCY` argument is "usd", the
TTS engine may pronounce the span as "ten point four thousand dollars".
With the same example but with the quantity set as "1000000" the TTS
engine may pronounce the span as "ten point four million dollars".
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_MONEY`.

<br />

Constant Value:

"android.arg.quantity"


### ARG_QUERY_STRING

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_QUERY_STRING
```

Argument used to specify the query string of a URI. For example
"arg=value\&argtwo=value".
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`.

<br />

Constant Value:

"android.arg.query_string"


### ARG_SECONDS

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_SECONDS
```

Argument used to specify the seconds of a time or duration. The seconds should be
provided as an integer in the range from 0 up to and including 59 for
`https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME`.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME` or `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DURATION`.

<br />

Constant Value:

"android.arg.seconds"


### ARG_TEXT

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_TEXT
```

String supplying the text to be synthesized. The synthesizer is free
to decide how to interpret the text.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TEXT`.

<br />

Constant Value:

"android.arg.text"


### ARG_UNIT

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_UNIT
```

Argument used to specify the unit of a measure. The unit should always be
specified in English singular form. Prefixes may be used. Engines will do
their best to pronounce them correctly in the language used. Engines are
expected to at least support the most common ones like "meter", "second",
"degree celsius" and "degree fahrenheit" with some common prefixes like
"milli" and "kilo".
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_MEASURE`.

<br />

Constant Value:

"android.arg.unit"


### ARG_USERNAME

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_USERNAME
```

Argument used to specify the username part of a URI. Should be set as a
string.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_ELECTRONIC`.

<br />

Constant Value:

"android.arg.username"


### ARG_VERBATIM

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_VERBATIM
```

Argument used to specify a string where the characters are read verbatim,
except whitespace.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_VERBATIM`.

<br />

Constant Value:

"android.arg.verbatim"


### ARG_WEEKDAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_WEEKDAY
```

Argument used to specify the weekday of a date. The value should be
provided as an integer and can be any of `https://developer.android.com/reference/android/text/style/TtsSpan#WEEKDAY_SUNDAY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#WEEKDAY_MONDAY`, `https://developer.android.com/reference/android/text/style/TtsSpan#WEEKDAY_TUESDAY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#WEEKDAY_WEDNESDAY`, `https://developer.android.com/reference/android/text/style/TtsSpan#WEEKDAY_THURSDAY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#WEEKDAY_FRIDAY` and `https://developer.android.com/reference/android/text/style/TtsSpan#WEEKDAY_SATURDAY`.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DATE`.

<br />

Constant Value:

"android.arg.weekday"


### ARG_YEAR

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String ARG_YEAR
```

Argument used to specify the year of a date. The value should be provided
as a positive integer.
Can be used with `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DATE`.

<br />

Constant Value:

"android.arg.year"


### CASE_ABLATIVE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String CASE_ABLATIVE
```

<br />

<br />

Constant Value:

"android.ablative"


### CASE_ACCUSATIVE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String CASE_ACCUSATIVE
```

<br />

<br />

Constant Value:

"android.accusative"


### CASE_DATIVE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String CASE_DATIVE
```

<br />

<br />

Constant Value:

"android.dative"


### CASE_GENITIVE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String CASE_GENITIVE
```

<br />

<br />

Constant Value:

"android.genitive"


### CASE_INSTRUMENTAL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String CASE_INSTRUMENTAL
```

<br />

<br />

Constant Value:

"android.instrumental"


### CASE_LOCATIVE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String CASE_LOCATIVE
```

<br />

<br />

Constant Value:

"android.locative"


### CASE_NOMINATIVE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String CASE_NOMINATIVE
```

<br />

<br />

Constant Value:

"android.nominative"


### CASE_VOCATIVE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String CASE_VOCATIVE
```

<br />

<br />

Constant Value:

"android.vocative"


### GENDER_FEMALE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String GENDER_FEMALE
```

<br />

<br />

Constant Value:

"android.female"


### GENDER_MALE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String GENDER_MALE
```

<br />

<br />

Constant Value:

"android.male"


### GENDER_NEUTRAL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String GENDER_NEUTRAL
```

<br />

<br />

Constant Value:

"android.neutral"


### MONTH_APRIL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_APRIL
```

<br />

<br />

Constant Value:

3
(0x00000003)


### MONTH_AUGUST

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_AUGUST
```

<br />

<br />

Constant Value:

7
(0x00000007)


### MONTH_DECEMBER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_DECEMBER
```

<br />

<br />

Constant Value:

11
(0x0000000b)


### MONTH_FEBRUARY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_FEBRUARY
```

<br />

<br />

Constant Value:

1
(0x00000001)


### MONTH_JANUARY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_JANUARY
```

<br />

<br />

Constant Value:

0
(0x00000000)


### MONTH_JULY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_JULY
```

<br />

<br />

Constant Value:

6
(0x00000006)


### MONTH_JUNE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_JUNE
```

<br />

<br />

Constant Value:

5
(0x00000005)


### MONTH_MARCH

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_MARCH
```

<br />

<br />

Constant Value:

2
(0x00000002)


### MONTH_MAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_MAY
```

<br />

<br />

Constant Value:

4
(0x00000004)


### MONTH_NOVEMBER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_NOVEMBER
```

<br />

<br />

Constant Value:

10
(0x0000000a)


### MONTH_OCTOBER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_OCTOBER
```

<br />

<br />

Constant Value:

9
(0x00000009)


### MONTH_SEPTEMBER

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MONTH_SEPTEMBER
```

<br />

<br />

Constant Value:

8
(0x00000008)


### MULTIPLICITY_DUAL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String MULTIPLICITY_DUAL
```

<br />

<br />

Constant Value:

"android.dual"


### MULTIPLICITY_PLURAL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String MULTIPLICITY_PLURAL
```

<br />

<br />

Constant Value:

"android.plural"


### MULTIPLICITY_SINGLE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String MULTIPLICITY_SINGLE
```

<br />

<br />

Constant Value:

"android.single"


### TYPE_CARDINAL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_CARDINAL
```

The text associated with this span is a cardinal. Must include the
number to be synthesized with `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_NUMBER`.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.cardinal"


### TYPE_DATE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_DATE
```

The text associated with this span is a date. At least one of the
arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MONTH` and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_YEAR` has to be provided.
The argument `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_DAY` is optional if `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MONTH` is set.
The argument `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_WEEKDAY` is optional if `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_DAY` is set.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.date"


### TYPE_DECIMAL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_DECIMAL
```

The text associated with this span is a decimal number. Must include the
number to be synthesized with `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_INTEGER_PART` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_FRACTIONAL_PART`.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.decimal"


### TYPE_DIGITS

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_DIGITS
```

The text associated with this span is a series of digits that have to be
read sequentially. The digits can be set with `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_DIGITS`.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.digits"


### TYPE_DURATION

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_DURATION
```

The text associated with this span is a duration, consisting of a number of
hours, minutes, and seconds specified with `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_HOURS`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MINUTES`, and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_SECONDS`. This is different from `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME`.
This should be used to convey an interval of time, while `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_TIME` should be used to
convey a particular moment in time, such as a clock time.

<br />

Constant Value:

"android.type.duration"


### TYPE_ELECTRONIC

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_ELECTRONIC
```

The text associated with this span is a URI (can be used for URLs and
email addresses). The full schema for URLs, which email addresses can
effectively be seen as a subset of, is:
protocol://username:password@domain:port/path?query_string#fragment_id
Hence populating just username and domain will read as an email address.
All arguments are optional, but at least one has to be provided:
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_PROTOCOL`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_USERNAME`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_PASSWORD`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_DOMAIN`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_PORT`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_PATH`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_QUERY_STRING` and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_FRAGMENT_ID`.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.electronic"


### TYPE_FRACTION

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_FRACTION
```

The text associated with this span is a fractional number. Must include
the number to be synthesized with `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_NUMERATOR` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_DENOMINATOR`. `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_INTEGER_PART` is optional
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.fraction"


### TYPE_MEASURE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_MEASURE
```

The text associated with this span is a measure, consisting of a number
and a unit. The number can be a cardinal, decimal or a fraction. Set the
number with the same arguments as `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_CARDINAL`,
`https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DECIMAL` or `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_FRACTION`. The unit can be
specified with `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_UNIT`.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.measure"


### TYPE_MONEY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_MONEY
```

The text associated with this span is an amount of money. Set the amount
with the same arguments as `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DECIMAL`.
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CURRENCY` is used to set the currency. `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_QUANTITY`
is optional.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.money"


### TYPE_ORDINAL

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_ORDINAL
```

The text associated with this span is an ordinal. Must include the
number to be synthesized with `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_NUMBER`.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.ordinal"


### TYPE_TELEPHONE

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_TELEPHONE
```

The text associated with this span is a telephone number. The argument
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_NUMBER_PARTS` is required. `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_COUNTRY_CODE` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_EXTENSION` are optional.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.telephone"


### TYPE_TEXT

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final 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. Use
the argument `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_TEXT` to set a different text.
Accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.text"


### TYPE_TIME

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_TIME
```

The text associated with this span is a time, consisting of a number of
hours, minutes, and seconds specified with `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_HOURS`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MINUTES`, and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_SECONDS`.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`. This is different from `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DURATION`. This should be used to
convey a particular moment in time, such as a clock time, while `https://developer.android.com/reference/android/text/style/TtsSpan#TYPE_DURATION` should
be used to convey an interval of time.

<br />

Constant Value:

"android.type.time"


### TYPE_VERBATIM

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final String TYPE_VERBATIM
```

The text associated with this span is a series of characters that have to
be read verbatim. The engine will attempt to read out any character like
punctuation but excluding whitespace. `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_VERBATIM` is required.
Also accepts the arguments `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_GENDER`,
`https://developer.android.com/reference/android/text/style/TtsSpan#ARG_ANIMACY`, `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_MULTIPLICITY` and `https://developer.android.com/reference/android/text/style/TtsSpan#ARG_CASE`.

<br />

Constant Value:

"android.type.verbatim"


### WEEKDAY_FRIDAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int WEEKDAY_FRIDAY
```

<br />

<br />

Constant Value:

6
(0x00000006)


### WEEKDAY_MONDAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int WEEKDAY_MONDAY
```

<br />

<br />

Constant Value:

2
(0x00000002)


### WEEKDAY_SATURDAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int WEEKDAY_SATURDAY
```

<br />

<br />

Constant Value:

7
(0x00000007)


### WEEKDAY_SUNDAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int WEEKDAY_SUNDAY
```

<br />

<br />

Constant Value:

1
(0x00000001)


### WEEKDAY_THURSDAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int WEEKDAY_THURSDAY
```

<br />

<br />

Constant Value:

5
(0x00000005)


### WEEKDAY_TUESDAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int WEEKDAY_TUESDAY
```

<br />

<br />

Constant Value:

3
(0x00000003)


### WEEKDAY_WEDNESDAY

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int WEEKDAY_WEDNESDAY
```

<br />

<br />

Constant Value:

4
(0x00000004)


## Public constructors

### TtsSpan

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public TtsSpan (Parcel src)
```

<br />

<br />

| Parameters ||
|---|---|
| `src` | `Parcel` <br /> |

### TtsSpan

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public TtsSpan (String type, 
                PersistableBundle args)
```

<br />

<br />

| Parameters ||
|---|---|
| `type` | `String` <br /> |
| `args` | `PersistableBundle` <br /> |

## Public methods

### describeContents

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getArgs

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PersistableBundle getArgs ()
```

Returns a bundle of the arguments set.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/PersistableBundle` | The bundle of the arguments set. <br /> |

### getSpanTypeId

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSpanTypeId ()
```

Return a special type identifier for this span class.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getType

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getType ()
```

Returns the type.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | The type of this instance. <br /> |

### writeToParcel

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |