# ConvolutionFunction1D

# ConvolutionFunction1D

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

*** ** * ** ***

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

<br />

```
@UnstableApi
interface ConvolutionFunction1D
```

<br />

Known direct subclasses  
[GaussianFunction](https://developer.android.com/reference/kotlin/androidx/media3/effect/GaussianFunction)  

|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| [GaussianFunction](https://developer.android.com/reference/kotlin/androidx/media3/effect/GaussianFunction) | Implementation of a symmetric Gaussian function with a limited domain. |

*** ** * ** ***

An interface for 1 dimensional convolution functions.

The domain defines the region over which the function operates, in pixels.

## Summary

|                                                                                                                                               ### Nested types                                                                                                                                               |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `interface `[ConvolutionFunction1D.Provider](https://developer.android.com/reference/kotlin/androidx/media3/effect/ConvolutionFunction1D.Provider) A configurable provider for[ConvolutionFunction1D](https://developer.android.com/reference/kotlin/androidx/media3/effect/ConvolutionFunction1D)instances. |

|                              ### Public functions                               |
|---------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | [domainEnd](https://developer.android.com/reference/kotlin/androidx/media3/effect/ConvolutionFunction1D#domainEnd())`()` Returns the end of the domain.                                                                                                                          |
| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | [domainStart](https://developer.android.com/reference/kotlin/androidx/media3/effect/ConvolutionFunction1D#domainStart())`()` Returns the start of the domain.                                                                                                                    |
| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | [value](https://developer.android.com/reference/kotlin/androidx/media3/effect/ConvolutionFunction1D#value(float))`(samplePosition: `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)`)` Returns the value of the function at the`samplePosition`. |
| [Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html) | [width](https://developer.android.com/reference/kotlin/androidx/media3/effect/ConvolutionFunction1D#width())`()` Returns the width of the domain.                                                                                                                                |

## Public functions

### domainEnd

```
fun domainEnd(): Float
```

Returns the end of the domain.  

### domainStart

```
fun domainStart(): Float
```

Returns the start of the domain.  

### value

```
fun value(samplePosition: Float): Float
```

Returns the value of the function at the`samplePosition`.  

### width

```
fun width(): Float
```

Returns the width of the domain.