# RubySpan

# RubySpan

Artifact:[androidx.media3:media3-common](https://developer.android.com/jetpack/androidx/releases/media3)  
[View Source](https://cs.android.com/search?q=file:androidx/media3/common/text/RubySpan.java+class:androidx.media3.common.text.RubySpan)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/media3/common/text/RubySpan "View this page in Java")

<br />

```
@UnstableApi
class RubySpan : LanguageFeatureSpan
```

<br />

*** ** * ** ***

A styling span for ruby text.

The text covered by this span is known as the "base text", and the ruby text is stored in[rubyText](https://developer.android.com/reference/kotlin/androidx/media3/common/text/RubySpan#rubyText()).

More information on[ruby characters](https://en.wikipedia.org/wiki/Ruby_character)and[span styling](https://developer.android.com/guide/topics/text/spans).

## Summary

|                                                                                                                                                                                                                  ### Public constructors                                                                                                                                                                                                                   |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [RubySpan](https://developer.android.com/reference/kotlin/androidx/media3/common/text/RubySpan#RubySpan(java.lang.String,int))`(rubyText: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!, @`[TextAnnotation.Position](https://developer.android.com/reference/kotlin/androidx/media3/common/text/TextAnnotation.Position)` position: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` |

|                                               ### Public functions                                               |
|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `java-static `[RubySpan](https://developer.android.com/reference/kotlin/androidx/media3/common/text/RubySpan)`!` | [fromBundle](https://developer.android.com/reference/kotlin/androidx/media3/common/text/RubySpan#fromBundle(android.os.Bundle))`(bundle: `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)`!)` |
| [Bundle](https://developer.android.com/reference/android/os/Bundle.html)`!`                                      | [toBundle](https://developer.android.com/reference/kotlin/androidx/media3/common/text/RubySpan#toBundle())`()`                                                                                                         |

|                                ### Public properties                                 |
|--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)          | `@`[TextAnnotation.Position](https://developer.android.com/reference/kotlin/androidx/media3/common/text/TextAnnotation.Position) [position](https://developer.android.com/reference/kotlin/androidx/media3/common/text/RubySpan#position()) The position of the ruby text relative to the base text. |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!` | [rubyText](https://developer.android.com/reference/kotlin/androidx/media3/common/text/RubySpan#rubyText()) The ruby text, i.e. the smaller explanatory characters.                                                                                                                                   |

## Public constructors

### RubySpan

```
RubySpan(rubyText: String!, @TextAnnotation.Position position: Int)
```  

## Public functions

### fromBundle

```
java-static fun fromBundle(bundle: Bundle!): RubySpan!
```  

### toBundle

```
fun toBundle(): Bundle!
```  

## Public properties

### position

```
@TextAnnotation.Position
val position: Int
```

The position of the ruby text relative to the base text.  

### rubyText

```
val rubyText: String!
```

The ruby text, i.e. the smaller explanatory characters.