เพิ่มฟีเจอร์หลักในตัวรับสัญญาณ Android TV

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

หมายเหตุ: เราขอแนะนำให้ลองทำตามขั้นตอนต่อไปนี้

• แคสต์ Android TV Codelab บทแนะนำ - ดูวิธีสร้างแอปตัวรับสัญญาณ Android TV ที่พร้อมใช้งาน Cast แบบทีละขั้นตอน โดยใช้ Google Cast SDK ที่รับการแคสต์วิดีโอ
• ตัวอย่างแอป CastAndroidTvReceiver (GitHub) - เรียกใช้ นำทาง และดูแอปตัวอย่างอ้างอิงนี้ซึ่งเป็นไปตาม หลักเกณฑ์ UX และ รายการตรวจสอบการออกแบบ
• ตัวอย่างแอปสำหรับผู้ส่ง CastVideos (GitHub) - ทดสอบโดยใช้แอปตัวอย่างสำหรับอ้างอิงของผู้ส่งที่พร้อมใช้งาน Cast Connect

การกำหนดค่าไลบรารี

วิธีทำให้ Cast Connect API ใช้งานในแอป Android TV ได้มีดังนี้

Android

1. เปิดไฟล์ build.gradle ภายในไดเรกทอรีโมดูลแอปพลิเคชัน
   หมายเหตุ: โปรเจ็กต์ Android Studio มี ไฟล์ create.gradle ระดับบนสุดและไฟล์ create.gradle สำหรับแต่ละโมดูล ตรวจสอบให้แน่ใจว่า เพื่อแก้ไขไฟล์สำหรับโมดูลแอปพลิเคชันของคุณ โปรดดู สร้างโปรเจ็กต์ด้วย Gradle เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับ Gradle
2. ตรวจสอบว่า google() รวมอยู่ใน repositories ที่ระบุ

     repositories {
       google()
     }

3. เพิ่มเวอร์ชันล่าสุดโดยขึ้นอยู่กับประเภทอุปกรณ์เป้าหมายสำหรับแอป ของไลบรารีไปยังทรัพยากร Dependency ของคุณ
   • สำหรับแอปตัวรับสัญญาณ Android:

       dependencies {
         implementation 'com.google.android.gms:play-services-cast-tv:21.1.0'
         implementation 'com.google.android.gms:play-services-cast:21.5.0'
       }

   • สำหรับแอปผู้ส่ง Android

       dependencies {
         implementation 'com.google.android.gms:play-services-cast:21.1.0'
         implementation 'com.google.android.gms:play-services-cast-framework:21.5.0'
       }

   โปรดอัปเดตหมายเลขเวอร์ชันนี้ทุกครั้งที่มีการอัปเดตบริการ
4. บันทึกการเปลี่ยนแปลงแล้วคลิก Sync Project with Gradle Files ในแถบเครื่องมือ

iOS

1. ตรวจสอบว่า Podfile กําหนดเป้าหมายเป็น google-cast-sdk 4.8.1 ขึ้นไป
2. กําหนดเป้าหมายเป็น iOS 14 ขึ้นไป โปรดดูบันทึกประจำรุ่น เพื่อดูรายละเอียดเพิ่มเติม

     platform: ios, '14'
   
     def target_pods
        pod 'google-cast-sdk', '~>4.8.1'
     end

เว็บ

1. ต้องใช้เบราว์เซอร์ Chromium เวอร์ชัน M87 ขึ้นไป
2. เพิ่มไลบรารี Web Sender API ในโปรเจ็กต์

     <script src="//www.gstatic.com/cv/js/sender/v1/cast_sender.js?loadCastFramework=1"></script>

ข้อกำหนดของ AndroidX

บริการ Google Play เวอร์ชันใหม่กําหนดให้ต้องอัปเดตแอปจึงจะใช้ได้ เนมสเปซ androidx ทำตามวิธีการสำหรับ การย้ายข้อมูลไปยัง AndroidX

แอป Android TV - ข้อกำหนดเบื้องต้น

เพื่อให้รองรับ Cast Connect ในแอป Android TV คุณต้องสร้างและ รองรับเหตุการณ์จากเซสชันสื่อ ข้อมูลที่ได้จากเซสชันสื่อของคุณ ให้ข้อมูลพื้นฐาน เช่น ตำแหน่ง สถานะการเล่น ฯลฯ สถานะสื่อของคุณ ไลบรารี Cast Connect ก็ใช้เซสชันสื่อของคุณด้วย เพื่อส่งสัญญาณแจ้งเมื่อได้รับข้อความบางอย่างจากผู้ส่ง เช่น หยุดชั่วคราว

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับเซสชันสื่อและวิธีเริ่มต้นเซสชันสื่อ โปรดดู การทำงานกับคู่มือเซสชันสื่อ

วงจรเซสชันสื่อ

แอปควรสร้างเซสชันสื่อเมื่อการเล่นเริ่มเล่นและปล่อยเมื่อ และไม่สามารถควบคุมได้อีกต่อไป ตัวอย่างเช่น หากแอปของคุณคือแอปวิดีโอ คุณจะ ควรปล่อยเซสชันเมื่อผู้ใช้ออกจากกิจกรรมการเล่น เลือก "กลับ" เพื่อเรียกดูเนื้อหาอื่น หรือโดยการขณะล็อกหน้าจอหรือขณะใช้แอปอื่น หาก เป็นแอปเพลง คุณควรปล่อยเมื่อแอปไม่ได้เปิดแล้ว สื่อ

กำลังอัปเดตสถานะเซสชัน

หมายเหตุ: หากคุณใช้ Exoplayer โปรดดู การใช้ Exoplayer กับ Cast Connect เพื่อดูวิธีอัปเดตเซสชันสื่อโดยอัตโนมัติ

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

MediaMetadataCompat

ช่องข้อมูลเมตา	คำอธิบาย
METADATA_KEY_TITLE (ต้องระบุ)	ชื่อสื่อ
METADATA_KEY_DISPLAY_SUBTITLE	คำบรรยาย
METADATA_KEY_DISPLAY_ICON_URI	URL ของไอคอน
METADATA_KEY_DURATION (ต้องระบุ)	ระยะเวลาของสื่อ
METADATA_KEY_MEDIA_URI	Content ID
METADATA_KEY_ARTIST	ศิลปิน
METADATA_KEY_ALBUM	อัลบั้ม

PlaybackStateCompat

วิธีการที่จำเป็น	คำอธิบาย
setActions()	ตั้งค่าคำสั่งสื่อที่รองรับ
setState()	กำหนดสถานะการเล่นและตำแหน่งปัจจุบัน

MediaSessionCompat

วิธีการที่จำเป็น	คำอธิบาย
setRepeatMode()	ตั้งโหมดการเล่นซ้ำ
setShuffleMode()	ตั้งค่าโหมดสุ่มเพลง
setMetadata()	ตั้งค่าข้อมูลเมตาของสื่อ
setPlaybackState()	ตั้งค่าสถานะการเล่น

Kotlin

วันที่

private fun updateMediaSession() {
    val metadata = MediaMetadataCompat.Builder()
         .putString(MediaMetadataCompat.METADATA_KEY_TITLE, "title")
         .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE, "subtitle")
         .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON_URI, mMovie.getCardImageUrl())
         .build()

    val playbackState = PlaybackStateCompat.Builder()
         .setState(
             PlaybackStateCompat.STATE_PLAYING,
             player.getPosition(),
             player.getPlaybackSpeed(),
             System.currentTimeMillis()
        )
         .build()

    mediaSession.setMetadata(metadata)
    mediaSession.setPlaybackState(playbackState)
}

Java

private void updateMediaSession() {
  MediaMetadataCompat metadata =
      new MediaMetadataCompat.Builder()
          .putString(MediaMetadataCompat.METADATA_KEY_TITLE, "title")
          .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_SUBTITLE, "subtitle")
          .putString(MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON_URI,mMovie.getCardImageUrl())
          .build();

  PlaybackStateCompat playbackState =
      new PlaybackStateCompat.Builder()
          .setState(
               PlaybackStateCompat.STATE_PLAYING,
               player.getPosition(),
               player.getPlaybackSpeed(),
               System.currentTimeMillis())
          .build();

  mediaSession.setMetadata(metadata);
  mediaSession.setPlaybackState(playbackState);
}

การควบคุมการขนส่งที่ดำเนินการอยู่

แอปของคุณควรใช้ Callback ตัวควบคุมการรับส่งเซสชันสื่อ ตารางต่อไปนี้แสดงการดำเนินการของการควบคุมการรับส่งข้อมูลที่ต้องจัดการ

MediaSessionCompat.Callback

การทำงาน	คำอธิบาย
onPlay()	บันทึกต่อ
onPause()	หยุดชั่วคราว
onSeekTo()	กรอไปที่ตำแหน่งที่ต้องการ
onStop()	หยุดสื่อปัจจุบัน

Kotlin

วันที่

class MyMediaSessionCallback : MediaSessionCompat.Callback() {
  override fun onPause() {
    // Pause the player and update the play state.
    ...
  }

  override fun onPlay() {
    // Resume the player and update the play state.
    ...
  }

  override fun onSeekTo (long pos) {
    // Seek and update the play state.
    ...
  }
  ...
}

mediaSession.setCallback( MyMediaSessionCallback() );

Java

public MyMediaSessionCallback extends MediaSessionCompat.Callback {
  public void onPause() {
    // Pause the player and update the play state.
    ...
  }

  public void onPlay() {
    // Resume the player and update the play state.
    ...
  }

  public void onSeekTo (long pos) {
    // Seek and update the play state.
    ...
  }
  ...
}

mediaSession.setCallback(new MyMediaSessionCallback());

การกำหนดค่าการรองรับการแคสต์

เมื่อแอปพลิเคชันของผู้ส่งส่งคำขอเปิดใช้งาน ระบบจะสร้าง Intent กับเนมสเปซของแอปพลิเคชัน แอปพลิเคชันของคุณมีหน้าที่จัดการ และสร้างอินสแตนซ์ของ CastReceiverContext เมื่อเปิดแอป TV จำเป็นต้องมีออบเจ็กต์ CastReceiverContext เพื่อโต้ตอบกับแคสต์ในขณะที่แอป TV ทำงานอยู่ ออบเจ็กต์นี้ช่วยให้ทีวีของคุณ แอปพลิเคชันเพื่อยอมรับข้อความสื่อของ Cast ที่มาจากผู้ส่งที่เชื่อมต่ออยู่

ตั้งค่า Android TV

การเพิ่มตัวกรอง Intent การเปิดตัว

เพิ่มตัวกรอง Intent ใหม่ในกิจกรรมที่คุณต้องการจัดการการเปิดตัว Intent จากแอปผู้ส่งของคุณดังนี้

<activity android:name="com.example.activity">
  <intent-filter>
      <action android:name="com.google.android.gms.cast.tv.action.LAUNCH" />
      <category android:name="android.intent.category.DEFAULT" />
  </intent-filter>
</activity>

ระบุผู้ให้บริการตัวเลือกผู้รับ

คุณต้องใช้ ReceiverOptionsProvider ที่จะให้ CastReceiverOptions

Kotlin

วันที่

class MyReceiverOptionsProvider : ReceiverOptionsProvider {
  override fun getOptions(context: Context?): CastReceiverOptions {
    return CastReceiverOptions.Builder(context)
          .setStatusText("My App")
          .build()
    }
}

Java

วันที่

public class MyReceiverOptionsProvider implements ReceiverOptionsProvider {
  @Override
  public CastReceiverOptions getOptions(Context context) {
    return new CastReceiverOptions.Builder(context)
        .setStatusText("My App")
        .build();
  }
}

หมายเหตุ: หากไม่ตั้งค่า setStatusText ระบบจะดึงมาจาก android:label ในไฟล์ Manifest ของ Android TV

จากนั้นระบุผู้ให้บริการตัวเลือกใน AndroidManifest ของคุณ:

 <meta-data
    android:name="com.google.android.gms.cast.tv.RECEIVER_OPTIONS_PROVIDER_CLASS_NAME"
    android:value="com.example.mysimpleatvapplication.MyReceiverOptionsProvider" />

ระบบจะใช้ ReceiverOptionsProvider เพื่อระบุ CastReceiverOptions เมื่อ เริ่มต้น CastReceiverContext แล้ว

บริบทของอุปกรณ์รับการแคสต์

เริ่มต้น CastReceiverContext เมื่อสร้างแอปของคุณ

Kotlin

วันที่

override fun onCreate() {
  CastReceiverContext.initInstance(this)

  ...
}

Java

@Override
public void onCreate() {
  CastReceiverContext.initInstance(this);

  ...
}

เริ่มใช้ CastReceiverContext เมื่อแอปย้ายไปที่เบื้องหน้า

Kotlin

วันที่

CastReceiverContext.getInstance().start()

Java

CastReceiverContext.getInstance().start();

โทร stop() ใน CastReceiverContext หลังจากที่แอปทำงานในพื้นหลังสำหรับแอปวิดีโอหรือแอปที่ไม่รองรับ การเล่นขณะล็อกหน้าจอหรือขณะใช้แอปอื่น:

Kotlin

วันที่

// Player has stopped.
CastReceiverContext.getInstance().stop()

Java

// Player has stopped.
CastReceiverContext.getInstance().stop();

นอกจากนี้ หากแอปรองรับการเล่นขณะล็อกหน้าจอหรือขณะใช้แอปอื่น โปรดโทรหา stop() บน CastReceiverContext เมื่อหยุดเล่นขณะอยู่ในเบื้องหลัง

เราขอแนะนำให้คุณใช้ LifecycleObserver จาก androidx.lifecycle คลังสำหรับจัดการการโทร CastReceiverContext.start() และ CastReceiverContext.stop() โดยเฉพาะอย่างยิ่งหากแอปที่มาพร้อมเครื่องของคุณมีหลายกิจกรรม การดำเนินการนี้เลี่ยงเชื้อชาติ เงื่อนไขเมื่อคุณเรียกใช้ start() และ stop() จากกิจกรรมที่แตกต่างกัน

Kotlin

วันที่

// Create a LifecycleObserver class.
class MyLifecycleObserver : DefaultLifecycleObserver {
  override fun onStart(owner: LifecycleOwner) {
    // App prepares to enter foreground.
    CastReceiverContext.getInstance().start()
  }

  override fun onStop(owner: LifecycleOwner) {
    // App has moved to the background or has terminated.
    CastReceiverContext.getInstance().stop()
  }
}

// Add the observer when your application is being created.
class MyApplication : Application() {
  fun onCreate() {
    super.onCreate()

    // Initialize CastReceiverContext.
    CastReceiverContext.initInstance(this /* android.content.Context */)

    // Register LifecycleObserver
    ProcessLifecycleOwner.get().lifecycle.addObserver(
        MyLifecycleObserver())
  }
}

Java

// Create a LifecycleObserver class.
public class MyLifecycleObserver implements DefaultLifecycleObserver {
  @Override
  public void onStart(LifecycleOwner owner) {
    // App prepares to enter foreground.
    CastReceiverContext.getInstance().start();
  }

  @Override
  public void onStop(LifecycleOwner owner) {
    // App has moved to the background or has terminated.
    CastReceiverContext.getInstance().stop();
  }
}

// Add the observer when your application is being created.
public class MyApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();

    // Initialize CastReceiverContext.
    CastReceiverContext.initInstance(this /* android.content.Context */);

    // Register LifecycleObserver
    ProcessLifecycleOwner.get().getLifecycle().addObserver(
        new MyLifecycleObserver());
  }
}

// In AndroidManifest.xml set MyApplication as the application class
<application
    ...
    android:name=".MyApplication">

การเชื่อมต่อ MediaSession กับ MediaManager

เมื่อคุณสร้าง MediaSession คุณยังต้องระบุโทเค็น MediaSession ปัจจุบันเพื่อ CastReceiverContext เพื่อให้รู้ว่าจะส่งคำสั่งและเรียกข้อมูลสถานะการเล่นสื่อไปที่ใด ดังนี้

Kotlin

วันที่

val mediaManager: MediaManager = receiverContext.getMediaManager()
mediaManager.setSessionCompatToken(currentMediaSession.getSessionToken())

Java

MediaManager mediaManager = receiverContext.getMediaManager();
mediaManager.setSessionCompatToken(currentMediaSession.getSessionToken());

เมื่อปล่อย MediaSession เนื่องจากไม่ได้เล่น คุณควรตั้งค่า โทเค็นค่าว่างเปิดอยู่ MediaManager

Kotlin

วันที่

myPlayer.stop()
mediaSession.release()
mediaManager.setSessionCompatToken(null)

Java

myPlayer.stop();
mediaSession.release();
mediaManager.setSessionCompatToken(null);

หากแอปรองรับการเล่นสื่อขณะที่แอปอยู่ในเบื้องหลัง ของการโทร CastReceiverContext.stop() เมื่อส่งแอปไปยังพื้นหลัง คุณควรเรียกใช้เฉพาะเมื่อแอปของคุณ อยู่ในเบื้องหลังและไม่ได้เล่นสื่ออีกต่อไป เช่น

Kotlin

วันที่

class MyLifecycleObserver : DefaultLifecycleObserver {
  ...
  // App has moved to the background.
  override fun onPause(owner: LifecycleOwner) {
    mIsBackground = true
    myStopCastReceiverContextIfNeeded()
  }
}

// Stop playback on the player.
private fun myStopPlayback() {
  myPlayer.stop()

  myStopCastReceiverContextIfNeeded()
}

// Stop the CastReceiverContext when both the player has
// stopped and the app has moved to the background.
private fun myStopCastReceiverContextIfNeeded() {
  if (mIsBackground && myPlayer.isStopped()) {
    CastReceiverContext.getInstance().stop()
  }
}

Java

public class MyLifecycleObserver implements DefaultLifecycleObserver {
  ...
  // App has moved to the background.
  @Override
  public void onPause(LifecycleOwner owner) {
    mIsBackground = true;

    myStopCastReceiverContextIfNeeded();
  }
}

// Stop playback on the player.
private void myStopPlayback() {
  myPlayer.stop();

  myStopCastReceiverContextIfNeeded();
}

// Stop the CastReceiverContext when both the player has
// stopped and the app has moved to the background.
private void myStopCastReceiverContextIfNeeded() {
  if (mIsBackground && myPlayer.isStopped()) {
    CastReceiverContext.getInstance().stop();
  }
}

การใช้ Exoplayer กับ Cast Connect

หากคุณกำลังใช้ Exoplayer คุณสามารถใช้ MediaSessionConnector เพื่อรักษาเซสชันและข้อมูลที่เกี่ยวข้องทั้งหมดโดยอัตโนมัติ รวมถึง สถานะการเล่น แทนการติดตามการเปลี่ยนแปลงด้วยตนเอง

MediaSessionConnector.MediaButtonEventHandler สามารถใช้ในการจัดการเหตุการณ์ MediaButton ด้วยการเรียก setMediaButtonEventHandler(MediaButtonEventHandler) ซึ่งจัดการโดย MediaSessionCompat.Callback โดยค่าเริ่มต้น

วิธีผสานรวม MediaSessionConnector ในแอปของคุณ ให้เพิ่มข้อมูลต่อไปนี้ลงในคลาสกิจกรรมผู้เล่นหรือที่ใดก็ตามที่คุณ จัดการเซสชันสื่อของคุณ:

Kotlin

วันที่

class PlayerActivity : Activity() {
  private var mMediaSession: MediaSessionCompat? = null
  private var mMediaSessionConnector: MediaSessionConnector? = null
  private var mMediaManager: MediaManager? = null

  override fun onCreate(savedInstanceState: Bundle?) {
    ...
    mMediaSession = MediaSessionCompat(this, LOG_TAG)
    mMediaSessionConnector = MediaSessionConnector(mMediaSession!!)
    ...
  }

  override fun onStart() {
    ...
    mMediaManager = receiverContext.getMediaManager()
    mMediaManager!!.setSessionCompatToken(currentMediaSession.getSessionToken())
    mMediaSessionConnector!!.setPlayer(mExoPlayer)
    mMediaSessionConnector!!.setMediaMetadataProvider(mMediaMetadataProvider)
    mMediaSession!!.isActive = true
    ...
  }

  override fun onStop() {
    ...
    mMediaSessionConnector!!.setPlayer(null)
    mMediaSession!!.release()
    mMediaManager!!.setSessionCompatToken(null)
    ...
  }
}

Java

public class PlayerActivity extends Activity {
  private MediaSessionCompat mMediaSession;
  private MediaSessionConnector mMediaSessionConnector;
  private MediaManager mMediaManager;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    ...
    mMediaSession = new MediaSessionCompat(this, LOG_TAG);
    mMediaSessionConnector = new MediaSessionConnector(mMediaSession);
    ...
  }

  @Override
  protected void onStart() {
    ...
    mMediaManager = receiverContext.getMediaManager();
    mMediaManager.setSessionCompatToken(currentMediaSession.getSessionToken());

    mMediaSessionConnector.setPlayer(mExoPlayer);
    mMediaSessionConnector.setMediaMetadataProvider(mMediaMetadataProvider);
    mMediaSession.setActive(true);
    ...
  }

  @Override
  protected void onStop() {
    ...
    mMediaSessionConnector.setPlayer(null);
    mMediaSession.release();
    mMediaManager.setSessionCompatToken(null);
    ...
  }
}

การตั้งค่าแอปผู้ส่ง

เปิดใช้การรองรับ Cast Connect

เมื่อคุณอัปเดตแอปผู้ส่งด้วยการสนับสนุน Cast Connect แล้ว คุณสามารถประกาศ ความพร้อมของตนเองโดยการกำหนด androidReceiverCompatible แจ้งว่าไม่เหมาะสม LaunchOptions เป็นจริง

Android

ต้องใช้ play-services-cast-framework เวอร์ชัน 19.0.0 ขึ้นไป

มีการตั้งค่า Flag androidReceiverCompatible ใน LaunchOptions (ซึ่งเป็นส่วนหนึ่งของ CastOptions):

Kotlin

วันที่

class CastOptionsProvider : OptionsProvider {
  override fun getCastOptions(context: Context?): CastOptions {
    val launchOptions: LaunchOptions = Builder()
          .setAndroidReceiverCompatible(true)
          .build()
    return CastOptions.Builder()
          .setLaunchOptions(launchOptions)
          ...
          .build()
    }
}

Java

วันที่

public class CastOptionsProvider implements OptionsProvider {
  @Override
  public CastOptions getCastOptions(Context context) {
    LaunchOptions launchOptions = new LaunchOptions.Builder()
              .setAndroidReceiverCompatible(true)
              .build();
    return new CastOptions.Builder()
        .setLaunchOptions(launchOptions)
        ...
        .build();
  }
}

iOS

ต้องใช้ google-cast-sdk เวอร์ชัน v4.4.8 หรือ สูงขึ้น

มีการตั้งค่า Flag androidReceiverCompatible ใน GCKLaunchOptions (ซึ่งเป็นส่วนหนึ่งของ GCKCastOptions)

let options = GCKCastOptions(discoveryCriteria: GCKDiscoveryCriteria(applicationID: kReceiverAppID))
...
let launchOptions = GCKLaunchOptions()
launchOptions.androidReceiverCompatible = true
options.launchOptions = launchOptions
GCKCastContext.setSharedInstanceWith(options)

เว็บ

ต้องใช้เวอร์ชันเบราว์เซอร์ Chromium M87 ขึ้นไป

const context = cast.framework.CastContext.getInstance();
const castOptions = new cast.framework.CastOptions();
castOptions.receiverApplicationId = kReceiverAppID;
castOptions.androidReceiverCompatible = true;
context.setOptions(castOptions);

การตั้งค่า Cast Developer Console

กำหนดค่าแอป Android TV

เพิ่มชื่อแพ็กเกจของแอป Android TV ใน คอนโซลของนักพัฒนาซอฟต์แวร์ Cast เพื่อเชื่อมโยงกับรหัสแอปแคสต์

ลงทะเบียนอุปกรณ์ของนักพัฒนาซอฟต์แวร์

ลงทะเบียนหมายเลขซีเรียลของอุปกรณ์ Android TV ที่คุณจะใช้ สำหรับการพัฒนาใน Cast Developer Console

หมายเหตุ: อุปกรณ์ Android TV (ATV) มี หมายเลขซีเรียลที่เกี่ยวข้อง คุณต้องใช้ซอฟต์แวร์ของอุปกรณ์ ATV (Cast) หมายเลขซีเรียล ดูการพิจารณา หมายเลขซีเรียลของอุปกรณ์ ATV เพื่อดูรายละเอียดวิธีค้นหาอุปกรณ์

หากไม่ได้ลงทะเบียน Cast Connect จะใช้งานได้เฉพาะกับแอปที่ติดตั้งจาก Google Play Store เนื่องจากเหตุผลด้านความปลอดภัย

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการลงทะเบียนอุปกรณ์แคสต์หรือ Android TV สำหรับแคสต์ สำหรับการพัฒนา ให้ดูที่หน้าการลงทะเบียน

กำลังโหลดสื่อ

หากคุณใช้งานการสนับสนุน Deep Link ในแอป Android TV แล้ว ให้ทำดังนี้ คุณควรกำหนดค่าคำจำกัดความที่คล้ายกันไว้ในไฟล์ Manifest ของ Android TV ดังนี้

<activity android:name="com.example.activity">
  <intent-filter>
     <action android:name="android.intent.action.VIEW" />
     <category android:name="android.intent.category.DEFAULT" />
     <data android:scheme="https"/>
     <data android:host="www.example.com"/>
     <data android:pathPattern=".*"/>
  </intent-filter>
</activity>

โหลดตามเอนทิตีของผู้ส่ง

ในผู้ส่ง คุณสามารถส่งผ่าน Deep Link โดยการตั้งค่า entity ในสื่อ ข้อมูลสำหรับคำขอโหลด:

Kotlin

วันที่

val mediaToLoad = MediaInfo.Builder("some-id")
    .setEntity("https://example.com/watch/some-id")
    ...
    .build()
val loadRequest = MediaLoadRequestData.Builder()
    .setMediaInfo(mediaToLoad)
    .setCredentials("user-credentials")
    ...
    .build()
remoteMediaClient.load(loadRequest)

Android

Java

วันที่

MediaInfo mediaToLoad =
    new MediaInfo.Builder("some-id")
        .setEntity("https://example.com/watch/some-id")
        ...
        .build();
MediaLoadRequestData loadRequest =
    new MediaLoadRequestData.Builder()
        .setMediaInfo(mediaToLoad)
        .setCredentials("user-credentials")
        ...
        .build();
remoteMediaClient.load(loadRequest);

iOS

วันที่

let mediaInfoBuilder = GCKMediaInformationBuilder(entity: "https://example.com/watch/some-id")
...
mediaInformation = mediaInfoBuilder.build()

let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder()
mediaLoadRequestDataBuilder.mediaInformation = mediaInformation
mediaLoadRequestDataBuilder.credentials = "user-credentials"
...
let mediaLoadRequestData = mediaLoadRequestDataBuilder.build()

remoteMediaClient?.loadMedia(with: mediaLoadRequestData)

เว็บ

ต้องใช้เวอร์ชันเบราว์เซอร์ Chromium M87 ขึ้นไป

let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4');
mediaInfo.entity = 'https://example.com/watch/some-id';
...

let request = new chrome.cast.media.LoadRequest(mediaInfo);
request.credentials = 'user-credentials';
...

cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);

คำสั่งโหลดจะส่งผ่าน Intent ที่มี Deep Link และชื่อแพ็กเกจ ที่คุณกำหนดไว้ใน Developer Console

การตั้งค่าข้อมูลเข้าสู่ระบบ ATV ที่ผู้ส่ง

อาจเป็นไปได้ว่าแอป Web Receiver และแอป Android TV ของคุณรองรับแตกต่างกัน Deep Link และ credentials (เช่น หากคุณกำลังจัดการการตรวจสอบสิทธิ์ แตกต่างกันใน 2 แพลตฟอร์ม) เพื่อแก้ปัญหานี้ คุณสามารถระบุ entity และ credentials สำหรับ Android TV:

Android

Kotlin

วันที่

val mediaToLoad = MediaInfo.Builder("some-id")
        .setEntity("https://example.com/watch/some-id")
        .setAtvEntity("myscheme://example.com/atv/some-id")
        ...
        .build()
val loadRequest = MediaLoadRequestData.Builder()
        .setMediaInfo(mediaToLoad)
        .setCredentials("user-credentials")
        .setAtvCredentials("atv-user-credentials")
        ...
        .build()
remoteMediaClient.load(loadRequest)

Java

วันที่

MediaInfo mediaToLoad =
    new MediaInfo.Builder("some-id")
        .setEntity("https://example.com/watch/some-id")
        .setAtvEntity("myscheme://example.com/atv/some-id")
        ...
        .build();
MediaLoadRequestData loadRequest =
    new MediaLoadRequestData.Builder()
        .setMediaInfo(mediaToLoad)
        .setCredentials("user-credentials")
        .setAtvCredentials("atv-user-credentials")
        ...
        .build();
remoteMediaClient.load(loadRequest);

iOS

วันที่

let mediaInfoBuilder = GCKMediaInformationBuilder(entity: "https://example.com/watch/some-id")
mediaInfoBuilder.atvEntity = "myscheme://example.com/atv/some-id"
...
mediaInformation = mediaInfoBuilder.build()

let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder()
mediaLoadRequestDataBuilder.mediaInformation = mediaInformation
mediaLoadRequestDataBuilder.credentials = "user-credentials"
mediaLoadRequestDataBuilder.atvCredentials = "atv-user-credentials"
...
let mediaLoadRequestData = mediaLoadRequestDataBuilder.build()

remoteMediaClient?.loadMedia(with: mediaLoadRequestData)

เว็บ

ต้องใช้เวอร์ชันเบราว์เซอร์ Chromium M87 ขึ้นไป

let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4');
mediaInfo.entity = 'https://example.com/watch/some-id';
mediaInfo.atvEntity = 'myscheme://example.com/atv/some-id';
...

let request = new chrome.cast.media.LoadRequest(mediaInfo);
request.credentials = 'user-credentials';
request.atvCredentials = 'atv-user-credentials';
...

cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);

หากเปิดแอปตัวรับเว็บแล้ว แอปจะใช้ entity และ credentials ใน คำขอโหลด อย่างไรก็ตาม หากแอป Android TV เปิดขึ้น ระบบจะลบล้าง SDK นั้น entity และ credentials พร้อม atvEntity และ atvCredentials ของคุณ (หากระบุ)

การโหลดตาม Content ID หรือ MediaQueueData

หากคุณไม่ได้ใช้ entity หรือ atvEntity และกำลังใช้ Content ID หรือ URL ของเนื้อหาในข้อมูลสื่อของคุณหรือใช้การโหลดสื่อที่ละเอียดมากขึ้น ขอข้อมูล คุณต้องเพิ่มตัวกรอง Intent ที่กำหนดไว้ล่วงหน้าต่อไปนี้ใน ในแอป Android TV

<activity android:name="com.example.activity">
  <intent-filter>
     <action android:name="com.google.android.gms.cast.tv.action.LOAD"/>
     <category android:name="android.intent.category.DEFAULT" />
  </intent-filter>
</activity>

ทางด้านผู้ส่งคล้ายกับ load byentity คุณจะ สามารถสร้างคำขอโหลดด้วยข้อมูลเนื้อหาของคุณและเรียกใช้ load()

Android

Kotlin

วันที่

val mediaToLoad = MediaInfo.Builder("some-id").build()
val loadRequest = MediaLoadRequestData.Builder()
    .setMediaInfo(mediaToLoad)
    .setCredentials("user-credentials")
    ...
    .build()
remoteMediaClient.load(loadRequest)

Java

วันที่

MediaInfo mediaToLoad =
    new MediaInfo.Builder("some-id").build();
MediaLoadRequestData loadRequest =
    new MediaLoadRequestData.Builder()
        .setMediaInfo(mediaToLoad)
        .setCredentials("user-credentials")
        ...
        .build();
remoteMediaClient.load(loadRequest);

iOS

วันที่

let mediaInfoBuilder = GCKMediaInformationBuilder(contentId: "some-id")
...
mediaInformation = mediaInfoBuilder.build()

let mediaLoadRequestDataBuilder = GCKMediaLoadRequestDataBuilder()
mediaLoadRequestDataBuilder.mediaInformation = mediaInformation
mediaLoadRequestDataBuilder.credentials = "user-credentials"
...
let mediaLoadRequestData = mediaLoadRequestDataBuilder.build()

remoteMediaClient?.loadMedia(with: mediaLoadRequestData)

เว็บ

ต้องใช้เวอร์ชันเบราว์เซอร์ Chromium M87 ขึ้นไป

let mediaInfo = new chrome.cast.media.MediaInfo('some-id"', 'video/mp4');
...

let request = new chrome.cast.media.LoadRequest(mediaInfo);
...

cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request);

การจัดการคำขอโหลด

ในกิจกรรมของคุณ คุณจะต้องจัดการ Intent ต่างๆ เพื่อจัดการคำขอโหลดเหล่านี้ ใน Callback ของวงจรกิจกรรม

Kotlin

วันที่

class MyActivity : Activity() {
  override fun onStart() {
    super.onStart()
    val mediaManager = CastReceiverContext.getInstance().getMediaManager()
    // Pass the intent to the SDK. You can also do this in onCreate().
    if (mediaManager.onNewIntent(intent)) {
        // If the SDK recognizes the intent, you should early return.
        return
    }
    // If the SDK doesn't recognize the intent, you can handle the intent with
    // your own logic.
    ...
  }

  // For some cases, a new load intent triggers onNewIntent() instead of
  // onStart().
  override fun onNewIntent(intent: Intent) {
    val mediaManager = CastReceiverContext.getInstance().getMediaManager()
    // Pass the intent to the SDK. You can also do this in onCreate().
    if (mediaManager.onNewIntent(intent)) {
        // If the SDK recognizes the intent, you should early return.
        return
    }
    // If the SDK doesn't recognize the intent, you can handle the intent with
    // your own logic.
    ...
  }
}

Java

public class MyActivity extends Activity {
  @Override
  protected void onStart() {
    super.onStart();
    MediaManager mediaManager =
        CastReceiverContext.getInstance().getMediaManager();
    // Pass the intent to the SDK. You can also do this in onCreate().
    if (mediaManager.onNewIntent(getIntent())) {
      // If the SDK recognizes the intent, you should early return.
      return;
    }
    // If the SDK doesn't recognize the intent, you can handle the intent with
    // your own logic.
    ...
  }

  // For some cases, a new load intent triggers onNewIntent() instead of
  // onStart().
  @Override
  protected void onNewIntent(Intent intent) {
    MediaManager mediaManager =
        CastReceiverContext.getInstance().getMediaManager();
    // Pass the intent to the SDK. You can also do this in onCreate().
    if (mediaManager.onNewIntent(intent)) {
      // If the SDK recognizes the intent, you should early return.
      return;
    }
    // If the SDK doesn't recognize the intent, you can handle the intent with
    // your own logic.
    ...
  }
}

หากเป็น MediaManager ตรวจพบว่า Intent เป็นการโหลด และแยก MediaLoadRequestData จาก Intent แล้วเรียกใช้ MediaLoadCommandCallback.onLoad() คุณต้องลบล้างเมธอดนี้เพื่อจัดการคำขอโหลด การเรียกกลับต้อง ลงทะเบียนก่อน MediaManager.onNewIntent() เรียกว่า (แนะนำให้อยู่ในกิจกรรมหรือแอปพลิเคชัน onCreate() )

Kotlin

วันที่

class MyActivity : Activity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val mediaManager = CastReceiverContext.getInstance().getMediaManager()
        mediaManager.setMediaLoadCommandCallback(MyMediaLoadCommandCallback())
    }
}

class MyMediaLoadCommandCallback : MediaLoadCommandCallback() {
  override fun onLoad(
        senderId: String?,
        loadRequestData: MediaLoadRequestData
  ): Task {
      return Tasks.call {
        // Resolve the entity into your data structure and load media.
        val mediaInfo = loadRequestData.getMediaInfo()
        if (!checkMediaInfoSupported(mediaInfo)) {
            // Throw MediaException to indicate load failure.
            throw MediaException(
                MediaError.Builder()
                    .setDetailedErrorCode(DetailedErrorCode.LOAD_FAILED)
                    .setReason(MediaError.ERROR_REASON_INVALID_REQUEST)
                    .build()
            )
        }
        myFillMediaInfo(MediaInfoWriter(mediaInfo))
        myPlayerLoad(mediaInfo.getContentUrl())

        // Update media metadata and state (this clears all previous status
        // overrides).
        castReceiverContext.getMediaManager()
            .setDataFromLoad(loadRequestData)
        ...
        castReceiverContext.getMediaManager().broadcastMediaStatus()

        // Return the resolved MediaLoadRequestData to indicate load success.
        return loadRequestData
     }
  }

  private fun myPlayerLoad(contentURL: String) {
    myPlayer.load(contentURL)

    // Update the MediaSession state.
    val playbackState: PlaybackStateCompat = Builder()
        .setState(
            player.getState(), player.getPosition(), System.currentTimeMillis()
        )
        ...
        .build()
    mediaSession.setPlaybackState(playbackState)
  }

Java

public class MyActivity extends Activity {
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    MediaManager mediaManager =
        CastReceiverContext.getInstance().getMediaManager();
    mediaManager.setMediaLoadCommandCallback(new MyMediaLoadCommandCallback());
  }
}

public class MyMediaLoadCommandCallback extends MediaLoadCommandCallback {
  @Override
  public Task onLoad(String senderId, MediaLoadRequestData loadRequestData) {
    return Tasks.call(() -> {
        // Resolve the entity into your data structure and load media.
        MediaInfo mediaInfo = loadRequestData.getMediaInfo();
        if (!checkMediaInfoSupported(mediaInfo)) {
          // Throw MediaException to indicate load failure.
          throw new MediaException(
              new MediaError.Builder()
                  .setDetailedErrorCode(DetailedErrorCode.LOAD_FAILED)
                  .setReason(MediaError.ERROR_REASON_INVALID_REQUEST)
                  .build());
        }
        myFillMediaInfo(new MediaInfoWriter(mediaInfo));
        myPlayerLoad(mediaInfo.getContentUrl());

        // Update media metadata and state (this clears all previous status
        // overrides).
        castReceiverContext.getMediaManager()
            .setDataFromLoad(loadRequestData);
        ...
        castReceiverContext.getMediaManager().broadcastMediaStatus();

        // Return the resolved MediaLoadRequestData to indicate load success.
        return loadRequestData;
    });
}

private void myPlayerLoad(String contentURL) {
  myPlayer.load(contentURL);

  // Update the MediaSession state.
  PlaybackStateCompat playbackState =
      new PlaybackStateCompat.Builder()
          .setState(
              player.getState(), player.getPosition(), System.currentTimeMillis())
          ...
          .build();
  mediaSession.setPlaybackState(playbackState);
}

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

คำสั่งสื่อที่รองรับ

การสนับสนุนการควบคุมการเล่นขั้นพื้นฐาน

คำสั่งการผสานรวมพื้นฐานรวมถึงคำสั่งที่เข้ากันได้กับสื่อ เซสชัน คำสั่งเหล่านี้จะได้รับการแจ้งเตือนผ่าน Callback ของเซสชันสื่อ สิ่งที่คุณต้องทำ ลงทะเบียน Callback ไปยังเซสชันสื่อเพื่อรองรับการดำเนินการดังกล่าว (คุณอาจต้องดำเนินการ อยู่แล้ว)

Kotlin

วันที่

private class MyMediaSessionCallback : MediaSessionCompat.Callback() {
  override fun onPause() {
    // Pause the player and update the play state.
    myPlayer.pause()
  }

  override fun onPlay() {
    // Resume the player and update the play state.
    myPlayer.play()
  }

  override fun onSeekTo(pos: Long) {
    // Seek and update the play state.
    myPlayer.seekTo(pos)
  }
    ...
 }

mediaSession.setCallback(MyMediaSessionCallback())

Java

private class MyMediaSessionCallback extends MediaSessionCompat.Callback {
  @Override
  public void onPause() {
    // Pause the player and update the play state.
    myPlayer.pause();
  }
  @Override
  public void onPlay() {
    // Resume the player and update the play state.
    myPlayer.play();
  }
  @Override
  public void onSeekTo(long pos) {
    // Seek and update the play state.
    myPlayer.seekTo(pos);
  }

  ...
}

mediaSession.setCallback(new MyMediaSessionCallback());

การรองรับคำสั่งควบคุมการแคสต์

มีคำสั่งแคสต์บางอย่างไม่พร้อมใช้งานใน MediaSession เช่น skipAd() หรือ setActiveMediaTracks() นอกจากนี้ คำสั่งคิวบางรายการต้องนำมาใช้ที่นี่เพราะคิวการแคสต์ ไม่สามารถใช้งานร่วมกับคิว MediaSession ได้อย่างสมบูรณ์

Kotlin

วันที่

class MyMediaCommandCallback : MediaCommandCallback() {
    override fun onSkipAd(requestData: RequestData?): Task {
        // Skip your ad
        ...
        return Tasks.forResult(null)
    }
}

val mediaManager = CastReceiverContext.getInstance().getMediaManager()
mediaManager.setMediaCommandCallback(MyMediaCommandCallback())

Java

public class MyMediaCommandCallback extends MediaCommandCallback {
  @Override
  public Task onSkipAd(RequestData requestData) {
    // Skip your ad
    ...
    return Tasks.forResult(null);
  }
}

MediaManager mediaManager =
    CastReceiverContext.getInstance().getMediaManager();
mediaManager.setMediaCommandCallback(new MyMediaCommandCallback());

ระบุคำสั่งสื่อที่รองรับ

เช่นเดียวกับตัวรับการแคสต์ แอป Android TV ควรระบุคำสั่ง ดังนั้นผู้ส่งจึงสามารถเปิดใช้หรือปิดใช้การควบคุม UI บางอย่างได้ สำหรับ คำสั่งที่เป็นส่วนหนึ่งของ MediaSession ระบุคําสั่งใน PlaybackStateCompat ควรระบุคำสั่งเพิ่มเติมใน MediaStatusModifier

Kotlin

วันที่

// Set media session supported commands
val playbackState: PlaybackStateCompat = PlaybackStateCompat.Builder()
    .setActions(PlaybackStateCompat.ACTION_PLAY or PlaybackStateCompat.ACTION_PAUSE)
    .setState(PlaybackStateCompat.STATE_PLAYING)
    .build()

mediaSession.setPlaybackState(playbackState)

// Set additional commands in MediaStatusModifier
val mediaManager = CastReceiverContext.getInstance().getMediaManager()
mediaManager.getMediaStatusModifier()
    .setMediaCommandSupported(MediaStatus.COMMAND_QUEUE_NEXT)

Java

// Set media session supported commands
PlaybackStateCompat playbackState =
    new PlaybackStateCompat.Builder()
        .setActions(PlaybackStateCompat.ACTION_PLAY | PlaybackStateCompat.ACTION_PAUSE)
        .setState(PlaybackStateCompat.STATE_PLAYING)
        .build();

mediaSession.setPlaybackState(playbackState);

// Set additional commands in MediaStatusModifier
MediaManager mediaManager = CastReceiverContext.getInstance().getMediaManager();
mediaManager.getMediaStatusModifier()
            .setMediaCommandSupported(MediaStatus.COMMAND_QUEUE_NEXT);

ซ่อนปุ่มที่ไม่รองรับ

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

การแก้ไข MediaStatus

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

เรามี MediaStatusModifier ในชั้นเพื่อให้บรรลุเป้าหมายนี้ MediaStatusModifier จะดำเนินการใน MediaSessionซึ่งคุณได้ตั้งค่าไว้ใน CastReceiverContext

เพื่อสร้างและเผยแพร่ MediaStatus

Kotlin

วันที่

val mediaManager: MediaManager = castReceiverContext.getMediaManager()
val statusModifier: MediaStatusModifier = mediaManager.getMediaStatusModifier()

statusModifier
    .setLiveSeekableRange(seekableRange)
    .setAdBreakStatus(adBreakStatus)
    .setCustomData(customData)

mediaManager.broadcastMediaStatus()

Java

MediaManager mediaManager = castReceiverContext.getMediaManager();
MediaStatusModifier statusModifier = mediaManager.getMediaStatusModifier();

statusModifier
    .setLiveSeekableRange(seekableRange)
    .setAdBreakStatus(adBreakStatus)
    .setCustomData(customData);

mediaManager.broadcastMediaStatus();

ไลบรารีของไคลเอ็นต์ของเราจะได้รับ MediaStatus พื้นฐานจาก MediaSession ซึ่งเป็น แอป Android TV สามารถระบุสถานะเพิ่มเติมและสถานะการลบล้างผ่าน แป้นกดร่วม MediaStatus

บางรัฐและข้อมูลเมตาสามารถตั้งค่าได้ทั้งใน MediaSession และ MediaStatusModifier เราขอแนะนำอย่างยิ่งให้คุณตั้งค่าเฉพาะ MediaSession คุณยังสามารถใช้แป้นกดร่วมเพื่อลบล้างสถานะใน MediaSession - ไม่สนับสนุนให้ทำเช่นนี้เนื่องจากสถานะในตัวแก้ไขจะแสดงเสมอ มีลำดับความสำคัญสูงกว่าค่าที่ระบุโดย MediaSession

หมายเหตุ: คุณต้องโทร broadcastMediaStatus() เมื่อคุณเปลี่ยนแปลงหรืออัปเดต MediaStatusModifier การเปลี่ยนแปลงเป็น ระบบจะประกาศ MediaSession โดยอัตโนมัติ

การสกัดกั้น MediaStatus ก่อนส่ง

เช่นเดียวกับ Web Receiver SDK หากคุณต้องการปรับแต่งเล็กน้อยก่อน การส่งออก คุณสามารถระบุ MediaStatusInterceptor เพื่อประมวลผล MediaStatus ถึง ส่งไป เราให้คะแนนใน MediaStatusWriter เพื่อจัดการ MediaStatus ก่อนที่จะส่งออก

Kotlin

วันที่

mediaManager.setMediaStatusInterceptor(object : MediaStatusInterceptor {
    override fun intercept(mediaStatusWriter: MediaStatusWriter) {
      // Perform customization.
        mediaStatusWriter.setCustomData(JSONObject("{data: \"my Hello\"}"))
    }
})

Java

mediaManager.setMediaStatusInterceptor(new MediaStatusInterceptor() {
    @Override
    public void intercept(MediaStatusWriter mediaStatusWriter) {
        // Perform customization.
        mediaStatusWriter.setCustomData(new JSONObject("{data: \"my Hello\"}"));
    }
});

การจัดการข้อมูลเข้าสู่ระบบของผู้ใช้

แอป Android TV อาจอนุญาตให้เฉพาะผู้ใช้บางรายเปิดหรือเข้าร่วมแอป เซสชัน ตัวอย่างเช่น อนุญาตให้ผู้ส่งเปิดใช้หรือเข้าร่วมได้ในกรณีต่อไปนี้เท่านั้น

• แอปผู้ส่งเข้าสู่ระบบบัญชีและโปรไฟล์เดียวกันกับแอป ATV
• แอปผู้ส่งเข้าสู่ระบบบัญชีเดียวกัน แต่เข้าสู่ระบบคนละโปรไฟล์กับแอป ATV

หากแอปของคุณสามารถรองรับผู้ใช้หลายคนหรือผู้ใช้ที่ไม่ระบุตัว คุณสามารถอนุญาต ผู้ใช้ให้เข้าร่วมเซสชัน ATV หากผู้ใช้ระบุข้อมูลเข้าสู่ระบบ แอป ATV ของคุณ ต้องจัดการข้อมูลเข้าสู่ระบบของตนเองเพื่อให้ความคืบหน้าและข้อมูลอื่นๆ ของผู้ใช้ อย่างเหมาะสม

เมื่อแอปผู้ส่งเปิดตัวหรือเข้าร่วมแอป Android TV แอปผู้ส่งของคุณ ควรระบุข้อมูลเข้าสู่ระบบที่แสดงถึงผู้ที่เข้าร่วมเซสชัน

ก่อนที่ผู้ส่งจะเปิดตัวและเข้าร่วมแอป Android TV คุณสามารถระบุ เปิดตัวตรวจสอบเพื่อดูว่าข้อมูลเข้าสู่ระบบของผู้ส่งได้รับอนุญาตหรือไม่ หากไม่ หน้าจอแคสต์ Connect SDK กลับไปเปิดตัวเว็บรีซีฟเวอร์ของคุณ

ข้อมูลเข้าสู่ระบบการเปิดใช้แอปผู้ส่ง

ทางฝั่งผู้ส่ง คุณสามารถระบุ CredentialsData เพื่อแสดงถึงใครได้ การเข้าร่วมเซสชัน

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

ระบบจะส่งCredentialsDataไปยังแอป Android TV ระหว่างการเปิดตัวเท่านั้น หรือ เวลาที่เข้าร่วม หากคุณตั้งรหัสอีกครั้งขณะเชื่อมต่อ ระบบจะไม่ส่งข้อมูลนี้ไปยัง แอป Android TV ของคุณ ถ้าผู้ส่งสลับโปรไฟล์ขณะที่เชื่อมต่อ สามารถอยู่ในเซสชันต่อไป หรือ SessionManager.endCurrentCastSession(boolean stopCasting) หากคิดว่าโปรไฟล์ใหม่ใช้ร่วมกับเซสชันไม่ได้

CredentialsData สามารถดึงข้อมูลของผู้ส่งแต่ละรายได้โดยใช้ getSenders ใน CastReceiverContext เพื่อรับSenderInfo getCastLaunchRequest() เพื่อรับ CastLaunchRequest จากนั้น getCredentialsData()

Android

ต้องใช้ play-services-cast-framework เวอร์ชัน 19.0.0 ขึ้นไป

Kotlin

วันที่

CastContext.getSharedInstance().setLaunchCredentialsData(
    CredentialsData.Builder()
        .setCredentials("{\"userId\": \"abc\"}")
        .build()
)

Java

วันที่

CastContext.getSharedInstance().setLaunchCredentialsData(
    new CredentialsData.Builder()
        .setCredentials("{\"userId\": \"abc\"}")
        .build());

iOS

ต้องใช้ google-cast-sdk เวอร์ชัน v4.8.1 หรือ สูงขึ้น

คุณจะโทรติดต่อได้ทุกเมื่อหลังจากตั้งค่าตัวเลือกแล้ว ดังนี้ GCKCastContext.setSharedInstanceWith(options)

GCKCastContext.sharedInstance().setLaunch(
    GCKCredentialsData(credentials: "{\"userId\": \"abc\"}")

เว็บ

ต้องใช้เวอร์ชันเบราว์เซอร์ Chromium M87 ขึ้นไป

คุณจะโทรติดต่อได้ทุกเมื่อหลังจากตั้งค่าตัวเลือกแล้ว ดังนี้ cast.framework.CastContext.getInstance().setOptions(options);

let credentialsData =
    new chrome.cast.CredentialsData("{\"userId\": \"abc\"}");
cast.framework.CastContext.getInstance().setLaunchCredentialsData(credentialsData);

การใช้เครื่องมือตรวจสอบคำขอเปิดใช้งาน ATV

CredentialsData จะส่งไปยังแอป Android TV เมื่อผู้ส่งพยายามเปิดหรือเข้าร่วม คุณสามารถ ใช้ LaunchRequestChecker เพื่ออนุญาตหรือปฏิเสธคำขอนี้

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

หากอนุญาตคำขอ แอป ATV จะเปิดขึ้น คุณปรับแต่งการตั้งค่านี้ได้ ลักษณะการทำงานโดยขึ้นอยู่กับว่าแอปของคุณรองรับการส่งคำขอโหลดเมื่อผู้ใช้หรือไม่ ไม่ได้เข้าสู่ระบบแอป ATV หรือหากมีผู้ใช้ไม่ตรงกัน ลักษณะการทำงานนี้ รองรับลูกค้าได้อย่างเต็มรูปแบบใน LaunchRequestChecker

สร้างชั้นเรียนที่ใช้ CastReceiverOptions.LaunchRequestChecker อินเทอร์เฟซ:

Kotlin

วันที่

class MyLaunchRequestChecker : LaunchRequestChecker {
  override fun checkLaunchRequestSupported(launchRequest: CastLaunchRequest): Task {
    return Tasks.call {
      myCheckLaunchRequest(
           launchRequest
      )
    }
  }
}

private fun myCheckLaunchRequest(launchRequest: CastLaunchRequest): Boolean {
  val credentialsData = launchRequest.getCredentialsData()
     ?: return false // or true if you allow anonymous users to join.

  // The request comes from a mobile device, e.g. checking user match.
  return if (credentialsData.credentialsType == CredentialsData.CREDENTIALS_TYPE_ANDROID) {
     myCheckMobileCredentialsAllowed(credentialsData.getCredentials())
  } else false // Unrecognized credentials type.
}

Java

public class MyLaunchRequestChecker
    implements CastReceiverOptions.LaunchRequestChecker {
  @Override
  public Task checkLaunchRequestSupported(CastLaunchRequest launchRequest) {
    return Tasks.call(() -> myCheckLaunchRequest(launchRequest));
  }
}

private boolean myCheckLaunchRequest(CastLaunchRequest launchRequest) {
  CredentialsData credentialsData = launchRequest.getCredentialsData();
  if (credentialsData == null) {
    return false;  // or true if you allow anonymous users to join.
  }

  // The request comes from a mobile device, e.g. checking user match.
  if (credentialsData.getCredentialsType().equals(CredentialsData.CREDENTIALS_TYPE_ANDROID)) {
    return myCheckMobileCredentialsAllowed(credentialsData.getCredentials());
  }

  // Unrecognized credentials type.
  return false;
}

จากนั้นตั้งค่าใน ReceiverOptionsProvider

Kotlin

วันที่

class MyReceiverOptionsProvider : ReceiverOptionsProvider {
  override fun getOptions(context: Context?): CastReceiverOptions {
    return CastReceiverOptions.Builder(context)
        ...
        .setLaunchRequestChecker(MyLaunchRequestChecker())
        .build()
  }
}

Java

public class MyReceiverOptionsProvider implements ReceiverOptionsProvider {
  @Override
  public CastReceiverOptions getOptions(Context context) {
    return new CastReceiverOptions.Builder(context)
        ...
        .setLaunchRequestChecker(new MyLaunchRequestChecker())
        .build();
  }
}

กำลังแก้ปัญหา true ใน LaunchRequestChecker เปิดแอป ATV และ false เปิดแอป Web Receiver ของคุณ

กำลังส่งและ การรับข้อความที่กำหนดเอง

โปรโตคอล Cast ช่วยให้คุณส่งข้อความสตริงที่กำหนดเองระหว่างผู้ส่งกับ แอปพลิเคชันตัวรับสัญญาณของคุณ คุณต้องลงทะเบียนเนมสเปซ (ช่อง) เพื่อส่ง ก่อนเริ่มต้น CastReceiverContext

Android TV - ระบุเนมสเปซที่กำหนดเอง

คุณต้องระบุเนมสเปซที่รองรับใน CastReceiverOptions ระหว่างการตั้งค่า

Kotlin

วันที่

class MyReceiverOptionsProvider : ReceiverOptionsProvider {
  override fun getOptions(context: Context?): CastReceiverOptions {
    return CastReceiverOptions.Builder(context)
        .setCustomNamespaces(
            Arrays.asList("urn:x-cast:com.example.cast.mynamespace")
        )
        .build()
  }
}

Java

วันที่

public class MyReceiverOptionsProvider implements ReceiverOptionsProvider {
  @Override
  public CastReceiverOptions getOptions(Context context) {
    return new CastReceiverOptions.Builder(context)
        .setCustomNamespaces(
              Arrays.asList("urn:x-cast:com.example.cast.mynamespace"))
        .build();
  }
}

หมายเหตุ: เนมสเปซที่ต้องขึ้นต้นด้วย urn:x-cast: นำหน้า

Android TV - การส่งข้อความ

Kotlin

วันที่

// If senderId is null, then the message is broadcasted to all senders.
CastReceiverContext.getInstance().sendMessage(
    "urn:x-cast:com.example.cast.mynamespace", senderId, customString)

Java

// If senderId is null, then the message is broadcasted to all senders.
CastReceiverContext.getInstance().sendMessage(
    "urn:x-cast:com.example.cast.mynamespace", senderId, customString);

Android TV - รับข้อความเนมสเปซที่กำหนดเอง

Kotlin

วันที่

class MyCustomMessageListener : MessageReceivedListener {
    override fun onMessageReceived(
        namespace: String, senderId: String?, message: String ) {
        ...
    }
}

CastReceiverContext.getInstance().setMessageReceivedListener(
    "urn:x-cast:com.example.cast.mynamespace", new MyCustomMessageListener());

Java

class MyCustomMessageListener implements CastReceiverContext.MessageReceivedListener {
  @Override
  public void onMessageReceived(
      String namespace, String senderId, String message) {
    ...
  }
}

CastReceiverContext.getInstance().setMessageReceivedListener(
    "urn:x-cast:com.example.cast.mynamespace", new MyCustomMessageListener());