Added in API level 21

TtsSpan

Kotlin |Java

public class TtsSpan
extends Object implements ParcelableSpan

java.lang.Object
↳	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
`class`	`TtsSpan.Builder<C extends Builder<?>>` A simple builder for TtsSpans.
`class`	`TtsSpan.CardinalBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_CARDINAL`.
`class`	`TtsSpan.DateBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_DATE`.
`class`	`TtsSpan.DecimalBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_DECIMAL`.
`class`	`TtsSpan.DigitsBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_DIGITS`.
`class`	`TtsSpan.ElectronicBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_ELECTRONIC`.
`class`	`TtsSpan.FractionBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_FRACTION`.
`class`	`TtsSpan.MeasureBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_MEASURE`.
`class`	`TtsSpan.MoneyBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_MONEY`.
`class`	`TtsSpan.OrdinalBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_ORDINAL`.
`class`	`TtsSpan.SemioticClassBuilder<C extends SemioticClassBuilder<?>>` A builder for TtsSpans, has setters for morphosyntactic features.
`class`	`TtsSpan.TelephoneBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_TELEPHONE`.
`class`	`TtsSpan.TextBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_TEXT`.
`class`	`TtsSpan.TimeBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_TIME`.
`class`	`TtsSpan.VerbatimBuilder` A builder for TtsSpans of type `TtsSpan.TYPE_VERBATIM`.

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

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: 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
`TtsSpan(Parcel src)`
`TtsSpan(String type, PersistableBundle args)`

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

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.text.ParcelableSpan


      getSpanTypeId()

Return a special type identifier for this span class.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

ANIMACY_ANIMATE

Added in API level 21

public static final String ANIMACY_ANIMATE

Constant Value: "android.animate"

ANIMACY_INANIMATE

Added in API level 21

public static final String ANIMACY_INANIMATE

Constant Value: "android.inanimate"

ARG_ANIMACY

Added in API level 21

public static final String ARG_ANIMACY

String argument supplying animacy information. Can be ANIMACY_ANIMATE or ANIMACY_INANIMATE

Constant Value: "android.arg.animacy"

ARG_CASE

Added in API level 21

public static final String ARG_CASE

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

Constant Value: "android.arg.case"

ARG_COUNTRY_CODE

Added in API level 21

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 TYPE_TELEPHONE.

Constant Value: "android.arg.country_code"

ARG_CURRENCY

Added in API level 21

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 TYPE_MONEY.

Constant Value: "android.arg.money"

ARG_DAY

Added in API level 21

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 TYPE_DATE.

Constant Value: "android.arg.day"

ARG_DENOMINATOR

Added in API level 21

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 TYPE_FRACTION.

Constant Value: "android.arg.denominator"

ARG_DIGITS

Added in API level 21

public static final String ARG_DIGITS

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

Constant Value: "android.arg.digits"

ARG_DOMAIN

Added in API level 21

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 TYPE_ELECTRONIC.

Constant Value: "android.arg.domain"

ARG_EXTENSION

Added in API level 21

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 TYPE_TELEPHONE.

Constant Value: "android.arg.extension"

ARG_FRACTIONAL_PART

Added in API level 21

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 TYPE_DECIMAL.

Constant Value: "android.arg.fractional_part"

ARG_FRAGMENT_ID

Added in API level 21

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 TYPE_ELECTRONIC.

Constant Value: "android.arg.fragment_id"

ARG_GENDER

Added in API level 21

public static final String ARG_GENDER

String argument supplying gender information. Can be any of GENDER_NEUTRAL, GENDER_MALE and GENDER_FEMALE.

Constant Value: "android.arg.gender"

ARG_HOURS

Added in API level 21

public static final String ARG_HOURS

Argument used to specify the hours of a time. The hours should be provided as an integer in the range from 0 up to and including 24. Can be used with TYPE_TIME.

Constant Value: "android.arg.hours"

ARG_INTEGER_PART

Added in API level 21

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 TYPE_DECIMAL and TYPE_FRACTION.

Constant Value: "android.arg.integer_part"

ARG_MINUTES

Added in API level 21

public static final String ARG_MINUTES

Argument used to specify the minutes of a time. The minutes should be provided as an integer in the range from 0 up to and including 59. Can be used with TYPE_TIME.

Constant Value: "android.arg.minutes"

ARG_MONTH

Added in API level 21

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 MONTH_JANUARY, MONTH_FEBRUARY, MONTH_MARCH, MONTH_APRIL, MONTH_MAY, MONTH_JUNE, MONTH_JULY, MONTH_AUGUST, MONTH_SEPTEMBER, MONTH_OCTOBER, MONTH_NOVEMBER and MONTH_DECEMBER. Can be used with TYPE_DATE.

Constant Value: "android.arg.month"

ARG_MULTIPLICITY

Added in API level 21

public static final String ARG_MULTIPLICITY

String argument supplying multiplicity information. Can be any of MULTIPLICITY_SINGLE, MULTIPLICITY_DUAL and MULTIPLICITY_PLURAL

Constant Value: "android.arg.multiplicity"

ARG_NUMBER

Added in API level 21

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 TYPE_CARDINAL and TYPE_ORDINAL.

Constant Value: "android.arg.number"

ARG_NUMBER_PARTS

Added in API level 21

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 TYPE_TELEPHONE.

Constant Value: "android.arg.number_parts"

ARG_NUMERATOR

Added in API level 21

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 TYPE_FRACTION.

Constant Value: "android.arg.numerator"

ARG_PASSWORD

Added in API level 21

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 TYPE_ELECTRONIC.

Constant Value: "android.arg.password"

ARG_PATH

Added in API level 21

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 TYPE_ELECTRONIC.

Constant Value: "android.arg.path"

ARG_PORT

Added in API level 21

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 TYPE_ELECTRONIC.

Constant Value: "android.arg.port"

ARG_PROTOCOL

Added in API level 21

public static final String ARG_PROTOCOL

Argument used to specify the protocol of a URI. Examples are "http" and "ftp". Can be used with TYPE_ELECTRONIC.

Constant Value: "android.arg.protocol"

ARG_QUANTITY

Added in API level 21

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 ARG_INTEGER_PART argument is "10", the ARG_FRACTIONAL_PART argument is "4", the ARG_QUANTITY argument is "1000" and the 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 TYPE_MONEY.

Constant Value: "android.arg.quantity"

ARG_QUERY_STRING

Added in API level 21

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 TYPE_ELECTRONIC.

Constant Value: "android.arg.query_string"

ARG_TEXT

Added in API level 21

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 TYPE_TEXT.

Constant Value: "android.arg.text"

ARG_UNIT

Added in API level 21

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 TYPE_MEASURE.

Constant Value: "android.arg.unit"

ARG_USERNAME

Added in API level 21

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 TYPE_ELECTRONIC.

Constant Value: "android.arg.username"

ARG_VERBATIM

Added in API level 21

public static final String ARG_VERBATIM

Argument used to specify a string where the characters are read verbatim, except whitespace. Can be used with TYPE_VERBATIM.

Constant Value: "android.arg.verbatim"

ARG_WEEKDAY

Added in API level 21

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 WEEKDAY_SUNDAY, WEEKDAY_MONDAY, WEEKDAY_TUESDAY, WEEKDAY_WEDNESDAY, WEEKDAY_THURSDAY, WEEKDAY_FRIDAY and WEEKDAY_SATURDAY. Can be used with TYPE_DATE.

Constant Value: "android.arg.weekday"

ARG_YEAR

Added in API level 21

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 TYPE_DATE.

Constant Value: "android.arg.year"

CASE_ABLATIVE

Added in API level 21

public static final String CASE_ABLATIVE

Constant Value: "android.ablative"

CASE_ACCUSATIVE

Added in API level 21

public static final String CASE_ACCUSATIVE

Constant Value: "android.accusative"

CASE_DATIVE

Added in API level 21

public static final String CASE_DATIVE

Constant Value: "android.dative"

CASE_GENITIVE

Added in API level 21

public static final String CASE_GENITIVE

Constant Value: "android.genitive"

CASE_INSTRUMENTAL

Added in API level 21

public static final String CASE_INSTRUMENTAL

Constant Value: "android.instrumental"

CASE_LOCATIVE

Added in API level 21

public static final String CASE_LOCATIVE

Constant Value: "android.locative"

CASE_NOMINATIVE

Added in API level 21

public static final String CASE_NOMINATIVE

Constant Value: "android.nominative"

CASE_VOCATIVE

Added in API level 21

public static final String CASE_VOCATIVE

Constant Value: "android.vocative"

GENDER_FEMALE

Added in API level 21

public static final String GENDER_FEMALE

Constant Value: "android.female"

GENDER_MALE

Added in API level 21

public static final String GENDER_MALE

Constant Value: "android.male"

GENDER_NEUTRAL

Added in API level 21

public static final String GENDER_NEUTRAL

Constant Value: "android.neutral"

MONTH_APRIL

Added in API level 21

public static final int MONTH_APRIL

Constant Value: 3 (0x00000003)

MONTH_AUGUST

Added in API level 21

public static final int MONTH_AUGUST

Constant Value: 7 (0x00000007)

MONTH_DECEMBER

Added in API level 21

public static final int MONTH_DECEMBER

Constant Value: 11 (0x0000000b)

MONTH_FEBRUARY

Added in API level 21

public static final int MONTH_FEBRUARY

Constant Value: 1 (0x00000001)

MONTH_JANUARY

Added in API level 21

public static final int MONTH_JANUARY

Constant Value: 0 (0x00000000)

MONTH_JULY

Added in API level 21

public static final int MONTH_JULY

Constant Value: 6 (0x00000006)

MONTH_JUNE

Added in API level 21

public static final int MONTH_JUNE

Constant Value: 5 (0x00000005)

MONTH_MARCH

Added in API level 21

public static final int MONTH_MARCH

Constant Value: 2 (0x00000002)

MONTH_MAY

Added in API level 21

public static final int MONTH_MAY

Constant Value: 4 (0x00000004)

MONTH_NOVEMBER

Added in API level 21

public static final int MONTH_NOVEMBER

Constant Value: 10 (0x0000000a)

MONTH_OCTOBER

Added in API level 21

public static final int MONTH_OCTOBER

Constant Value: 9 (0x00000009)

MONTH_SEPTEMBER

Added in API level 21

public static final int MONTH_SEPTEMBER

Constant Value: 8 (0x00000008)

MULTIPLICITY_DUAL

Added in API level 21

public static final String MULTIPLICITY_DUAL

Constant Value: "android.dual"

MULTIPLICITY_PLURAL

Added in API level 21

public static final String MULTIPLICITY_PLURAL

Constant Value: "android.plural"

MULTIPLICITY_SINGLE

Added in API level 21

public static final String MULTIPLICITY_SINGLE

Constant Value: "android.single"

TYPE_CARDINAL

Added in API level 21

public static final String TYPE_CARDINAL

The text associated with this span is a cardinal. Must include the number to be synthesized with ARG_NUMBER. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.cardinal"

TYPE_DATE

Added in API level 21

public static final String TYPE_DATE

The text associated with this span is a date. At least one of the arguments ARG_MONTH and ARG_YEAR has to be provided. The argument ARG_DAY is optional if ARG_MONTH is set. The argument ARG_WEEKDAY is optional if ARG_DAY is set. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.date"

TYPE_DECIMAL

Added in API level 21

public static final String TYPE_DECIMAL

The text associated with this span is a decimal number. Must include the number to be synthesized with ARG_INTEGER_PART and ARG_FRACTIONAL_PART. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.decimal"

TYPE_DIGITS

Added in API level 21

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 ARG_DIGITS. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.digits"

TYPE_ELECTRONIC

Added in API level 21

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: ARG_PROTOCOL, ARG_USERNAME, ARG_PASSWORD, ARG_DOMAIN, ARG_PORT, ARG_PATH, ARG_QUERY_STRING and ARG_FRAGMENT_ID. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.electronic"

TYPE_FRACTION

Added in API level 21

public static final String TYPE_FRACTION

The text associated with this span is a fractional number. Must include the number to be synthesized with ARG_NUMERATOR and ARG_DENOMINATOR. ARG_INTEGER_PART is optional Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.fraction"

TYPE_MEASURE

Added in API level 21

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 TYPE_CARDINAL, TYPE_DECIMAL or TYPE_FRACTION. The unit can be specified with ARG_UNIT. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.measure"

TYPE_MONEY

Added in API level 21

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 TYPE_DECIMAL. ARG_CURRENCY is used to set the currency. ARG_QUANTITY is optional. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.money"

TYPE_ORDINAL

Added in API level 21

public static final String TYPE_ORDINAL

The text associated with this span is an ordinal. Must include the number to be synthesized with ARG_NUMBER. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.ordinal"

TYPE_TELEPHONE

Added in API level 21

public static final String TYPE_TELEPHONE

The text associated with this span is a telephone number. The argument ARG_NUMBER_PARTS is required. ARG_COUNTRY_CODE and ARG_EXTENSION are optional. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.telephone"

TYPE_TEXT

Added in API level 21

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 ARG_TEXT to set a different text. Accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.text"

TYPE_TIME

Added in API level 21

public static final String TYPE_TIME

The text associated with this span is a time, consisting of a number of hours and minutes, specified with ARG_HOURS and ARG_MINUTES. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.time"

TYPE_VERBATIM

Added in API level 21

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. ARG_VERBATIM is required. Also accepts the arguments ARG_GENDER, ARG_ANIMACY, ARG_MULTIPLICITY and ARG_CASE.

Constant Value: "android.type.verbatim"

WEEKDAY_FRIDAY

Added in API level 21

public static final int WEEKDAY_FRIDAY

Constant Value: 6 (0x00000006)

WEEKDAY_MONDAY

Added in API level 21

public static final int WEEKDAY_MONDAY

Constant Value: 2 (0x00000002)

WEEKDAY_SATURDAY

Added in API level 21

public static final int WEEKDAY_SATURDAY

Constant Value: 7 (0x00000007)

WEEKDAY_SUNDAY

Added in API level 21

public static final int WEEKDAY_SUNDAY

Constant Value: 1 (0x00000001)

WEEKDAY_THURSDAY

Added in API level 21

public static final int WEEKDAY_THURSDAY

Constant Value: 5 (0x00000005)

WEEKDAY_TUESDAY

Added in API level 21

public static final int WEEKDAY_TUESDAY

Constant Value: 3 (0x00000003)

WEEKDAY_WEDNESDAY

Added in API level 21

public static final int WEEKDAY_WEDNESDAY

Constant Value: 4 (0x00000004)

Public constructors

TtsSpan

Added in API level 21

public TtsSpan (Parcel src)

Parameters
`src`	`Parcel`

TtsSpan

Added in API level 21

public TtsSpan (String type, 
                PersistableBundle args)

Parameters
`type`	`String`
`args`	`PersistableBundle`

Public methods

describeContents

Added in API level 21

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 writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getArgs

Added in API level 21

public PersistableBundle getArgs ()

Returns a bundle of the arguments set.

Returns
`PersistableBundle`	The bundle of the arguments set.

getSpanTypeId

Added in API level 21

public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
`int`

getType

Added in API level 21

public String getType ()

Returns the type.

Returns
`String`	The type of this instance.

writeToParcel

Added in API level 21

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

TtsSpan

Summary

Nested classes

Constants

Inherited constants

Public constructors

Public methods

Inherited methods

Constants

ANIMACY_ANIMATE

ANIMACY_INANIMATE

ARG_ANIMACY

ARG_CASE

ARG_COUNTRY_CODE

ARG_CURRENCY

ARG_DAY

ARG_DENOMINATOR

ARG_DIGITS

ARG_DOMAIN

ARG_EXTENSION

ARG_FRACTIONAL_PART

ARG_FRAGMENT_ID

ARG_GENDER

ARG_HOURS

ARG_INTEGER_PART

ARG_MINUTES

ARG_MONTH

ARG_MULTIPLICITY

ARG_NUMBER

ARG_NUMBER_PARTS

ARG_NUMERATOR

ARG_PASSWORD

ARG_PATH

ARG_PORT

ARG_PROTOCOL

ARG_QUANTITY

ARG_QUERY_STRING

ARG_TEXT

ARG_UNIT

ARG_USERNAME

ARG_VERBATIM

ARG_WEEKDAY

ARG_YEAR

CASE_ABLATIVE

CASE_ACCUSATIVE

CASE_DATIVE

CASE_GENITIVE

CASE_INSTRUMENTAL

CASE_LOCATIVE

CASE_NOMINATIVE

CASE_VOCATIVE

GENDER_FEMALE

GENDER_MALE

GENDER_NEUTRAL

MONTH_APRIL

MONTH_AUGUST

MONTH_DECEMBER

MONTH_FEBRUARY

MONTH_JANUARY

MONTH_JULY

MONTH_JUNE

MONTH_MARCH

MONTH_MAY

MONTH_NOVEMBER

MONTH_OCTOBER

MONTH_SEPTEMBER

MULTIPLICITY_DUAL

MULTIPLICITY_PLURAL

MULTIPLICITY_SINGLE

TYPE_CARDINAL

TYPE_DATE

TYPE_DECIMAL

TYPE_DIGITS

TYPE_ELECTRONIC

TYPE_FRACTION

TYPE_MEASURE

TYPE_MONEY

TYPE_ORDINAL

TYPE_TELEPHONE

TYPE_TEXT