# CachedRegionTracker

# CachedRegionTracker

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

*** ** * ** ***

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

<br />

```
@UnstableApi
class CachedRegionTracker : Cache.Listener
```

<br />

*** ** * ** ***

Utility class for efficiently tracking regions of data that are stored in a[Cache](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache)for a given cache key.

## Summary

|                                    ### Constants                                    |
|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [CACHED_TO_END](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#CACHED_TO_END())` = -2` |
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [NOT_CACHED](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#NOT_CACHED())` = -1`       |

|                                                                                                                                                                                                                                                                           ### Public constructors                                                                                                                                                                                                                                                                            |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [CachedRegionTracker](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#CachedRegionTracker(androidx.media3.datasource.cache.Cache,java.lang.String,androidx.media3.extractor.ChunkIndex))`(cache: `[Cache](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache)`!, cacheKey: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!, chunkIndex: `[ChunkIndex](https://developer.android.com/reference/kotlin/androidx/media3/extractor/ChunkIndex)`!)` |

|                                     ### Public functions                                     |
|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `synchronized `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)   | [getRegionEndTimeMs](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#getRegionEndTimeMs(long))`(byteOffset: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)`)` When provided with a byte offset, this method locates the cached region within which the offset falls, and returns the approximate end position in milliseconds of that region.                                                                                                                                                                                                                                                                                                                                                        |
| `synchronized `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onSpanAdded](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#onSpanAdded(androidx.media3.datasource.cache.Cache,androidx.media3.datasource.cache.CacheSpan))`(cache: `[Cache](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache)`!, span: `[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)`!)` Called when a[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)is added to the cache.                                                                                                                                                                                                 |
| `synchronized `[Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html) | [onSpanRemoved](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#onSpanRemoved(androidx.media3.datasource.cache.Cache,androidx.media3.datasource.cache.CacheSpan))`(cache: `[Cache](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache)`!, span: `[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)`!)` Called when a[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)is removed from the cache.                                                                                                                                                                                         |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                | [onSpanTouched](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#onSpanTouched(androidx.media3.datasource.cache.Cache,androidx.media3.datasource.cache.CacheSpan,androidx.media3.datasource.cache.CacheSpan))`(cache: `[Cache](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache)`!, oldSpan: `[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)`!, newSpan: `[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)`!)` Called when an existing[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)is touched, causing it to be replaced. |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                | [release](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#release())`()`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

## Constants

### CACHED_TO_END

```
const val CACHED_TO_END = -2: Int
```  

### NOT_CACHED

```
const val NOT_CACHED = -1: Int
```  

## Public constructors

### CachedRegionTracker

```
CachedRegionTracker(cache: Cache!, cacheKey: String!, chunkIndex: ChunkIndex!)
```  

## Public functions

### getRegionEndTimeMs

```
synchronized fun getRegionEndTimeMs(byteOffset: Long): Int
```

When provided with a byte offset, this method locates the cached region within which the offset falls, and returns the approximate end position in milliseconds of that region. If the byte offset does not fall within a cached region then[NOT_CACHED](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#NOT_CACHED())is returned. If the cached region extends to the end of the stream,[CACHED_TO_END](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#CACHED_TO_END())is returned.  

|                                         Parameters                                          |
|---------------------------------------------------------------------------------------------|-------------------------------------------|
| `byteOffset: `[Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | The byte offset in the underlying stream. |

|                                   Returns                                   |
|-----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | The end position of the corresponding cache region,[NOT_CACHED](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#NOT_CACHED()), or[CACHED_TO_END](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/upstream/CachedRegionTracker#CACHED_TO_END()). |

### onSpanAdded

```
synchronized fun onSpanAdded(cache: Cache!, span: CacheSpan!): Unit
```

Called when a[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)is added to the cache.  

|                                                    Parameters                                                     |
|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| `cache: `[Cache](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache)`!`        | The source of the event.                                                                                         |
| `span: `[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)`!` | The added[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan). |

### onSpanRemoved

```
synchronized fun onSpanRemoved(cache: Cache!, span: CacheSpan!): Unit
```

Called when a[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)is removed from the cache.  

|                                                    Parameters                                                     |
|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| `cache: `[Cache](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache)`!`        | The source of the event.                                                                                           |
| `span: `[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)`!` | The removed[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan). |

### onSpanTouched

```
fun onSpanTouched(cache: Cache!, oldSpan: CacheSpan!, newSpan: CacheSpan!): Unit
```

Called when an existing[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)is touched, causing it to be replaced. The new[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)is guaranteed to represent the same data as the one it replaces, however[file](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan#file())and[lastTouchTimestamp](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan#lastTouchTimestamp())may have changed.

Note that for span replacement,[onSpanAdded](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache.Listener#onSpanAdded(androidx.media3.datasource.cache.Cache,androidx.media3.datasource.cache.CacheSpan))and[onSpanRemoved](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache.Listener#onSpanRemoved(androidx.media3.datasource.cache.Cache,androidx.media3.datasource.cache.CacheSpan))are not called in addition to this method.  

|                                                      Parameters                                                      |
|----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| `cache: `[Cache](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/Cache)`!`           | The source of the event.                                                                                                                              |
| `oldSpan: `[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)`!` | The old[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan), which has been removed from the cache. |
| `newSpan: `[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan)`!` | The new[CacheSpan](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheSpan), which has been added to the cache.     |

### release

```
fun release(): Unit
```