1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
|
/*
* Copyright (C) 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.hardware.display;
import static android.view.Display.DEFAULT_DISPLAY;
import android.annotation.IntRange;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.hardware.display.DisplayManager.VirtualDisplayFlag;
import android.media.projection.MediaProjection;
import android.os.Handler;
import android.os.Parcel;
import android.os.Parcelable;
import android.view.Surface;
import com.android.internal.util.DataClass;
/**
* Holds configuration used to create {@link VirtualDisplay} instances. See
* {@link MediaProjection#createVirtualDisplay(VirtualDisplayConfig, VirtualDisplay.Callback, Handler)}.
*
* @hide
*/
@DataClass(genParcelable = true, genAidl = true, genBuilder = true)
public final class VirtualDisplayConfig implements Parcelable {
/**
* The name of the virtual display, must be non-empty.
*/
@NonNull
private String mName;
/**
* The width of the virtual display in pixels. Must be greater than 0.
*/
@IntRange(from = 1)
private int mWidth;
/**
* The height of the virtual display in pixels. Must be greater than 0.
*/
@IntRange(from = 1)
private int mHeight;
/**
* The density of the virtual display in dpi. Must be greater than 0.
*/
@IntRange(from = 1)
private int mDensityDpi;
/**
* A combination of virtual display flags.
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_PUBLIC},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_PRESENTATION},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_SECURE},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY},
* or {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR}.
*/
@VirtualDisplayFlag
private int mFlags = 0;
/**
* The surface to which the content of the virtual display should be rendered, or null if
* there is none initially.
*/
@Nullable
private Surface mSurface = null;
/**
* The unique identifier for the display. Shouldn't be displayed to the user.
* @hide
*/
@Nullable
private String mUniqueId = null;
/**
* The id of the display that the virtual display should mirror, or
* {@link android.view.Display#DEFAULT_DISPLAY} if there is none initially.
*/
private int mDisplayIdToMirror = DEFAULT_DISPLAY;
/**
* Indicates if WindowManager is responsible for mirroring content to this VirtualDisplay, or
* if DisplayManager should record contents instead.
*/
private boolean mWindowManagerMirroring = false;
// Code below generated by codegen v1.0.23.
//
// DO NOT MODIFY!
// CHECKSTYLE:OFF Generated code
//
// To regenerate run:
// $ codegen $ANDROID_BUILD_TOP/frameworks/base/core/java/android/hardware/display/VirtualDisplayConfig.java
//
// To exclude the generated code from IntelliJ auto-formatting enable (one-time):
// Settings > Editor > Code Style > Formatter Control
//@formatter:off
@DataClass.Generated.Member
/* package-private */ VirtualDisplayConfig(
@NonNull String name,
@IntRange(from = 1) int width,
@IntRange(from = 1) int height,
@IntRange(from = 1) int densityDpi,
@VirtualDisplayFlag int flags,
@Nullable Surface surface,
@Nullable String uniqueId,
int displayIdToMirror,
boolean windowManagerMirroring) {
this.mName = name;
com.android.internal.util.AnnotationValidations.validate(
NonNull.class, null, mName);
this.mWidth = width;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mWidth,
"from", 1);
this.mHeight = height;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mHeight,
"from", 1);
this.mDensityDpi = densityDpi;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mDensityDpi,
"from", 1);
this.mFlags = flags;
com.android.internal.util.AnnotationValidations.validate(
VirtualDisplayFlag.class, null, mFlags);
this.mSurface = surface;
this.mUniqueId = uniqueId;
this.mDisplayIdToMirror = displayIdToMirror;
this.mWindowManagerMirroring = windowManagerMirroring;
// onConstructed(); // You can define this method to get a callback
}
/**
* The name of the virtual display, must be non-empty.
*/
@DataClass.Generated.Member
public @NonNull String getName() {
return mName;
}
/**
* The width of the virtual display in pixels. Must be greater than 0.
*/
@DataClass.Generated.Member
public @IntRange(from = 1) int getWidth() {
return mWidth;
}
/**
* The height of the virtual display in pixels. Must be greater than 0.
*/
@DataClass.Generated.Member
public @IntRange(from = 1) int getHeight() {
return mHeight;
}
/**
* The density of the virtual display in dpi. Must be greater than 0.
*/
@DataClass.Generated.Member
public @IntRange(from = 1) int getDensityDpi() {
return mDensityDpi;
}
/**
* A combination of virtual display flags.
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_PUBLIC},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_PRESENTATION},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_SECURE},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY},
* or {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR}.
*/
@DataClass.Generated.Member
public @VirtualDisplayFlag int getFlags() {
return mFlags;
}
/**
* The surface to which the content of the virtual display should be rendered, or null if
* there is none initially.
*/
@DataClass.Generated.Member
public @Nullable Surface getSurface() {
return mSurface;
}
/**
* The unique identifier for the display. Shouldn't be displayed to the user.
*
* @hide
*/
@DataClass.Generated.Member
public @Nullable String getUniqueId() {
return mUniqueId;
}
/**
* The id of the display that the virtual display should mirror, or
* {@link android.view.Display#DEFAULT_DISPLAY} if there is none initially.
*/
@DataClass.Generated.Member
public int getDisplayIdToMirror() {
return mDisplayIdToMirror;
}
/**
* Indicates if WindowManager is responsible for mirroring content to this VirtualDisplay, or
* if DisplayManager should record contents instead.
*/
@DataClass.Generated.Member
public boolean isWindowManagerMirroring() {
return mWindowManagerMirroring;
}
@Override
@DataClass.Generated.Member
public void writeToParcel(@NonNull Parcel dest, int flags) {
// You can override field parcelling by defining methods like:
// void parcelFieldName(Parcel dest, int flags) { ... }
int flg = 0;
if (mWindowManagerMirroring) flg |= 0x100;
if (mSurface != null) flg |= 0x20;
if (mUniqueId != null) flg |= 0x40;
dest.writeInt(flg);
dest.writeString(mName);
dest.writeInt(mWidth);
dest.writeInt(mHeight);
dest.writeInt(mDensityDpi);
dest.writeInt(mFlags);
if (mSurface != null) dest.writeTypedObject(mSurface, flags);
if (mUniqueId != null) dest.writeString(mUniqueId);
dest.writeInt(mDisplayIdToMirror);
}
@Override
@DataClass.Generated.Member
public int describeContents() { return 0; }
/** @hide */
@SuppressWarnings({"unchecked", "RedundantCast"})
@DataClass.Generated.Member
/* package-private */ VirtualDisplayConfig(@NonNull Parcel in) {
// You can override field unparcelling by defining methods like:
// static FieldType unparcelFieldName(Parcel in) { ... }
int flg = in.readInt();
boolean windowManagerMirroring = (flg & 0x100) != 0;
String name = in.readString();
int width = in.readInt();
int height = in.readInt();
int densityDpi = in.readInt();
int flags = in.readInt();
Surface surface = (flg & 0x20) == 0 ? null : (Surface) in.readTypedObject(Surface.CREATOR);
String uniqueId = (flg & 0x40) == 0 ? null : in.readString();
int displayIdToMirror = in.readInt();
this.mName = name;
com.android.internal.util.AnnotationValidations.validate(
NonNull.class, null, mName);
this.mWidth = width;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mWidth,
"from", 1);
this.mHeight = height;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mHeight,
"from", 1);
this.mDensityDpi = densityDpi;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mDensityDpi,
"from", 1);
this.mFlags = flags;
com.android.internal.util.AnnotationValidations.validate(
VirtualDisplayFlag.class, null, mFlags);
this.mSurface = surface;
this.mUniqueId = uniqueId;
this.mDisplayIdToMirror = displayIdToMirror;
this.mWindowManagerMirroring = windowManagerMirroring;
// onConstructed(); // You can define this method to get a callback
}
@DataClass.Generated.Member
public static final @NonNull Parcelable.Creator<VirtualDisplayConfig> CREATOR
= new Parcelable.Creator<VirtualDisplayConfig>() {
@Override
public VirtualDisplayConfig[] newArray(int size) {
return new VirtualDisplayConfig[size];
}
@Override
public VirtualDisplayConfig createFromParcel(@NonNull Parcel in) {
return new VirtualDisplayConfig(in);
}
};
/**
* A builder for {@link VirtualDisplayConfig}
*/
@SuppressWarnings("WeakerAccess")
@DataClass.Generated.Member
public static final class Builder {
private @NonNull String mName;
private @IntRange(from = 1) int mWidth;
private @IntRange(from = 1) int mHeight;
private @IntRange(from = 1) int mDensityDpi;
private @VirtualDisplayFlag int mFlags;
private @Nullable Surface mSurface;
private @Nullable String mUniqueId;
private int mDisplayIdToMirror;
private boolean mWindowManagerMirroring;
private long mBuilderFieldsSet = 0L;
/**
* Creates a new Builder.
*
* @param name
* The name of the virtual display, must be non-empty.
* @param width
* The width of the virtual display in pixels. Must be greater than 0.
* @param height
* The height of the virtual display in pixels. Must be greater than 0.
* @param densityDpi
* The density of the virtual display in dpi. Must be greater than 0.
*/
public Builder(
@NonNull String name,
@IntRange(from = 1) int width,
@IntRange(from = 1) int height,
@IntRange(from = 1) int densityDpi) {
mName = name;
com.android.internal.util.AnnotationValidations.validate(
NonNull.class, null, mName);
mWidth = width;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mWidth,
"from", 1);
mHeight = height;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mHeight,
"from", 1);
mDensityDpi = densityDpi;
com.android.internal.util.AnnotationValidations.validate(
IntRange.class, null, mDensityDpi,
"from", 1);
}
/**
* The name of the virtual display, must be non-empty.
*/
@DataClass.Generated.Member
public @NonNull Builder setName(@NonNull String value) {
checkNotUsed();
mBuilderFieldsSet |= 0x1;
mName = value;
return this;
}
/**
* The width of the virtual display in pixels. Must be greater than 0.
*/
@DataClass.Generated.Member
public @NonNull Builder setWidth(@IntRange(from = 1) int value) {
checkNotUsed();
mBuilderFieldsSet |= 0x2;
mWidth = value;
return this;
}
/**
* The height of the virtual display in pixels. Must be greater than 0.
*/
@DataClass.Generated.Member
public @NonNull Builder setHeight(@IntRange(from = 1) int value) {
checkNotUsed();
mBuilderFieldsSet |= 0x4;
mHeight = value;
return this;
}
/**
* The density of the virtual display in dpi. Must be greater than 0.
*/
@DataClass.Generated.Member
public @NonNull Builder setDensityDpi(@IntRange(from = 1) int value) {
checkNotUsed();
mBuilderFieldsSet |= 0x8;
mDensityDpi = value;
return this;
}
/**
* A combination of virtual display flags.
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_PUBLIC},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_PRESENTATION},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_SECURE},
* {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY},
* or {@link DisplayManager#VIRTUAL_DISPLAY_FLAG_AUTO_MIRROR}.
*/
@DataClass.Generated.Member
public @NonNull Builder setFlags(@VirtualDisplayFlag int value) {
checkNotUsed();
mBuilderFieldsSet |= 0x10;
mFlags = value;
return this;
}
/**
* The surface to which the content of the virtual display should be rendered, or null if
* there is none initially.
*/
@DataClass.Generated.Member
public @NonNull Builder setSurface(@NonNull Surface value) {
checkNotUsed();
mBuilderFieldsSet |= 0x20;
mSurface = value;
return this;
}
/**
* The unique identifier for the display. Shouldn't be displayed to the user.
*
* @hide
*/
@DataClass.Generated.Member
public @NonNull Builder setUniqueId(@NonNull String value) {
checkNotUsed();
mBuilderFieldsSet |= 0x40;
mUniqueId = value;
return this;
}
/**
* The id of the display that the virtual display should mirror, or
* {@link android.view.Display#DEFAULT_DISPLAY} if there is none initially.
*/
@DataClass.Generated.Member
public @NonNull Builder setDisplayIdToMirror(int value) {
checkNotUsed();
mBuilderFieldsSet |= 0x80;
mDisplayIdToMirror = value;
return this;
}
/**
* Indicates if WindowManager is responsible for mirroring content to this VirtualDisplay, or
* if DisplayManager should record contents instead.
*/
@DataClass.Generated.Member
public @NonNull Builder setWindowManagerMirroring(boolean value) {
checkNotUsed();
mBuilderFieldsSet |= 0x100;
mWindowManagerMirroring = value;
return this;
}
/** Builds the instance. This builder should not be touched after calling this! */
public @NonNull VirtualDisplayConfig build() {
checkNotUsed();
mBuilderFieldsSet |= 0x200; // Mark builder used
if ((mBuilderFieldsSet & 0x10) == 0) {
mFlags = 0;
}
if ((mBuilderFieldsSet & 0x20) == 0) {
mSurface = null;
}
if ((mBuilderFieldsSet & 0x40) == 0) {
mUniqueId = null;
}
if ((mBuilderFieldsSet & 0x80) == 0) {
mDisplayIdToMirror = DEFAULT_DISPLAY;
}
if ((mBuilderFieldsSet & 0x100) == 0) {
mWindowManagerMirroring = false;
}
VirtualDisplayConfig o = new VirtualDisplayConfig(
mName,
mWidth,
mHeight,
mDensityDpi,
mFlags,
mSurface,
mUniqueId,
mDisplayIdToMirror,
mWindowManagerMirroring);
return o;
}
private void checkNotUsed() {
if ((mBuilderFieldsSet & 0x200) != 0) {
throw new IllegalStateException(
"This Builder should not be reused. Use a new Builder instance instead");
}
}
}
@DataClass.Generated(
time = 1646227247934L,
codegenVersion = "1.0.23",
sourceFile = "frameworks/base/core/java/android/hardware/display/VirtualDisplayConfig.java",
inputSignatures = "private @android.annotation.NonNull java.lang.String mName\nprivate @android.annotation.IntRange int mWidth\nprivate @android.annotation.IntRange int mHeight\nprivate @android.annotation.IntRange int mDensityDpi\nprivate @android.hardware.display.DisplayManager.VirtualDisplayFlag int mFlags\nprivate @android.annotation.Nullable android.view.Surface mSurface\nprivate @android.annotation.Nullable java.lang.String mUniqueId\nprivate int mDisplayIdToMirror\nprivate boolean mWindowManagerMirroring\nclass VirtualDisplayConfig extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genParcelable=true, genAidl=true, genBuilder=true)")
@Deprecated
private void __metadata() {}
//@formatter:on
// End of generated code
}
|