# AnimationParameterBuilders.Repeatable

# AnimationParameterBuilders.Repeatable

Artifact:[androidx.wear.protolayout:protolayout-expression](https://developer.android.com/jetpack/androidx/releases/wear-protolayout)  
[View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/expression/AnimationParameterBuilders.java+class:androidx.wear.protolayout.expression.AnimationParameterBuilders.Repeatable)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable "View this page in Java")

<br />

```
@RequiresSchemaVersion(major = 1, minor = 200)
class AnimationParameterBuilders.Repeatable
```

<br />

*** ** * ** ***

The repeatable mode to be used for specifying how many times animation will be repeated.

## Summary

|                                                                                                                                                               ### Nested types                                                                                                                                                                |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[AnimationParameterBuilders.Repeatable.Builder](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable.Builder) Builder for[Repeatable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable) |

|                                                                                 ### Constants                                                                                 |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[AnimationParameterBuilders.Repeatable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable)`!` | `@`[RequiresSchemaVersion](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/RequiresSchemaVersion)`(major = 1, minor = 200)` [INFINITE_REPEATABLE_WITH_RESTART](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#INFINITE_REPEATABLE_WITH_RESTART()) An infinite[Repeatable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable)where animation restarts from the beginning when repeated. |
| `const `[AnimationParameterBuilders.Repeatable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable)`!` | `@`[RequiresSchemaVersion](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/RequiresSchemaVersion)`(major = 1, minor = 200)` [INFINITE_REPEATABLE_WITH_REVERSE](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#INFINITE_REPEATABLE_WITH_REVERSE()) An infinite[Repeatable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable)where animation is played in reverse when repeated.        |

|                                                                                  ### Public functions                                                                                   |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [AnimationParameterBuilders.AnimationParameters](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.AnimationParameters)`?` | [getForwardRepeatOverride](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#getForwardRepeatOverride())`()` Gets optional custom parameters for the forward passes of animation.                                                                                                                                                                                               |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                                                                             | [getIterations](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#getIterations())`()` Gets the number specifying how many times animation will be repeated. this method can only be called if[hasInfiniteIteration](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#hasInfiniteIteration())is false. |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                                                                             | [getRepeatMode](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#getRepeatMode())`()` Gets the repeat mode to specify how animation will behave when repeated.                                                                                                                                                                                                                 |
| [AnimationParameterBuilders.AnimationParameters](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.AnimationParameters)`?` | [getReverseRepeatOverride](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#getReverseRepeatOverride())`()` Gets optional custom parameters for the reverse passes of animation.                                                                                                                                                                                               |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                                                                     | [hasInfiniteIteration](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#hasInfiniteIteration())`()` Returns true if the animation has indefinite repeat.                                                                                                                                                                                                                       |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)                                                                                                       | [toString](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#toString())`()`                                                                                                                                                                                                                                                                                                    |

## Constants

### INFINITE_REPEATABLE_WITH_RESTART

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
@RequiresSchemaVersion(major = 1, minor = 200)
const val INFINITE_REPEATABLE_WITH_RESTART: AnimationParameterBuilders.Repeatable!
```

An infinite[Repeatable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable)where animation restarts from the beginning when repeated.  

### INFINITE_REPEATABLE_WITH_REVERSE

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
@RequiresSchemaVersion(major = 1, minor = 200)
const val INFINITE_REPEATABLE_WITH_REVERSE: AnimationParameterBuilders.Repeatable!
```

An infinite[Repeatable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable)where animation is played in reverse when repeated.  

## Public functions

### getForwardRepeatOverride

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getForwardRepeatOverride(): AnimationParameterBuilders.AnimationParameters?
```

Gets optional custom parameters for the forward passes of animation.  

### getIterations

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getIterations(): Int
```

Gets the number specifying how many times animation will be repeated. this method can only be called if[hasInfiniteIteration](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#hasInfiniteIteration())is false.  

|                                                     Throws                                                      |
|-----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [java.lang.IllegalStateException](https://developer.android.com/reference/java/lang/IllegalStateException.html) | if[hasInfiniteIteration](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/expression/AnimationParameterBuilders.Repeatable#hasInfiniteIteration())is true. |

### getRepeatMode

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getRepeatMode(): Int
```

Gets the repeat mode to specify how animation will behave when repeated.  

### getReverseRepeatOverride

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getReverseRepeatOverride(): AnimationParameterBuilders.AnimationParameters?
```

Gets optional custom parameters for the reverse passes of animation.  

### hasInfiniteIteration

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun hasInfiniteIteration(): Boolean
```

Returns true if the animation has indefinite repeat.  

### toString

```
fun toString(): String
```