ภาพรวม MediaRouteProvider

เฟรมเวิร์ก Android Media Router ช่วยให้ผู้ผลิตสามารถเปิดใช้การเล่นในอุปกรณ์ของตนผ่านอินเทอร์เฟซมาตรฐานที่เรียกว่า MediaRouteProvider ผู้ให้บริการเส้นทางจะกำหนดอินเทอร์เฟซทั่วไปสำหรับการเล่นสื่อบนอุปกรณ์รับสัญญาณ ซึ่งช่วยให้เล่นสื่อบนอุปกรณ์ของคุณจากแอปพลิเคชัน Android ที่รองรับเส้นทางสื่อได้

คู่มือนี้จะอธิบายวิธีสร้างผู้ให้บริการเส้นทางสื่อสำหรับอุปกรณ์รับสัญญาณและทำให้แอปพลิเคชันการเล่นสื่ออื่นๆ ที่ทำงานบน Android ใช้งานได้ หากต้องการใช้ API นี้ คุณควรคุ้นเคยกับคลาสหลักๆ อย่าง MediaRouteProvider, MediaRouteProviderDescriptor และ RouteController

ภาพรวม

เฟรมเวิร์กเราเตอร์สื่อของ Android ช่วยให้นักพัฒนาแอปสื่อและผู้ผลิตอุปกรณ์เล่นสื่อเชื่อมต่อผ่าน API ทั่วไปและอินเทอร์เฟซผู้ใช้ทั่วไปได้ นักพัฒนาแอปที่ใช้อินเทอร์เฟซ MediaRouter จะเชื่อมต่อกับเฟรมเวิร์กและเล่นเนื้อหาในอุปกรณ์ที่เข้าร่วมเฟรมเวิร์กเราเตอร์สื่อได้ ผู้ผลิตอุปกรณ์เล่นสื่อสามารถเข้าร่วมเฟรมเวิร์กได้โดยการเผยแพร่ MediaRouteProvider ที่อนุญาตให้แอปพลิเคชันอื่นๆ เชื่อมต่อและเล่นสื่อในอุปกรณ์รับสัญญาณได้ รูปที่ 1 แสดงวิธีที่แอปเชื่อมต่อกับอุปกรณ์รับผ่านเฟรมเวิร์ก Media Router

รูปที่ 1 ภาพรวมของวิธีที่คลาสผู้ให้บริการเส้นทางสื่อช่วยให้แอปสื่อสื่อสารกับอุปกรณ์รับสัญญาณได้

เมื่อคุณสร้างผู้ให้บริการเส้นทางสื่อสำหรับอุปกรณ์รับสัญญาณ ผู้ให้บริการจะมีวัตถุประสงค์ต่อไปนี้

  • อธิบายและเผยแพร่ความสามารถของอุปกรณ์รับสัญญาณเพื่อให้แอปอื่นๆ ค้นพบอุปกรณ์และใช้ฟีเจอร์การเล่นของอุปกรณ์ได้
  • รวมอินเทอร์เฟซการเขียนโปรแกรมของอุปกรณ์รับสัญญาณและกลไกการรับส่งข้อมูลการสื่อสารเพื่อให้อุปกรณ์เข้ากันได้กับเฟรมเวิร์ก Media Router

การกระจายของผู้ให้บริการเส้นทาง

ผู้ให้บริการเส้นทางสื่อจะได้รับการเผยแพร่เป็นส่วนหนึ่งของแอป Android คุณสามารถทำให้ผู้ให้บริการเส้นทางพร้อมใช้งานสำหรับแอปอื่นๆ ได้โดยขยาย MediaRouteProviderService หรือรวมการติดตั้งใช้งาน MediaRouteProvider ด้วยบริการของคุณเองและประกาศตัวกรอง Intent สำหรับผู้ให้บริการเส้นทางสื่อ ขั้นตอนเหล่านี้ช่วยให้แอปอื่นๆ ค้นพบและใช้เส้นทางสื่อของคุณได้

หมายเหตุ: แอปที่มีผู้ให้บริการเส้นทางสื่อสามารถมีอินเทอร์เฟซ MediaRouter ไปยังผู้ให้บริการเส้นทางได้ด้วย แต่ไม่จำเป็น

ไลบรารีสนับสนุน MediaRouter

API ของ Media Router จะกำหนดไว้ในไลบรารี MediaRouter ของ AndroidX คุณต้องเพิ่มไลบรารีนี้ลงในโปรเจ็กต์การพัฒนาแอป ดูข้อมูลเพิ่มเติมเกี่ยวกับการเพิ่มไลบรารีสนับสนุนลงในโปรเจ็กต์ได้ที่การตั้งค่าไลบรารีสนับสนุน

ข้อควรระวัง: อย่าลืมใช้การติดตั้งใช้งาน AndroidX ของเฟรมเวิร์ก Media Router อย่าใช้แพ็กเกจ android.media เวอร์ชันเก่า

การสร้างบริการของผู้ให้บริการ

เฟรมเวิร์กเราเตอร์สื่อต้องสามารถค้นพบและเชื่อมต่อกับผู้ให้บริการเส้นทางสื่อของคุณเพื่ออนุญาตให้แอปพลิเคชันอื่นๆ ใช้เส้นทางของคุณได้ ในการดำเนินการนี้ เฟรมเวิร์กเราเตอร์สื่อจะมองหาแอปที่ประกาศการดำเนินการตาม Intent ของผู้ให้บริการเส้นทางสื่อ เมื่อแอปอื่นต้องการเชื่อมต่อกับผู้ให้บริการของคุณ เฟรมเวิร์กต้องเรียกใช้และเชื่อมต่อกับแอปนั้นได้ ดังนั้นผู้ให้บริการของคุณจึงต้องรวมอยู่ใน Service

โค้ดตัวอย่างต่อไปนี้แสดงการประกาศบริการของผู้ให้บริการเส้นทางสื่อและตัวกรอง Intent ในไฟล์ Manifest ซึ่งช่วยให้เฟรมเวิร์กเราเตอร์สื่อค้นพบและใช้งานได้

<service android:name=".provider.SampleMediaRouteProviderService"
    android:label="@string/sample_media_route_provider_service"
    android:process=":mrp">
    <intent-filter>
        <action android:name="android.media.MediaRouteProviderService" />
    </intent-filter>
</service>

ตัวอย่างไฟล์ Manifest นี้ประกาศบริการที่รวมคลาสผู้ให้บริการเส้นทางสื่อจริง เฟรมเวิร์กเราเตอร์สื่อของ Android มีคลาส MediaRouteProviderService สำหรับใช้เป็น Wrapper บริการสำหรับผู้ให้บริการเส้นทางสื่อ โค้ดตัวอย่างต่อไปนี้แสดงวิธีใช้คลาส Wrapper นี้

class SampleMediaRouteProviderService : MediaRouteProviderService() {

    override fun onCreateMediaRouteProvider(): MediaRouteProvider {
        return SampleMediaRouteProvider(this)
    }
}

การระบุความสามารถของเส้นทาง

แอปที่เชื่อมต่อกับเฟรมเวิร์กเราเตอร์สื่อจะค้นพบเส้นทางสื่อของคุณผ่านการประกาศไฟล์ Manifest ของแอป แต่แอปเหล่านั้นยังต้องทราบความสามารถของเส้นทางสื่อที่คุณให้บริการด้วย เส้นทางสื่ออาจมีประเภทและฟีเจอร์ที่แตกต่างกัน และแอปอื่นๆ ต้องสามารถค้นพบรายละเอียดเหล่านี้เพื่อพิจารณาว่าเข้ากันได้กับเส้นทางของคุณหรือไม่

เฟรมเวิร์กเราเตอร์สื่อช่วยให้คุณกำหนดและเผยแพร่ความสามารถของเส้นทางสื่อผ่านออบเจ็กต์ IntentFilter, ออบเจ็กต์ MediaRouteDescriptor และ MediaRouteProviderDescriptor ได้ ส่วนนี้จะอธิบายวิธีใช้คลาสเหล่านี้เพื่อเผยแพร่รายละเอียดของเส้นทางสื่อสำหรับแอปอื่นๆ

หมวดหมู่เส้นทาง

คุณต้องระบุว่าผู้ให้บริการรองรับการเล่นระยะไกล เอาต์พุตรอง หรือทั้ง 2 อย่าง โดยเป็นส่วนหนึ่งของคำอธิบายแบบเป็นโปรแกรมของผู้ให้บริการเส้นทางสื่อ หมวดหมู่เส้นทางที่เฟรมเวิร์กเราเตอร์สื่อมีให้มีดังนี้

  • CATEGORY_LIVE_AUDIO - เอาต์พุตเสียงไปยังอุปกรณ์เอาต์พุตรอง เช่น ระบบเพลงที่เปิดใช้ระบบไร้สาย
  • CATEGORY_LIVE_VIDEO - เอาต์พุตของวิดีโอไปยังอุปกรณ์เอาต์พุตรอง เช่น อุปกรณ์การแสดงผลแบบไร้สาย
  • CATEGORY_REMOTE_PLAYBACK — เล่นวิดีโอหรือเสียงในอุปกรณ์แยกต่างหากซึ่งจัดการการดึงข้อมูล การถอดรหัส และการเล่นสื่อ เช่น อุปกรณ์ Chromecast

หากต้องการรวมการตั้งค่าเหล่านี้ไว้ในคำอธิบายเส้นทางสื่อ ให้แทรกการตั้งค่าลงในออบเจ็กต์ IntentFilter ซึ่งคุณจะเพิ่มลงในออบเจ็กต์ MediaRouteDescriptor ในภายหลัง ดังนี้

class SampleMediaRouteProvider(context: Context) : MediaRouteProvider(context) {

    companion object {
        private val CONTROL_FILTERS_BASIC: ArrayList<IntentFilter> = IntentFilter().run {
            addCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
            arrayListOf(this)
        }
    }
}

หากระบุ Intent CATEGORY_REMOTE_PLAYBACK คุณต้องกำหนดประเภทสื่อและตัวควบคุมการเล่นที่ผู้ให้บริการเส้นทางสื่อรองรับด้วย ส่วนถัดไปจะอธิบายวิธีระบุการตั้งค่าเหล่านี้สำหรับอุปกรณ์ของคุณ

ประเภทสื่อและโปรโตคอล

ผู้ให้บริการเส้นทางสื่อสำหรับอุปกรณ์การเล่นระยะไกลต้องระบุประเภทสื่อและโปรโตคอลการโอนที่รองรับ คุณระบุการตั้งค่าเหล่านี้โดยใช้คลาส IntentFilter และเมธอด addDataScheme() และ addDataType() ของออบเจ็กต์นั้น ข้อมูลโค้ดต่อไปนี้แสดงวิธีกำหนดตัวกรอง Intent เพื่อรองรับการเล่นวิดีโอระยะไกลโดยใช้ http, https และ Real Time Streaming Protocol (RTSP)

class SampleMediaRouteProvider(context: Context) : MediaRouteProvider(context) {

    companion object {

        private fun IntentFilter.addDataTypeUnchecked(type: String) {
            try {
                addDataType(type)
            } catch (ex: IntentFilter.MalformedMimeTypeException) {
                throw RuntimeException(ex)
            }
        }

        private val CONTROL_FILTERS_BASIC: ArrayList<IntentFilter> = IntentFilter().run {
            addCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
            addAction(MediaControlIntent.ACTION_PLAY)
            addDataScheme("http")
            addDataScheme("https")
            addDataScheme("rtsp")
            addDataTypeUnchecked("video/*")
            arrayListOf(this)
        }
    }
    // ...
}

ตัวควบคุมการเล่น

ผู้ให้บริการเส้นทางสื่อที่นำเสนอการเล่นจากระยะไกลต้องระบุประเภทของตัวควบคุมสื่อที่รองรับ ประเภทการควบคุมทั่วไปที่เส้นทางสื่อสามารถให้ได้มีดังนี้

  • ตัวควบคุมการเล่น เช่น เล่น หยุดชั่วคราว กรอกลับ และกรอไปข้างหน้า
  • ฟีเจอร์การจัดคิว ซึ่งช่วยให้แอปที่ส่งเพิ่มและนำรายการออกจากเพลย์ลิสต์ที่อุปกรณ์รับสัญญาณดูแลรักษาได้
  • ฟีเจอร์เซสชัน ซึ่งป้องกันไม่ให้แอปที่ส่งรบกวนซึ่งกันและกันโดยให้อุปกรณ์รับสัญญาณระบุรหัสเซสชันแก่แอปที่ส่งคำขอ แล้วตรวจสอบรหัสนั้นกับคำขอตัวควบคุมการเล่นที่ตามมาแต่ละรายการ

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีสร้างตัวกรอง Intent เพื่อรองรับตัวควบคุมการเล่นเส้นทางสื่อพื้นฐาน

class SampleMediaRouteProvider(context: Context) : MediaRouteProvider(context) {

    companion object {
        // ...
        private val CONTROL_FILTERS_BASIC: ArrayList<IntentFilter> = run {
            val videoPlayback: IntentFilter = ...
            // ...
            val playControls = IntentFilter().apply {
                addCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
                addAction(MediaControlIntent.ACTION_SEEK)
                addAction(MediaControlIntent.ACTION_GET_STATUS)
                addAction(MediaControlIntent.ACTION_PAUSE)
                addAction(MediaControlIntent.ACTION_RESUME)
                addAction(MediaControlIntent.ACTION_STOP)
            }
            arrayListOf(videoPlayback, playControls)
        }
    }
    // ...
}

ดูข้อมูลเพิ่มเติมเกี่ยวกับ Intent การควบคุมการเล่นที่ใช้ได้ที่คลาส MediaControlIntent

MediaRouteProviderDescriptor

หลังจากกำหนดความสามารถของเส้นทางสื่อโดยใช้ออบเจ็กต์ IntentFilter แล้ว คุณจะสร้างออบเจ็กต์ข้อบ่งชี้เพื่อเผยแพร่ไปยังเฟรมเวิร์กเราเตอร์สื่อของ Android ได้ ออบเจ็กต์ข้อบ่งชี้นี้มีข้อมูลเฉพาะเกี่ยวกับความสามารถของเส้นทางสื่อเพื่อให้แอปพลิเคชันอื่นๆ กำหนดวิธีโต้ตอบกับเส้นทางสื่อได้

โค้ดตัวอย่างต่อไปนี้แสดงวิธีเพิ่มตัวกรอง Intent ที่สร้างไว้ก่อนหน้านี้ลงใน MediaRouteProviderDescriptor และตั้งค่าข้อบ่งชี้เพื่อใช้โดยเฟรมเวิร์ก Media Router

class SampleMediaRouteProvider(context: Context) : MediaRouteProvider(context) {

    init {
        publishRoutes()
    }

    private fun publishRoutes() {
        val resources = context.resources
        val routeName: String = resources.getString(R.string.variable_volume_basic_route_name)
        val routeDescription: String = resources.getString(R.string.sample_route_description)
        // Create a route descriptor using previously created IntentFilters.
        val routeDescriptor: MediaRouteDescriptor =
            MediaRouteDescriptor.Builder(VARIABLE_VOLUME_BASIC_ROUTE_ID, routeName)
                .setDescription(routeDescription)
                .addControlFilters(CONTROL_FILTERS_BASIC)
                .setPlaybackStream(AudioManager.STREAM_MUSIC)
                .setPlaybackType(MediaRouter.RouteInfo.PLAYBACK_TYPE_REMOTE)
                .setVolumeHandling(MediaRouter.RouteInfo.PLAYBACK_VOLUME_VARIABLE)
                .setVolumeMax(VOLUME_MAX)
                .setVolume(mVolume)
                .build()
        // Add the route descriptor to the provider descriptor.
        val providerDescriptor: MediaRouteProviderDescriptor =
            MediaRouteProviderDescriptor.Builder()
                .addRoute(routeDescriptor)
                .build()

        // Publish the descriptor to the framework.
        descriptor = providerDescriptor
    }
    // ...
}

ดูข้อมูลเพิ่มเติมเกี่ยวกับการตั้งค่าข้อบ่งชี้ที่ใช้ได้ในเอกสารอ้างอิงสำหรับ MediaRouteDescriptor และ MediaRouteProviderDescriptor

การควบคุมเส้นทาง

เมื่อแอปพลิเคชันเชื่อมต่อกับผู้ให้บริการเส้นทางสื่อ ผู้ให้บริการจะได้รับคำสั่งการเล่นผ่านเฟรมเวิร์กเราเตอร์สื่อที่แอปอื่นๆ ส่งไปยังเส้นทางของคุณ หากต้องการจัดการคำขอเหล่านี้ คุณต้องระบุการติดตั้งใช้งานคลาส MediaRouteProvider.RouteController ซึ่งจะประมวลผลคำสั่งและจัดการการสื่อสารจริงกับอุปกรณ์รับสัญญาณ

เฟรมเวิร์ก Media Router จะเรียกใช้เมธอด onCreateRouteController() ของผู้ให้บริการเส้นทางเพื่อรับอินสแตนซ์ของคลาสนี้ แล้วกำหนดเส้นทางคำขอไปยังอินสแตนซ์ดังกล่าว ต่อไปนี้คือเมธอดหลักของคลาส MediaRouteProvider.RouteController ซึ่งคุณต้องใช้สำหรับผู้ให้บริการเส้นทางสื่อ

  • onSelect() — เรียกใช้เมื่อแอปพลิเคชันเลือกเส้นทางของคุณสำหรับการเล่น คุณใช้วิธีนี้เพื่อเตรียมการที่จำเป็นก่อนเริ่มเล่นสื่อ
  • onControlRequest() — ส่งคำสั่งการเล่นที่เฉพาะเจาะจงไปยังอุปกรณ์ที่รับ
  • onSetVolume() — ส่งคำขอไปยังอุปกรณ์ที่รับเพื่อตั้งค่าระดับเสียงในการเล่นเป็นค่าที่เจาะจง
  • onUpdateVolume() — ส่งคำขอไปยังอุปกรณ์ที่รับเพื่อปรับระดับเสียงการเล่นตามจำนวนที่ระบุ
  • onUnselect() — เรียกใช้เมื่อแอปพลิเคชันยกเลิกการเลือกเส้นทาง
  • onRelease() — ระบบจะเรียกใช้เมื่อเฟรมเวิร์กไม่ต้องการเส้นทางอีกต่อไป เพื่อให้สามารถปล่อยทรัพยากรได้

คำขอควบคุมการเล่นทั้งหมด ยกเว้นการเปลี่ยนแปลงระดับเสียง จะส่งไปยังเมธอด onControlRequest() การติดตั้งใช้งานเมธอดนี้ต้องแยกวิเคราะห์คำขอควบคุมและตอบสนองต่อคำขออย่างเหมาะสม ต่อไปนี้เป็นตัวอย่างการใช้งานเมธอดนี้ซึ่งประมวลผลคำสั่งสำหรับเส้นทางสื่อการเล่นระยะไกล

private class SampleRouteController : MediaRouteProvider.RouteController() {
    // ...

    override fun onControlRequest(
        intent: Intent,
        callback: MediaRouter.ControlRequestCallback?
    ): Boolean {
        return if (intent.hasCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)) {
            val action = intent.action
            when (action) {
                MediaControlIntent.ACTION_PLAY -> handlePlay(intent, callback)
                MediaControlIntent.ACTION_ENQUEUE -> handleEnqueue(intent, callback)
                MediaControlIntent.ACTION_REMOVE -> handleRemove(intent, callback)
                MediaControlIntent.ACTION_SEEK -> handleSeek(intent, callback)
                MediaControlIntent.ACTION_GET_STATUS -> handleGetStatus(intent, callback)
                MediaControlIntent.ACTION_PAUSE -> handlePause(intent, callback)
                MediaControlIntent.ACTION_RESUME -> handleResume(intent, callback)
                MediaControlIntent.ACTION_STOP -> handleStop(intent, callback)
                MediaControlIntent.ACTION_START_SESSION -> handleStartSession(intent, callback)
                MediaControlIntent.ACTION_GET_SESSION_STATUS ->
                    handleGetSessionStatus(intent, callback)
                MediaControlIntent.ACTION_END_SESSION -> handleEndSession(intent, callback)
                else -> false
            }.also {
                Log.d(TAG, sessionManager.toString())
            }
        } else {
            false
        }
    }
    // ...
}

สิ่งสำคัญที่ต้องเข้าใจคือคลาส MediaRouteProvider.RouteController มีไว้เพื่อทำหน้าที่เป็น Wrapper สำหรับ API ไปยังอุปกรณ์เล่นสื่อของคุณ การติดตั้งใช้งานเมธอดในคลาสนี้ขึ้นอยู่กับอินเทอร์เฟซแบบเป็นโปรแกรมที่อุปกรณ์รับสัญญาณมีให้ทั้งหมด

โค้ดตัวอย่าง

ตัวอย่าง MediaRouter แสดงวิธีสร้างผู้ให้บริการเส้นทางสื่อที่กำหนดเอง