MediaProjectionConfig

PROJECTION_SOURCE_APP

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

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

static val PROJECTION_SOURCE_DISPLAY: Int

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

Value: 2

createConfigForDefaultDisplay

static fun createConfigForDefaultDisplay(): MediaProjectionConfig

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

createConfigForUserChoice

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.

describeContents

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 writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

equals

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.

getInitiallySelectedSource

fun getInitiallySelectedSource(): Int

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

getProjectionSources

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.

getRequesterHint

fun getRequesterHint(): CharSequence?

A hint set by the requesting app indicating who the requester of this 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).

hashCode

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 java.util.HashMap.

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 equals 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 equals 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.

isAudioRequested

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 (getProjectionSources()) chosen by the user.

isOwnAppContentProvided

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 PROJECTION_SOURCE_APP_CONTENT 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.

isSourceEnabled

fun isSourceEnabled(projectionSource: Int): Boolean

Returns true if the provided source should be enabled.

toString

fun toString(): String

Returns a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<MediaProjectionConfig!>