PictureInPictureModeChangedInfo.kt
/*
* Copyright 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 androidx.core.app
import android.app.Activity
import android.content.res.Configuration
import androidx.annotation.RequiresApi
/**
* Class that encapsulates the information that is delivered when
* [Activity.onPictureInPictureModeChanged] is dispatched to a
* [OnPictureInPictureModeChangedProvider].
*/
class PictureInPictureModeChangedInfo(
/**
* Gets the new picture-in-picture mode.
*
* @return True if the activity is in picture-in-picture mode.
*/
val isInPictureInPictureMode: Boolean
) {
@RequiresApi(26)
private var newConfiguration: Configuration? = null
/**
* Construct an instance that contains the new picture-in-picture mode and the new
* configuration with the new picture-in-picture mode applied.
*
* @param isInPictureInPictureMode True if the activity is in picture-in-picture mode.
* @param newConfig The new configuration of the activity with the state
* {@param isInPictureInPictureMode}.
*/
@RequiresApi(26)
constructor(
isInPictureInPictureMode: Boolean,
newConfig: Configuration
) : this(isInPictureInPictureMode) {
this.newConfiguration = newConfig
}
@get:RequiresApi(26)
val newConfig: Configuration
/**
* Gets the new [Configuration] of the with activity with the state
* [isInPictureInPictureMode] applied.
*
* Note that this is only valid on devices that are running API 26
* ([android.os.Build.VERSION_CODES.O]) or higher.
*
* @return The new configuration of the activity with the state
* [isInPictureInPictureMode].
* @throws IllegalStateException if the new [Configuration] is not available (i.e.,
* you are running on a device less that [android.os.Build.VERSION_CODES.O] which is
* when this information first became available).
*/
get() {
return checkNotNull(newConfiguration) {
"PictureInPictureModeChangedInfo must be constructed " +
"with the constructor that takes a Configuration to access the newConfig. " +
"Are you running on an API 26 or higher device that makes this " +
"information available?"
}
}
}