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

# MediaProjectionConfig

*** ** * ** ***

```
class MediaProjectionConfig : Parcelable
```

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

Configure the `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection` session requested from `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionManager#createScreenCaptureIntent(android.media.projection.MediaProjectionConfig)`.

This configuration should be used to provide the user with options for choosing the content to be shared with the requesting application.

## Summary

| Nested classes ||
|---|---|
|   | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig.Builder` <br /> |

| Constants ||
|---|---|
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP:kotlin.Int` Bitmask for setting whether this configuration is for projecting the a single application. |
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP_CONTENT:kotlin.Int` Bitmask for setting whether this configuration is for projecting the content provided by an application. |
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_DISPLAY:kotlin.Int` Bitmask for setting whether this configuration is for projecting the whole display. |

| Inherited constants ||
|---|---|
| From class `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#` |---|---| | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int` Descriptor bit used with `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. <br /> | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int` Flag for use with `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.Int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". Some implementations may want to release resources at this point. <br /> | ||

| Public methods ||
|---|---|
| static [MediaProjectionConfig](https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#createConfigForDefaultDisplay()()` Returns an instance which restricts the user to capturing the default display. |
| static [MediaProjectionConfig](https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#createConfigForUserChoice()()` Returns an instance which allows the user to decide which region is captured. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#describeContents()()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#equals(kotlin.Any)(other: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?)` Indicates whether some other object is "equal to" this one. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#getInitiallySelectedSource()()` Returns a bit mask of one, and only one, of the projection type flag. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#getProjectionSources()()` A bitmask representing of requested projection sources. |
| [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)? | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#getRequesterHint()()` A hint set by the requesting app indicating who the requester of this `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection` session is. |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#hashCode()()` Returns a hash code value for the object. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#isAudioRequested()()` Returns true if the application requesting the media projection session is requesting to capture audio as well. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#isOwnAppContentProvided()()` Returns true if the application requesting the media projection session is offering its own content to be picked in the UI picker. |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#isSourceEnabled(kotlin.Int)(projectionSource: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Returns true if the provided source should be enabled. |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#toString()()` Returns a string representation of the object. |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#writeToParcel(android.os.Parcel,%20kotlin.Int)(dest: https://developer.android.com/reference/kotlin/android/os/Parcel.html#, flags: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Flatten this object in to a Parcel. |

| Properties ||
|---|---|
| static [Parcelable.Creator](https://developer.android.com/reference/kotlin/android/os/Parcelable.Creator.html#)\<[MediaProjectionConfig](https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#)!\> | `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#CREATOR:android.os.Parcelable.Creator` <br /> |

## Constants

### PROJECTION_SOURCE_APP

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

```
static val PROJECTION_SOURCE_APP: Int
```

Bitmask for setting whether this configuration is for projecting the a single application.

    Value: 8

### PROJECTION_SOURCE_APP_CONTENT

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

```
static val PROJECTION_SOURCE_APP_CONTENT: Int
```

Bitmask for setting whether this configuration is for projecting the content provided by an application.

    Value: 16

### PROJECTION_SOURCE_DISPLAY

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

```
static val PROJECTION_SOURCE_DISPLAY: Int
```

Bitmask for setting whether this configuration is for projecting the whole display.

    Value: 2

## Public methods

### createConfigForDefaultDisplay

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

```
static fun createConfigForDefaultDisplay(): MediaProjectionConfig
```

Returns an instance which restricts the user to capturing the default display.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#` | This value cannot be `null`. |

### createConfigForUserChoice

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

```
static fun createConfigForUserChoice(): MediaProjectionConfig
```

Returns an instance which allows the user to decide which region is captured. The consent dialog presents the user with all possible options. If the user selects display capture, then only the `https://developer.android.com/reference/kotlin/android/view/Display.html#DEFAULT_DISPLAY:kotlin.Int` is supported.

When passed in to `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionManager#createScreenCaptureIntent(android.media.projection.MediaProjectionConfig)`, the consent dialog shown to the user will be the same as if just `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionManager#createScreenCaptureIntent()` was invoked.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#` | This value cannot be `null`. |

### describeContents

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

```
fun describeContents(): Int
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.Int)`, the return value of this method must include the `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int` bit.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int` |

### equals

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

```
fun equals(other: Any?): Boolean
```

Indicates whether some other object is "equal to" this one.

The `equals` method implements an equivalence relation on non-null object references:

- It is *reflexive* : for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric* : for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive* : for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent* : for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.

An equivalence relation partitions the elements it operates on into *equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

| Parameters ||
|---|---|
| `obj` | the reference object with which to compare. |
| `o` | This value may be `null`. |

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` if this object is the same as the obj argument; `false` otherwise. |

### getInitiallySelectedSource

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

```
fun getInitiallySelectedSource(): Int
```

Returns a bit mask of one, and only one, of the projection type flag.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_DISPLAY:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP_CONTENT:kotlin.Int` |

### getProjectionSources

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

```
fun getProjectionSources(): Int
```

A bitmask representing of requested projection sources.

The system supports different kind of media projection session. Although the user is picking the target content, the requesting application can configure the choices displayed to the user.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_DISPLAY:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP_CONTENT:kotlin.Int` |

### getRequesterHint

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

```
fun getRequesterHint(): CharSequence?
```

A hint set by the requesting app indicating who the requester of this `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjection` session is.

The UI component prompting the user for the permission to start the session can use this hint to provide more information about the origin of the request (e.g. a browser tab title, a meeting id if sharing to a video conferencing app, a player name if sharing the screen within a game).

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html?` | the hint to be displayed if set, null otherwise. |

### hashCode

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

```
fun hashCode(): Int
```

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `https://developer.android.com/reference/kotlin/java/util/HashMap.html#`.

The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | a hash code value for this object. |

### isAudioRequested

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

```
fun isAudioRequested(): Boolean
```

Returns true if the application requesting the media projection session is requesting to capture audio as well.

If true, the UI component should display an option for the user to enable audio sharing.

The audio source will depend on the projection source (`https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#getProjectionSources()`) chosen by the user.
**See Also**

- `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig.Builder#setAudioRequested(kotlin.Boolean)`

### isOwnAppContentProvided

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

```
fun isOwnAppContentProvided(): Boolean
```

Returns true if the application requesting the media projection session is offering its own content to be picked in the UI picker.

The requester must also have enabled `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP_CONTENT:kotlin.Int` for the content to be shown in the picker.

If set, the requesting app's content will replace any other app content that might have been enabled.
**See Also**

- `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig.Builder#setOwnAppContentProvided(kotlin.Boolean)`
- `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig.Builder#setSourceEnabled(kotlin.Int,%20kotlin.Boolean)`
- `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP_CONTENT:kotlin.Int`

### isSourceEnabled

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

```
fun isSourceEnabled(projectionSource: Int): Boolean
```

Returns true if the provided source should be enabled.

| Parameters ||
|---|---|
| `projectionSource` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): projection source integer to check for. The parameter can also be a bitmask of multiple sources. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_DISPLAY:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/media/projection/MediaProjectionConfig#PROJECTION_SOURCE_APP_CONTENT:kotlin.Int` |

### toString

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

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

Returns a string representation of the object.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | a string representation of the object. |

### writeToParcel

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

```
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit
```

Flatten this object in to a Parcel.

| Parameters ||
|---|---|
| `dest` | [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#): This value cannot be `null`. |
| `flags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int` |

## Properties

### CREATOR

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

```
static val CREATOR: Parcelable.Creator<MediaProjectionConfig!>
```