PlaceholderSurface

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public final class PlaceholderSurface extends Surface

java.lang.Object
↳	android.view.Surface
	↳	androidx.media3.exoplayer.video.PlaceholderSurface

A placeholder Surface.

Summary

Public fields
`final boolean`	`secure` Whether the surface is secure.

Public methods
`synchronized static boolean`	`isSecureSupported(Context context)` Returns whether the device supports secure placeholder surfaces.
`static PlaceholderSurface`	`newInstance(Context context, boolean secure)` Returns a newly created placeholder surface.
`static PlaceholderSurface`	`@InlineMe(replacement = "PlaceholderSurface.newInstance(context, secure)", imports = "androidx.media3.exoplayer.video.PlaceholderSurface") newInstanceV17(Context context, boolean secure)` This method is deprecated. Use `newInstance` instead.
`void`	`release()`

Inherited Constants

From android.os.Parcelable

`static final int`	`CONTENTS_FILE_DESCRIPTOR = 1`
`static final int`	`PARCELABLE_WRITE_RETURN_VALUE = 1`

From android.view.Surface

`static final int`	`CHANGE_FRAME_RATE_ALWAYS = 1`
`static final int`	`CHANGE_FRAME_RATE_ONLY_IF_SEAMLESS = 0`
`static final Parcelable.Creator<Surface>`	`CREATOR`
`static final int`	`FRAME_RATE_COMPATIBILITY_AT_LEAST = 2`
`static final int`	`FRAME_RATE_COMPATIBILITY_DEFAULT = 0`
`static final int`	`FRAME_RATE_COMPATIBILITY_FIXED_SOURCE = 1`
`static final int`	`ROTATION_0 = 0`
`static final int`	`ROTATION_180 = 2`
`static final int`	`ROTATION_270 = 3`
`static final int`	`ROTATION_90 = 1`

Inherited methods

From android.view.Surface

`void`	`clearFrameRate()`
`int`	`describeContents()`
`void`	`finalize()`
`boolean`	`isProducerThrottlingEnabled()`
`boolean`	`isValid()`
`Canvas`	`lockCanvas(Rect inOutDirty)`
`Canvas`	`lockHardwareCanvas()`
`void`	`readFromParcel(Parcel source)`
`void`	`setFrameRate(float frameRate, int compatibility)`
`void`	`setProducerThrottlingEnabled(boolean enabled)`
`String`	`toString()`
`void`	`unlockCanvas(Canvas canvas)` This method is deprecated.
`void`	`unlockCanvasAndPost(Canvas canvas)`
`void`	`writeToParcel(Parcel dest, int flags)`

Public fields

secure

public final boolean secure

Whether the surface is secure.

Public methods

isSecureSupported

synchronized public static boolean isSecureSupported(Context context)

Returns whether the device supports secure placeholder surfaces.

Parameters
`Context context`	Any `Context`.

Returns
`boolean`	Whether the device supports secure placeholder surfaces.

newInstance

public static PlaceholderSurface newInstance(Context context, boolean secure)

Returns a newly created placeholder surface. The surface must be released by calling release when it's no longer required.

Parameters
`Context context`	Any `Context`.
`boolean secure`	Whether a secure surface is required. Must only be requested if `isSecureSupported` returns `true`.

Throws
`java.lang.IllegalStateException`	If a secure surface is requested on a device for which `isSecureSupported` returns `false`.

newInstanceV17

@InlineMe(replacement = "PlaceholderSurface.newInstance(context, secure)", imports = "androidx.media3.exoplayer.video.PlaceholderSurface")
public static PlaceholderSurface newInstanceV17(Context context, boolean secure)

release

public void release()