/*
 * Copyright (C) 2025 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 com.android.wallpaper.module

import android.app.WallpaperInfo
import com.android.wallpaper.picker.data.WallpaperModel

/**
 * Factory for creating [WallpaperModel.LiveWallpaperModel] instances from
 * [android.app.WallpaperInfo].
 *
 * This interface provides methods to transform [android.app.WallpaperInfo] into a
 * [WallpaperModel.LiveWallpaperModel] object.
 */
interface ThirdPartyLiveWallpaperModelFactory {

    /**
     * Creates a [WallpaperModel.LiveWallpaperModel] from a [android.app.WallpaperInfo] object.
     *
     * @param info The [android.app.WallpaperInfo] object containing the raw wallpaper data. It can
     *   be `null`.
     * @return A new [WallpaperModel.LiveWallpaperModel], or `null` if the input is `null` or the
     *   conversion fails.
     */
    fun getLiveWallpaperModel(info: WallpaperInfo): WallpaperModel.LiveWallpaperModel?
}