Added in API level 34

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

MediaProjectionConfig

---

Kotlin |Java

public final class MediaProjectionConfig
extends Object implements Parcelable

java.lang.Object
↳	android.media.projection.MediaProjectionConfig

---

Configure the MediaProjection session requested from MediaProjectionManager.createScreenCaptureIntent(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
class	MediaProjectionConfig.Builder

Constants
int	PROJECTION_SOURCE_APP Bitmask for setting whether this configuration is for projecting the a single application.
int	PROJECTION_SOURCE_APP_CONTENT Bitmask for setting whether this configuration is for projecting the content provided by an application.
int	PROJECTION_SOURCE_DISPLAY Bitmask for setting whether this configuration is for projecting the whole display.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, 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)".

Fields
public static final Creator<MediaProjectionConfig>	CREATOR

Public methods
static MediaProjectionConfig	createConfigForDefaultDisplay() Returns an instance which restricts the user to capturing the default display.
static MediaProjectionConfig	createConfigForUserChoice() Returns an instance which allows the user to decide which region is captured.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int	getInitiallySelectedSource() Returns a bit mask of one, and only one, of the projection type flag.
int	getProjectionSources() A bitmask representing of requested projection sources.
CharSequence	getRequesterHint() A hint set by the requesting app indicating who the requester of this MediaProjection session is.
int	hashCode() Returns a hash code value for the object.
boolean	isAudioRequested() Returns true if the application requesting the media projection session is requesting to capture audio as well.
boolean	isOwnAppContentProvided() Returns true if the application requesting the media projection session is offering its own content to be picked in the UI picker.
boolean	isSourceEnabled(int projectionSource) Returns true if the provided source should be enabled.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

PROJECTION_SOURCE_APP

Added in API level 37

public static final int PROJECTION_SOURCE_APP

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

Constant Value: 8 (0x00000008)

PROJECTION_SOURCE_APP_CONTENT

Added in API level 37

public static final int PROJECTION_SOURCE_APP_CONTENT

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

Constant Value: 16 (0x00000010)

PROJECTION_SOURCE_DISPLAY

Added in API level 37

public static final int PROJECTION_SOURCE_DISPLAY

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

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 34

public static final Creator<MediaProjectionConfig> CREATOR

Public methods

createConfigForDefaultDisplay

Added in API level 34

public static MediaProjectionConfig createConfigForDefaultDisplay ()

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

Returns
MediaProjectionConfig	This value cannot be null.

createConfigForUserChoice

Added in API level 34

public static MediaProjectionConfig createConfigForUserChoice ()

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

Returns
MediaProjectionConfig	This value cannot be null.

describeContents

Added in API level 34

public int describeContents ()

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.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34

public boolean equals (Object o)

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
o	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getInitiallySelectedSource

Added in API level 37

public int getInitiallySelectedSource ()

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

Returns
int	Value is either 0 or a combination of the following: PROJECTION_SOURCE_DISPLAY PROJECTION_SOURCE_APP PROJECTION_SOURCE_APP_CONTENT

getProjectionSources

Added in API level 37

public int getProjectionSources ()

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.

Returns
int	Value is either 0 or a combination of the following: PROJECTION_SOURCE_DISPLAY PROJECTION_SOURCE_APP PROJECTION_SOURCE_APP_CONTENT

getRequesterHint

Added in API level 37

public CharSequence getRequesterHint ()

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

Returns
CharSequence	the hint to be displayed if set, null otherwise.

hashCode

Added in API level 34

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
int	a hash code value for this object.

isAudioRequested

Added in API level 37

public boolean isAudioRequested ()

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.

Returns
boolean

See also:

• Builder.setAudioRequested(boolean)

isOwnAppContentProvided

Added in API level 37

public boolean isOwnAppContentProvided ()

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.

Returns
boolean

See also:

• Builder.setOwnAppContentProvided(boolean)
• Builder.setSourceEnabled(int,boolean)
• PROJECTION_SOURCE_APP_CONTENT

isSourceEnabled

Added in API level 37

public boolean isSourceEnabled (int projectionSource)

Returns true if the provided source should be enabled.

Parameters
projectionSource	int: 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: PROJECTION_SOURCE_DISPLAY PROJECTION_SOURCE_APP PROJECTION_SOURCE_APP_CONTENT

Returns
boolean

toString

Added in API level 34

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 34

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE