PlaceholderSurface

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
class PlaceholderSurface : Surface

kotlin.Any
↳	android.view.Surface
	↳	androidx.media3.exoplayer.video.PlaceholderSurface

A placeholder Surface.

Summary

Public functions
`synchronized java-static Boolean`	`isSecureSupported(context: Context!)` Returns whether the device supports secure placeholder surfaces.
`java-static PlaceholderSurface!`	`newInstance(context: Context!, secure: Boolean)` Returns a newly created placeholder surface.
`java-static PlaceholderSurface!`	`@InlineMe(replacement = "PlaceholderSurface.newInstance(context, secure)", imports = "androidx.media3.exoplayer.video.PlaceholderSurface") newInstanceV17(context: Context!, secure: Boolean)` This function is deprecated. Use `newInstance` instead.
`Unit`	`release()`

Public properties
`Boolean`	`secure` Whether the surface is secure.

Inherited Constants

From android.os.Parcelable

`const Int`	`CONTENTS_FILE_DESCRIPTOR = 1`
`const Int`	`PARCELABLE_WRITE_RETURN_VALUE = 1`

From android.view.Surface

`const Int`	`CHANGE_FRAME_RATE_ALWAYS = 1`
`const Int`	`CHANGE_FRAME_RATE_ONLY_IF_SEAMLESS = 0`
`const Parcelable.Creator<Surface!>!`	`CREATOR`
`const Int`	`FRAME_RATE_COMPATIBILITY_AT_LEAST = 2`
`const Int`	`FRAME_RATE_COMPATIBILITY_DEFAULT = 0`
`const Int`	`FRAME_RATE_COMPATIBILITY_FIXED_SOURCE = 1`
`const Int`	`ROTATION_0 = 0`
`const Int`	`ROTATION_180 = 2`
`const Int`	`ROTATION_270 = 3`
`const Int`	`ROTATION_90 = 1`

Inherited functions

From android.view.Surface

`Unit`	`clearFrameRate()`
`Int`	`describeContents()`
`Unit`	`finalize()` This function is deprecated.
`Boolean`	`isProducerThrottlingEnabled()`
`Boolean`	`isValid()`
`Canvas!`	`lockCanvas(inOutDirty: Rect!)`
`Canvas!`	`lockHardwareCanvas()`
`Unit`	`readFromParcel(source: Parcel!)`
`Unit`	`setFrameRate(frameRate: Float, compatibility: Int)`
`Unit`	`setProducerThrottlingEnabled(enabled: Boolean)`
`String!`	`toString()`
`Unit`	`unlockCanvas(canvas: Canvas!)` This function is deprecated.
`Unit`	`unlockCanvasAndPost(canvas: Canvas!)`
`Unit`	`writeToParcel(dest: Parcel!, flags: Int)`

Public functions

isSecureSupported

synchronized java-static fun isSecureSupported(context: Context!): Boolean

Returns whether the device supports secure placeholder surfaces.

Parameters
`context: Context!`	Any `Context`.

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

newInstance

java-static fun newInstance(context: Context!, secure: Boolean): PlaceholderSurface!

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`.
`secure: Boolean`	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")
java-static fun newInstanceV17(context: Context!, secure: Boolean): PlaceholderSurface!

release

fun release(): Unit

Public properties

secure

val secure: Boolean

Whether the surface is secure.