blob: 647d502c3cc1d4a767e76f7e298e60426d562f96 [file] [log] [blame]
/*
* Copyright 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 androidx.wear.watchface.client
import androidx.annotation.RestrictTo
typealias WireDeviceConfig = androidx.wear.watchface.data.DeviceConfig
/**
* Describes the hardware configuration of the device the watch face is running on.
*
* @param hasLowBitAmbient Whether or not the watch hardware supports low bit ambient support.
* @param hasBurnInProtection Whether or not the watch hardware supports burn in protection.
* @param analogPreviewReferenceTimeMillis UTC reference time for screenshots of analog watch faces
* in milliseconds since the epoch.
* @param digitalPreviewReferenceTimeMillis UTC reference time for screenshots of digital watch
* faces in milliseconds since the epoch.
*/
public class DeviceConfig(
@get:JvmName("hasLowBitAmbient")
public val hasLowBitAmbient: Boolean,
@get:JvmName("hasBurnInProtection")
public val hasBurnInProtection: Boolean,
public val analogPreviewReferenceTimeMillis: Long,
public val digitalPreviewReferenceTimeMillis: Long
) {
/** @hide */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public fun asWireDeviceConfig(): WireDeviceConfig = WireDeviceConfig(
hasLowBitAmbient,
hasBurnInProtection,
analogPreviewReferenceTimeMillis,
digitalPreviewReferenceTimeMillis
)
}
/** @hide */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public fun WireDeviceConfig.asApiDeviceConfig(): DeviceConfig = DeviceConfig(
hasLowBitAmbient,
hasBurnInProtection,
analogPreviewReferenceTimeMillis,
digitalPreviewReferenceTimeMillis
)