summaryrefslogtreecommitdiffstats
path: root/telecomm/java/android/telecom/CameraCapabilities.java
blob: 6eaf6a2cb54315c90cfdbb7940015b93a163bdfa (plain)
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
/*
 * Copyright (C) 2014 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.telecom;

import android.os.Parcel;
import android.os.Parcelable;

/**
 * Represents the camera capabilities important to a Video Telephony provider.
 * @hide
 */
public final class CameraCapabilities implements Parcelable {

    /**
     * The width of the camera video in pixels.
     */
    private final int mWidth;

    /**
     * The height of the camera video in pixels.
     */
    private final int mHeight;

    /**
     * Whether the camera supports zoom.
     */
    private final boolean mZoomSupported;

    /**
     * The maximum zoom supported by the camera.
     */
    private final float mMaxZoom;

    /**
     * Create a call camera capabilities instance that doesn't support zoom.
     *
     * @param width The width of the camera video (in pixels).
     * @param height The height of the camera video (in pixels).
     */
    public CameraCapabilities(int width, int height) {
        this(width, height, false, 1.0f);
    }

    /**
     * Create a call camera capabilities instance.
     *
     * @param width The width of the camera video (in pixels).
     * @param height The height of the camera video (in pixels).
     * @param zoomSupported True when camera supports zoom.
     * @param maxZoom Maximum zoom supported by camera.
     * @hide
     */
    public CameraCapabilities(int width, int height, boolean zoomSupported, float maxZoom) {
        mWidth = width;
        mHeight = height;
        mZoomSupported = zoomSupported;
        mMaxZoom = maxZoom;
    }

    /**
     * Responsible for creating CallCameraCapabilities objects from deserialized Parcels.
     **/
    public static final Parcelable.Creator<CameraCapabilities> CREATOR =
            new Parcelable.Creator<CameraCapabilities> () {
                /**
                 * Creates a CallCameraCapabilities instances from a parcel.
                 *
                 * @param source The parcel.
                 * @return The CallCameraCapabilities.
                 */
                @Override
                public CameraCapabilities createFromParcel(Parcel source) {
                    int width = source.readInt();
                    int height = source.readInt();
                    boolean supportsZoom = source.readByte() != 0;
                    float maxZoom = source.readFloat();

                    return new CameraCapabilities(width, height, supportsZoom, maxZoom);
                }

                @Override
                public CameraCapabilities[] newArray(int size) {
                    return new CameraCapabilities[size];
                }
            };

    /**
     * Describe the kinds of special objects contained in this Parcelable's
     * marshalled representation.
     *
     * @return a bitmask indicating the set of special object types marshalled
     * by the Parcelable.
     */
    @Override
    public int describeContents() {
        return 0;
    }

    /**
     * Flatten this object in to a Parcel.
     *
     * @param dest  The Parcel in which the object should be written.
     * @param flags Additional flags about how the object should be written.
     *              May be 0 or {@link #PARCELABLE_WRITE_RETURN_VALUE}.
     */
    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeInt(getWidth());
        dest.writeInt(getHeight());
        dest.writeByte((byte) (isZoomSupported() ? 1 : 0));
        dest.writeFloat(getMaxZoom());
    }

    /**
     * The width of the camera video in pixels.
     */
    public int getWidth() {
        return mWidth;
    }

    /**
     * The height of the camera video in pixels.
     */
    public int getHeight() {
        return mHeight;
    }

    /**
     * Whether the camera supports zoom.
     * @hide
     */
    public boolean isZoomSupported() {
        return mZoomSupported;
    }

    /**
     * The maximum zoom supported by the camera.
     * @hide
     */
    public float getMaxZoom() {
        return mMaxZoom;
    }
}