Added in API level 34

MediaProjectionConfig

class MediaProjectionConfig : Parcelable
kotlin.Any
   ↳ android.media.projection.MediaProjectionConfig

Configure the MediaProjection session requested from MediaProjectionManager#createScreenCaptureIntent(MediaProjectionConfig).

Summary

Inherited constants
Public methods
static MediaProjectionConfig

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

Returns an instance which allows the user to decide which region is captured.
Int

Boolean
equals(other: Any?)

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

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<MediaProjectionConfig!>

Public methods

createConfigForDefaultDisplay

Added in API level 34
static fun createConfigForDefaultDisplay(): MediaProjectionConfig

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

Return
MediaProjectionConfig This value cannot be null.

createConfigForUserChoice

Added in API level 34
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 android.view.Display#DEFAULT_DISPLAY is supported.

When passed in to MediaProjectionManager#createScreenCaptureIntent(MediaProjectionConfig), the consent dialog shown to the user will be the same as if just MediaProjectionManager#createScreenCaptureIntent() was invoked.

Return
MediaProjectionConfig This value cannot be null.

describeContents

Added in API level 34
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
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
Boolean true if this object is the same as the obj argument; false otherwise.

hashCode

Added in API level 34
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 34
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<MediaProjectionConfig!>