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
|
/*
* Copyright (C) 2022 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.service.games;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.os.Parcel;
import android.os.Parcelable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Objects;
/**
* Result object for calls to {@link IGameSessionController#takeScreenshot}.
*
* It includes a status only (see {@link #getStatus}).
*
* @hide
*/
public final class GameScreenshotResult implements Parcelable {
/**
* The status of a call to {@link IGameSessionController#takeScreenshot} will be represented by
* one of these values.
*
* @hide
*/
@IntDef(flag = false, prefix = {"GAME_SCREENSHOT_"}, value = {
GAME_SCREENSHOT_SUCCESS, // 0
GAME_SCREENSHOT_ERROR_INTERNAL_ERROR, // 1
})
@Retention(RetentionPolicy.SOURCE)
public @interface GameScreenshotStatus {
}
/**
* Indicates that the result of a call to {@link IGameSessionController#takeScreenshot} was
* successful.
*
* @hide
*/
public static final int GAME_SCREENSHOT_SUCCESS = 0;
/**
* Indicates that the result of a call to {@link IGameSessionController#takeScreenshot} failed
* due to an internal error.
*
* This error may occur if the device is not in a suitable state for a screenshot to be taken
* (e.g., the screen is off) or if the game task is not in a suitable state for a screenshot
* to be taken (e.g., the task is not visible). To make sure that the device and game are
* in a suitable state, the caller can monitor the lifecycle methods for the {@link
* GameSession} to make sure that the game task is focused. If the conditions are met, then the
* caller may try again immediately.
*
* @hide
*/
public static final int GAME_SCREENSHOT_ERROR_INTERNAL_ERROR = 1;
@NonNull
public static final Parcelable.Creator<GameScreenshotResult> CREATOR =
new Parcelable.Creator<GameScreenshotResult>() {
@Override
public GameScreenshotResult createFromParcel(Parcel source) {
return new GameScreenshotResult(source.readInt());
}
@Override
public GameScreenshotResult[] newArray(int size) {
return new GameScreenshotResult[0];
}
};
@GameScreenshotStatus
private final int mStatus;
/**
* Creates a successful {@link GameScreenshotResult}.
*/
public static GameScreenshotResult createSuccessResult() {
return new GameScreenshotResult(GAME_SCREENSHOT_SUCCESS);
}
/**
* Creates a failed {@link GameScreenshotResult} with an
* {@link #GAME_SCREENSHOT_ERROR_INTERNAL_ERROR} status.
*/
public static GameScreenshotResult createInternalErrorResult() {
return new GameScreenshotResult(GAME_SCREENSHOT_ERROR_INTERNAL_ERROR);
}
private GameScreenshotResult(@GameScreenshotStatus int status) {
this.mStatus = status;
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(@NonNull Parcel dest, int flags) {
dest.writeInt(mStatus);
}
@GameScreenshotStatus
public int getStatus() {
return mStatus;
}
@Override
public String toString() {
return "GameScreenshotResult{"
+ "mStatus="
+ mStatus
+ "}";
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof GameScreenshotResult)) {
return false;
}
GameScreenshotResult that = (GameScreenshotResult) o;
return mStatus == that.mStatus;
}
@Override
public int hashCode() {
return Objects.hash(mStatus);
}
}
|
