ใช้ไลบรารีการแสดงภาพซ้อนภาพของ Jetpack

ไลบรารี Jetpack สำหรับการแสดงภาพซ้อนภาพ (PiP) มีโซลูชันที่มีประสิทธิภาพและคล่องตัวสำหรับนักพัฒนาแอป Android ในการใช้ฟังก์ชัน PiP โดยเฉพาะสำหรับการเล่นสื่อ การสื่อสารผ่านวิดีโอ และแอปการนำทาง ไลบรารีนี้ช่วยลดโค้ด Boilerplate, ข้อบกพร่องที่พบบ่อยในแอป และปรับปรุงคุณภาพโดยรวมของประสบการณ์การใช้งาน PiP ของผู้ใช้ด้วยการจัดเตรียม API แบบรวม

ไลบรารี Jetpack ของ PiP ช่วยอำนวยความสะดวกให้กับ API ของ PiP ที่มีอยู่โดยจัดการกับความท้าทายและความไม่สอดคล้องกันที่สำคัญหลายประการในระบบนิเวศของ Android ดังนี้

  • การกระจาย Fragment ของระบบปฏิบัติการ: ไลบรารีจะจัดการความแตกต่างในการเรียกใช้ PiP API ใน Android เวอร์ชันต่างๆ โดยอัตโนมัติ เช่น การใช้ enterPictureInPictureMode ก่อน Android 12 และ isAutoEnterEnabled หลังจากนั้น เพื่อให้นักพัฒนาแอปไม่ต้องจัดการความแตกต่างของเวอร์ชัน
  • พารามิเตอร์ PiP ไม่ถูกต้อง: มีโซลูชันแบบรวมสำหรับการตั้งค่าพารามิเตอร์ PiP อย่างถูกต้อง เช่น setSourceRectHint เพื่อสร้างภาพเคลื่อนไหวที่ราบรื่นและมีคุณภาพสูงระหว่างการเล่นสื่อ
  • Callback สถานะ PiP แบบรวม: รวม onPictureInPictureModeChanged และ onPictureInPictureUiStateChanged ไว้ในอินเทอร์เฟซ Callback แบบรวมรายการเดียว (PictureInPictureDelegate.OnPictureInPictureEventListener) เพื่อให้จัดการสถานะและ UI ได้ง่ายขึ้น
  • การลดโค้ด Boilerplate: ไลบรารีนี้ช่วยลดปริมาณโค้ด Boilerplate ที่ซ้ำกันโดยเสนอชุด RemoteActions ที่กำหนดไว้ล่วงหน้าสำหรับ Use Case ทั่วไป เช่น ตัวควบคุมการเล่นและการดำเนินการวิดีโอคอล
  • การรองรับอนาคต: ฟีเจอร์ PiP เพิ่มเติมจะแสดงผ่านไลบรารี Jetpack ซึ่งช่วยให้ผู้ใช้เข้าถึงฟังก์ชันการทำงานเพิ่มเติมได้โดยใช้ความพยายามเพียงเล็กน้อยหรือไม่ต้องใช้ความพยายามเลย

เวิร์กโฟลว์การย้ายข้อมูล

ระบุหมวดหมู่กรณีการใช้งานของแอปและตรรกะ PiP เดิม โดยทำดังนี้

หมวดหมู่: การเล่นวิดีโอ การนำทาง หรือวิดีโอคอล

ตรรกะ PiP เดิมที่ใช้ระบุ:

  • onUserLeaveHint
  • setAutoEnterEnabled
  • onPictureInPictureModeChanged
  • onPictureInPictureUiStateChanged
  • setPictureInPictureParams

2. การกำหนดค่า AndroidManifest

ตรวจสอบว่ากิจกรรมที่เข้าสู่โหมด PiP ประกาศการรองรับใน AndroidManifest.xml ด้วย configChanges ที่จำเป็นเพื่อป้องกันการรีสตาร์ทที่ไม่จำเป็น ดังนี้

<activity
android:name="VideoActivity" android:supportsPictureInPicture="true"
android:configChanges="screenSize|smallestScreenSize|screenLayout|orientation">
</activity>

3. การตั้งค่าสภาพแวดล้อม

เพิ่มทรัพยากร Dependency ที่จำเป็นลงใน build.gradle:

dependencies {
implementation("androidx.core:core:1.18.0")
implementation("androidx.activity:activity:1.13.0")
implementation("androidx.core:core-pip:1.0.0-alpha02") }

ใช้ไลบรารี AndroidX เวอร์ชันล่าสุดสำหรับทรัพยากร Dependency และดูข้อมูลดังกล่าวในหน้ารุ่น

4. การเลือกและการเริ่มต้นเทมเพลต

เลือกเทมเพลตการติดตั้งใช้งานที่เหมาะกับ Use Case ของแอปมากที่สุด ดังนี้

  • การนำทางและวิดีโอคอล: BasicPictureInPicture โดยปกติแล้วจะไม่รองรับการปรับขนาดที่ราบรื่น และคุณไม่จำเป็นต้องใช้คำแนะนำสี่เหลี่ยมผืนผ้าต้นทาง
  • การเล่นวิดีโอ: VideoPlaybackPictureInPicture จะติดตามขอบเขตมุมมองโปรแกรมเล่นโดยอัตโนมัติสำหรับคำแนะนำสี่เหลี่ยมผืนผ้าต้นทาง และเปิดใช้การปรับขนาดที่ราบรื่นโดยค่าเริ่มต้น

หากต้องการใช้ไลบรารี Jetpack ให้แทนที่การติดตั้งใช้งาน PiP ที่กำหนดเองที่มีอยู่ด้วย API ของไลบรารี Jetpack ความซับซ้อนและค่าใช้จ่ายในการนำไปใช้จะแตกต่างกันไปตามการใช้งานปัจจุบันของแอป

ส่วนต่อไปนี้จะอธิบายกรณีการใช้งานทั่วไปของ PIP และขั้นตอนการติดตั้งใช้งานที่จำเป็น

แอปจะแจ้งให้ไลบรารีทราบถึงสถานะการนำทางที่ใช้งานอยู่หรือไม่ได้ใช้งาน และตั้งค่าสัดส่วนภาพ ไลบรารี Jetpack จะจัดการส่วนที่เหลือให้

ความแตกต่างที่สำคัญ

  1. ไม่จำเป็นต้องแยกความแตกต่างระหว่างการเข้าสู่ระบบอัตโนมัติและการเข้าสู่ระบบแบบเดิมในฝั่งแอป
  2. อินเทอร์เฟซ Callback แบบรวม
  3. PictureInPictureParams Builder ใหม่เพื่อความเข้ากันได้แบบย้อนหลัง

วิดีโอคอล

แอปจะแจ้งสถานะการโทรที่ใช้งานอยู่หรือไม่ได้ใช้งานให้ไลบรารีทราบและตั้งค่าสัดส่วนภาพ

ความแตกต่างที่สำคัญ

  1. ไม่จำเป็นต้องแยกความแตกต่างระหว่างการเข้าสู่ระบบอัตโนมัติและการเข้าสู่ระบบแบบเดิมในฝั่งแอป
  2. อินเทอร์เฟซ Callback แบบรวม
  3. PictureInPictureParams Builder ใหม่เพื่อความเข้ากันได้แบบย้อนหลัง
  4. ไอคอนการดำเนินการมาตรฐานสำหรับวิดีโอคอล

5. การย้ายข้อมูลโค้ด

  • ตรรกะรายการ: แทนที่ตรรกะเฉพาะ API เช่น setAutoEnterEnabled สำหรับ Android 12 ขึ้นไป หรือ onUserLeaveHint สำหรับ Android 11 ลงไปด้วย setEnabled เรียกใช้เหตุการณ์นี้เมื่อสถานะการมีสิทธิ์ใช้ PiP เปลี่ยนแปลง
  • Callback: รวม onPictureInPictureModeChanged (การสลับเลย์เอาต์) และ onPictureInPictureUiStateChanged (ภาพเคลื่อนไหว/สถานะ) ไว้ใน Callback แบบอิงตามเหตุการณ์แบบรวม onPictureInPictureEvent
  • การดำเนินการและพารามิเตอร์: อัปเดตพารามิเตอร์โดยใช้ setActions และ setAspectRatio ในอินสแตนซ์เทมเพลตเมื่อมีการเปลี่ยนแปลง

รูปแบบการติดตั้งใช้งานอ้างอิง

ตัวอย่างการใช้งาน

การนำทางและวิดีโอคอล

class NavOrVideoCallJpipActivity : ComponentActivity(), PictureInPictureDelegate.OnPictureInPictureEventListener {
    private lateinit var pictureInPictureImpl: BasicPictureInPicture
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        pictureInPictureImpl = BasicPictureInPicture(this)
        // BasicPictureInPicture is ideal for Navigation and Video call use cases.
        pictureInPictureImpl.addOnPictureInPictureEventListener(
            ContextCompat.getMainExecutor(this),
            this
        )
        setContent {
        }
    }
    override fun onPictureInPictureEvent(
        event: PictureInPictureDelegate.Event,
        config: Configuration?
    ) {
        when (event) {
            PictureInPictureDelegate.Event.ENTERED -> { /* Toggle to PiP layout */ }
            PictureInPictureDelegate.Event.EXITED -> { /* Toggle to Full-screen layout */ }
            PictureInPictureDelegate.Event.STASHED -> { /* Optional: PiP is stashed */ }
            PictureInPictureDelegate.Event.UNSTASHED -> { /* Optional: PiP is unstashed */ }
        }
    }
}

การเล่นวิดีโอ

class VideoPlaybackJpipActivity : ComponentActivity(), PictureInPictureDelegate.OnPictureInPictureEventListener {
    private lateinit var pictureInPictureImpl: VideoPlaybackPictureInPicture
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        pictureInPictureImpl = VideoPlaybackPictureInPicture(this)
        pictureInPictureImpl.addOnPictureInPictureEventListener(
            ContextCompat.getMainExecutor(this),
            this
        )
        setContent {
            ContentScreen(pictureInPictureImpl)
        }
    }
    override fun onPictureInPictureEvent(
        event: PictureInPictureDelegate.Event,
        config: Configuration?
    ) {
        when (event) {
            PictureInPictureDelegate.Event.ENTER_ANIMATION_START -> { /* Hide overlays */ }
            PictureInPictureDelegate.Event.ENTER_ANIMATION_END -> { /* Animation finished */ }
            PictureInPictureDelegate.Event.ENTERED -> { /* Switch to PiP layout */ }
            PictureInPictureDelegate.Event.STASHED -> { /* PiP stashed */ }
            PictureInPictureDelegate.Event.UNSTASHED -> { /* PiP unstashed */ }
            PictureInPictureDelegate.Event.EXITED -> { /* Return to full-screen */ }
        }
    }

    @Composable
    fun ContentScreen(pipController: VideoPlaybackPictureInPicture) {
        DisposableEffect(pipController) {
            onDispose {
                pipController.close()
            }
        }
    }
}