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

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

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

• บทแนะนำ Cast 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 จะมีไฟล์build.gradle ระดับบนสุดและไฟล์build.gradle สำหรับแต่ละโมดูล อย่าลืมแก้ไขไฟล์สำหรับโมดูลแอปพลิเคชัน ดูข้อมูลเพิ่มเติมเกี่ยวกับ Gradle ได้ที่ การสร้างโปรเจ็กต์ด้วย Gradle
2. ยืนยันว่า google() รวมอยู่ใน repositories ที่ระบุ

     repositories {
       google()
     }

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

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

   • สำหรับแอป Android Sender:

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

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

iOS

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

     platform: ios, '13'
   
     def target_pods
        pod 'google-cast-sdk', '~>4.8.0'
     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()	ตั้งสถานะการเล่น

คอตลิน

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);
}

การจัดการการควบคุมการขนส่ง

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

MediaSessionCompat.Callback

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

คอตลิน

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());

การกำหนดค่าการรองรับ Cast

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

การตั้งค่า Android TV

การเพิ่มตัวกรองความตั้งใจในการเปิดตัว

เพิ่มตัวกรอง 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:

คอตลิน

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 เมื่อสร้างแอป ดังนี้

คอตลิน

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

  ...
}

Java

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

  ...
}

เริ่มต้น CastReceiverContext เมื่อแอปย้ายไปอยู่เบื้องหน้า

คอตลิน

CastReceiverContext.getInstance().start()

Java

CastReceiverContext.getInstance().start();

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

คอตลิน

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

Java

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

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

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

คอตลิน

// 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 ด้วยเพื่อให้ทราบถึงตำแหน่งที่จะส่งคำสั่งและเรียกข้อมูลสถานะการเล่นสื่อ ดังนี้

คอตลิน

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

Java

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

เมื่อปล่อย MediaSession เนื่องจากไม่มีการใช้งานเล่น คุณควรตั้งค่าโทเค็นค่า Null ใน MediaManager:

คอตลิน

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

Java

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

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

คอตลิน

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 ในแอปของคุณ ให้เพิ่มรายการต่อไปนี้ลงในคลาสกิจกรรมของโปรแกรมเล่นวิดีโอหรือที่ใดก็ตามที่คุณจัดการเซสชันสื่อ ดังนี้

คอตลิน

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 ขึ้นไป

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

คอตลิน

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 ขึ้นไป

มีการตั้งค่าแฟล็ก 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 Developer Console เพื่อเชื่อมโยงกับรหัสแอป Cast

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

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

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

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

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

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

หากคุณใช้การสนับสนุน 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 ในข้อมูลสื่อสำหรับคำขอโหลด ดังนี้

คอตลิน

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

โคทลิน

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() ได้เช่นเดียวกับ load byentity

Android

โคทลิน

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 ในการเรียกกลับของวงจรกิจกรรม

คอตลิน

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

คอตลิน

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);
}

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

การรองรับคำสั่งสื่อ

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

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

คอตลิน

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());

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

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

คอตลิน

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

คอตลิน

// 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 รองรับการควบคุมสื่อขั้นพื้นฐานเท่านั้น แต่แอป Web Receiver รองรับการควบคุมขั้นสูงกว่า คุณควรตรวจสอบว่าแอปผู้ส่งทำงานอย่างถูกต้องเมื่อแคสต์ไปยังแอป Android TV เช่น หากแอป Android TV ไม่รองรับการเปลี่ยนอัตราการเล่นในขณะที่แอป Web Receiver ใช้ คุณควรตั้งค่าการดำเนินการที่รองรับในแต่ละแพลตฟอร์มอย่างถูกต้องและตรวจสอบว่าแอปผู้ส่งแสดง UI อย่างถูกต้อง

การแก้ไขสถานะสื่อ

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

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

วิธีสร้างและเผยแพร่ MediaStatus

คอตลิน

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 โดยอัตโนมัติ

สกัดกั้นสถานะสื่อก่อนส่ง

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

คอตลิน

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 คุณสามารถระบุเครื่องมือตรวจสอบการเปิดใช้เพื่อดูว่าข้อมูลเข้าสู่ระบบของผู้ส่งได้รับอนุญาตหรือไม่ แต่หากไม่มี Cast 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 ขึ้นไป

คอตลิน

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.0 ขึ้นไป

คุณโทรหาได้ทุกเมื่อหลังจากตั้งค่าตัวเลือกแล้ว: 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 โดยทำดังนี้

คอตลิน

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 ดังนี้

คอตลิน

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 ระหว่างการตั้งค่า ดังนี้

คอตลิน

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 - การส่งข้อความ

คอตลิน

// 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 - รับข้อความเนมสเปซที่กำหนดเอง

คอตลิน

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());