# MediaRouter2.ScanRequest.Builder

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/media/MediaRouter2.ScanRequest.Builder "View this page in Java")  

```
class Builder
```

|---|--------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                   ||
| ↳ | [android.media.MediaRouter2.ScanRequest.Builder](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest.Builder#) |

Builder class for[ScanRequest](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest).

## Summary

|                                                                                                                      Public constructors                                                                                                                       ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest.Builder#Builder())`()` Creates a builder for a[ScanRequest](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest)instance. |

|                                                                                                                                                                                                                                                   Public methods                                                                                                                                                                                                                                                    ||
|------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [MediaRouter2.ScanRequest](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest)                  | [build](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest.Builder#build())`()` Returns a new[ScanRequest](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest)instance.                                                                                                                                   |
| [MediaRouter2.ScanRequest.Builder](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest.Builder#) | [setScreenOffScan](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest.Builder#setScreenOffScan(kotlin.Boolean))`(`isScreenOffScan:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Sets whether the app is requesting to scan even while the screen is off, bypassing default scanning restrictions. |

## Public constructors

### Builder

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
Builder()
```

Creates a builder for a[ScanRequest](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest)instance.  
**See Also**

- [#requestScan(ScanRequest)](https://developer.android.com/reference/kotlin/android/media/MediaRouter2#requestScan(android.media.MediaRouter2.ScanRequest))

## Public methods

### build

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun build(): MediaRouter2.ScanRequest
```

Returns a new[ScanRequest](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest)instance.

|                                                                     Return                                                                     ||
|-------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [MediaRouter2.ScanRequest](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest) | This value cannot be`null`. |

### setScreenOffScan

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setScreenOffScan(isScreenOffScan: Boolean): MediaRouter2.ScanRequest.Builder
```

Sets whether the app is requesting to scan even while the screen is off, bypassing default scanning restrictions. Only apps holding[android.Manifest.permission#MEDIA_ROUTING_CONTROL](https://developer.android.com/reference/kotlin/android/Manifest.permission.html#MEDIA_ROUTING_CONTROL:kotlin.String)or[android.Manifest.permission#MEDIA_CONTENT_CONTROL](https://developer.android.com/reference/kotlin/android/Manifest.permission.html#MEDIA_CONTENT_CONTROL:kotlin.String)should set this to`true`.

|                                                                             Return                                                                              ||
|------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [MediaRouter2.ScanRequest.Builder](https://developer.android.com/reference/kotlin/android/media/MediaRouter2.ScanRequest.Builder#) | This value cannot be`null`. |

**See Also**

- [#requestScan(ScanRequest)](https://developer.android.com/reference/kotlin/android/media/MediaRouter2#requestScan(android.media.MediaRouter2.ScanRequest))