TtsSpan Class

Definition

A span that supplies additional meta-data for the associated text intended for text-to-speech engines.

[Android.Runtime.Register("android/text/style/TtsSpan", DoNotGenerateAcw=true)]
public class TtsSpan : Java.Lang.Object, Android.Text.IParcelableSpan, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/text/style/TtsSpan", DoNotGenerateAcw=true)>]
type TtsSpan = class
    inherit Object
    interface IParcelableSpan
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Inheritance
TtsSpan
Attributes
Implements

Remarks

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.

Java documentation for android.text.style.TtsSpan.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

TtsSpan(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

TtsSpan(Parcel)
TtsSpan(String, PersistableBundle)

Fields

AnimacyAnimate
AnimacyInanimate
ArgAnimacy

String argument supplying animacy information.

ArgCase

String argument supplying case information.

ArgCountryCode

Argument used to specify the country code of a telephone number.

ArgCurrency

Argument used to specify the currency.

ArgDay

Argument used to specify the day of the month of a date.

ArgDenominator

Argument used to specify the denominator of a fraction.

ArgDigits

Argument used to specify a string of digits.

ArgDomain

Argument used to specify the domain part of a URI.

ArgExtension

Argument used to specify the extension part of a telephone number.

ArgFractionalPart

Argument used to specify the fractional part of a decimal.

ArgFragmentId

Argument used to specify the fragment id of a URI.

ArgGender

String argument supplying gender information.

ArgHours

Argument used to specify the hours of a time.

ArgIntegerPart

Argument used to specify the integer part of a decimal or fraction.

ArgMinutes

Argument used to specify the minutes of a time.

ArgMonth

Argument used to specify the month of a date.

ArgMultiplicity

String argument supplying multiplicity information.

ArgNumber

Argument used to specify a whole number.

ArgNumberParts

Argument used to specify the main number part of a telephone number.

ArgNumerator

Argument used to specify the numerator of a fraction.

ArgPassword

Argument used to specify the password part of a URI.

ArgPath

Argument used to specify the path part of a URI.

ArgPort

Argument used to specify the port number of a URI.

ArgProtocol

Argument used to specify the protocol of a URI.

ArgQuantity

Argument used to choose the suffix (thousand, million, etc) that is used to pronounce large amounts of money.

ArgQueryString

Argument used to specify the query string of a URI.

ArgText

String supplying the text to be synthesized.

ArgUnit

Argument used to specify the unit of a measure.

ArgUsername

Argument used to specify the username part of a URI.

ArgVerbatim

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

ArgWeekday

Argument used to specify the weekday of a date.

ArgYear

Argument used to specify the year of a date.

CaseAblative
CaseAccusative
CaseDative
CaseGenitive
CaseInstrumental
CaseLocative
CaseNominative
CaseVocative
GenderFemale
GenderMale
GenderNeutral
MultiplicityDual
MultiplicityPlural
MultiplicitySingle
TypeCardinal

The text associated with this span is a cardinal.

TypeDate

The text associated with this span is a date.

TypeDecimal

The text associated with this span is a decimal number.

TypeDigits

The text associated with this span is a series of digits that have to be read sequentially.

TypeElectronic

The text associated with this span is a URI (can be used for URLs and email addresses).

TypeFraction

The text associated with this span is a fractional number.

TypeMeasure

The text associated with this span is a measure, consisting of a number and a unit.

TypeMoney

The text associated with this span is an amount of money.

TypeOrdinal

The text associated with this span is an ordinal.

TypeTelephone

The text associated with this span is a telephone number.

TypeText

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.

TypeTime

The text associated with this span is a time, consisting of a number of hours and minutes, specified with #ARG_HOURS and #ARG_MINUTES.

TypeVerbatim

The text associated with this span is a series of characters that have to be read verbatim.

Properties

Args

Returns a bundle of the arguments set.

Class

Returns the runtime class of this Object.

(Inherited from Object)
Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
PeerReference (Inherited from Object)
SpanTypeId

Return a special type identifier for this span class.

ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Type

Returns the type.

Methods

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
DescribeContents()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime() (Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
WriteToParcel(Parcel, ParcelableWriteFlags)

Flatten this object in to a Parcel.

Explicit Interface Implementations

IJavaPeerable.Disposed() (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced() (Inherited from Object)
IJavaPeerable.Finalized() (Inherited from Object)
IJavaPeerable.JniManagedPeerState (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to