Tích hợp Cast vào ứng dụng Android

Hướng dẫn này dành cho nhà phát triển mô tả cách thêm tính năng hỗ trợ Google Cast vào ứng dụng người gửi Android bằng Android Sender SDK.

Thiết bị di động hoặc máy tính xách tay là thiết bị gửi kiểm soát quá trình phát và thiết bị Google Cast là thiết bị nhận hiển thị nội dung trên TV.

Khung người gửi đề cập đến tệp nhị phân thư viện lớp Cast và các tài nguyên liên kết có trong thời gian chạy trên người gửi. Ứng dụng người gửi hoặc ứng dụng Cast là một ứng dụng cũng chạy trên người gửi. Ứng dụng Web Receiver là ứng dụng HTML chạy trên thiết bị hỗ trợ Cast.

Khung người gửi sử dụng thiết kế gọi lại không đồng bộ để thông báo cho ứng dụng người gửi về các sự kiện và chuyển đổi giữa nhiều trạng thái của vòng đời ứng dụng Cast.

Luồng ứng dụng

Các bước sau đây mô tả quy trình thực thi cấp cao điển hình cho ứng dụng Android của người gửi:

  • Khung truyền tự động bắt đầu quá trình khám phá thiết bị MediaRouter dựa trên vòng đời Activity.
  • Khi người dùng nhấp vào nút Truyền, khung sẽ trình bày hộp thoại Truyền có danh sách các thiết bị Truyền được phát hiện.
  • Khi người dùng chọn một thiết bị truyền, khung sẽ cố gắng khởi chạy ứng dụng Web Receiver trên thiết bị truyền.
  • Khung này gọi các lệnh gọi lại trong ứng dụng người gửi để xác nhận rằng ứng dụng Web Receiver đã được khởi chạy.
  • Khung này tạo ra một kênh giao tiếp giữa ứng dụng người gửi và ứng dụng Web Receiver.
  • Khung này sử dụng kênh giao tiếp để tải và kiểm soát việc phát nội dung nghe nhìn trên Web Receiver.
  • Khung này đồng bộ hoá trạng thái phát nội dung nghe nhìn giữa thiết bị gửi và Trình nhận Web: khi người dùng thực hiện các thao tác trên giao diện người dùng của thiết bị gửi, khung này sẽ truyền các yêu cầu điều khiển nội dung nghe nhìn đó đến Trình nhận Web và khi Trình nhận Web gửi thông tin cập nhật về trạng thái nội dung nghe nhìn, khung này sẽ cập nhật trạng thái của giao diện người dùng của thiết bị gửi.
  • Khi người dùng nhấp vào nút Truyền để ngắt kết nối với thiết bị truyền, khung sẽ ngắt kết nối ứng dụng người gửi khỏi Trình nhận web.

Để xem danh sách đầy đủ tất cả các lớp, phương thức và sự kiện trong SDK Google Cast cho Android, hãy xem Tài liệu tham khảo về API người gửi Google Cast cho Android. Các phần sau đây trình bày các bước để bạn thêm tính năng Truyền vào ứng dụng Android.

Định cấu hình tệp kê khai Android

Tệp AndroidManifest.xml của ứng dụng yêu cầu bạn định cấu hình các phần tử sau cho Cast SDK:

uses-sdk

Đặt cấp độ API Android tối thiểu và mục tiêu mà Cast SDK hỗ trợ. Hiện tại, cấp độ API tối thiểu là 23 và cấp độ API mục tiêu là 34.

<uses-sdk
        android:minSdkVersion="23"
        android:targetSdkVersion="34" />

android:theme

Đặt giao diện của ứng dụng dựa trên phiên bản SDK Android tối thiểu. Ví dụ: nếu không triển khai giao diện riêng, bạn nên sử dụng một biến thể của Theme.AppCompat khi nhắm đến phiên bản SDK Android tối thiểu là phiên bản trước Lollipop.

<application
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/Theme.AppCompat" >
       ...
</application>

Khởi chạy Cast Context

Khung này có một đối tượng singleton chung, CastContext, giúp điều phối tất cả các hoạt động tương tác của khung.

Ứng dụng của bạn phải triển khai giao diện OptionsProvider để cung cấp các lựa chọn cần thiết để khởi chạy singleton CastContext. OptionsProvider cung cấp một phiên bản của CastOptions chứa các lựa chọn ảnh hưởng đến hành vi của khung. Quan trọng nhất trong số này là mã nhận dạng ứng dụng Web Receiver. Mã này được dùng để lọc kết quả tìm kiếm và khởi chạy ứng dụng Web Receiver khi một phiên truyền bắt đầu.

Kotlin
class CastOptionsProvider : OptionsProvider {
    override fun getCastOptions(context: Context): CastOptions {
        return Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .build()
    }

    override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
        return null
    }
}
Java
public class CastOptionsProvider implements OptionsProvider {
    @Override
    public CastOptions getCastOptions(Context context) {
        CastOptions castOptions = new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .build();
        return castOptions;
    }
    @Override
    public List<SessionProvider> getAdditionalSessionProviders(Context context) {
        return null;
    }
}

Bạn phải khai báo tên đủ điều kiện của OptionsProvider đã triển khai dưới dạng một trường siêu dữ liệu trong tệp AndroidManifest.xml của ứng dụng gửi:

<application>
    ...
    <meta-data
        android:name=
            "com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
        android:value="com.foo.CastOptionsProvider" />
</application>

CastContext được khởi tạo một cách trì hoãn khi CastContext.getSharedInstance() được gọi.

Kotlin
class MyActivity : FragmentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        val castContext = CastContext.getSharedInstance(this)
    }
}
Java
public class MyActivity extends FragmentActivity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        CastContext castContext = CastContext.getSharedInstance(this);
    }
}

Tiện ích UX của Cast

Khung Cast cung cấp các tiện ích tuân thủ Danh sách kiểm tra thiết kế Cast:

  • Lớp phủ giới thiệu: Khung này cung cấp một Chế độ xem tuỳ chỉnh, IntroductoryOverlay, được hiển thị cho người dùng để thu hút sự chú ý đến nút Truyền trong lần đầu tiên có bộ nhận. Ứng dụng Sender có thể tuỳ chỉnh văn bản và vị trí của văn bản tiêu đề.

  • Nút Truyền: Nút Truyền sẽ xuất hiện bất kể có thiết bị truyền hay không. Khi người dùng nhấp vào nút Truyền lần đầu tiên, một hộp thoại Truyền sẽ xuất hiện, liệt kê các thiết bị được phát hiện. Khi người dùng nhấp vào nút Truyền trong khi thiết bị đang kết nối, nút này sẽ hiển thị siêu dữ liệu hiện tại của nội dung nghe nhìn (chẳng hạn như tiêu đề, tên của phòng thu và hình thu nhỏ) hoặc cho phép người dùng ngắt kết nối với thiết bị truyền. Đôi khi, "nút Truyền" còn được gọi là "biểu tượng Truyền".

  • Bộ điều khiển thu nhỏ: Khi người dùng truyền nội dung và đã rời khỏi trang nội dung hiện tại hoặc bộ điều khiển mở rộng để chuyển sang một màn hình khác trong ứng dụng người gửi, bộ điều khiển thu nhỏ sẽ xuất hiện ở cuối màn hình để cho phép người dùng xem siêu dữ liệu nội dung nghe nhìn đang truyền và điều khiển chế độ phát.

  • Bộ điều khiển mở rộng: Khi người dùng truyền nội dung, nếu họ nhấp vào thông báo về nội dung nghe nhìn hoặc bộ điều khiển thu nhỏ, bộ điều khiển mở rộng sẽ khởi chạy. Bộ điều khiển này hiển thị siêu dữ liệu nội dung nghe nhìn đang phát và cung cấp một số nút để điều khiển việc phát nội dung nghe nhìn.

  • Thông báo: Chỉ dành cho Android. Khi người dùng truyền nội dung và rời khỏi ứng dụng gửi, một thông báo về nội dung nghe nhìn sẽ xuất hiện, cho biết siêu dữ liệu nội dung nghe nhìn đang truyền và các nút điều khiển phát.

  • Màn hình khoá: Chỉ có trên Android. Khi người dùng truyền nội dung và chuyển đến màn hình khoá (hoặc thiết bị hết thời gian chờ), một chế độ điều khiển nội dung nghe nhìn trên màn hình khoá sẽ xuất hiện. Chế độ này cho biết siêu dữ liệu nội dung nghe nhìn đang truyền và các nút điều khiển phát.

Hướng dẫn sau đây mô tả cách thêm các tiện ích này vào ứng dụng của bạn.

Thêm nút Truyền

Các API MediaRouter của Android được thiết kế để cho phép hiển thị và phát nội dung nghe nhìn trên các thiết bị phụ. Các ứng dụng Android sử dụng API MediaRouter phải có nút Truyền trong giao diện người dùng để cho phép người dùng chọn một tuyến phát nội dung nghe nhìn để phát nội dung nghe nhìn trên một thiết bị phụ, chẳng hạn như thiết bị truyền.

Khung này giúp bạn dễ dàng thêm MediaRouteButton làm Cast button. Trước tiên, bạn nên thêm một mục trình đơn hoặc MediaRouteButton vào tệp xml xác định trình đơn của bạn và sử dụng CastButtonFactory để kết nối mục đó với khung.

// To add a Cast button, add the following snippet.
// menu.xml
<item
    android:id="@+id/media_route_menu_item"
    android:title="@string/media_route_menu_title"
    app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
    app:showAsAction="always" />
Kotlin
// Then override the onCreateOptionMenu() for each of your activities.
// MyActivity.kt
override fun onCreateOptionsMenu(menu: Menu): Boolean {
    super.onCreateOptionsMenu(menu)
    menuInflater.inflate(R.menu.main, menu)
    CastButtonFactory.setUpMediaRouteButton(
        applicationContext,
        menu,
        R.id.media_route_menu_item
    )
    return true
}
Java
// Then override the onCreateOptionMenu() for each of your activities.
// MyActivity.java
@Override public boolean onCreateOptionsMenu(Menu menu) {
    super.onCreateOptionsMenu(menu);
    getMenuInflater().inflate(R.menu.main, menu);
    CastButtonFactory.setUpMediaRouteButton(getApplicationContext(),
                                            menu,
                                            R.id.media_route_menu_item);
    return true;
}

Sau đó, nếu Activity của bạn kế thừa từ FragmentActivity, bạn có thể thêm MediaRouteButton vào bố cục.

// activity_layout.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
   android:layout_width="match_parent"
   android:layout_height="wrap_content"
   android:gravity="center_vertical"
   android:orientation="horizontal" >

   <androidx.mediarouter.app.MediaRouteButton
       android:id="@+id/media_route_button"
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"
       android:layout_weight="1"
       android:mediaRouteTypes="user"
       android:visibility="gone" />

</LinearLayout>
Kotlin
// MyActivity.kt
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_layout)

    mMediaRouteButton = findViewById<View>(R.id.media_route_button) as MediaRouteButton
    CastButtonFactory.setUpMediaRouteButton(applicationContext, mMediaRouteButton)

    mCastContext = CastContext.getSharedInstance(this)
}
Java
// MyActivity.java
@Override
protected void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   setContentView(R.layout.activity_layout);

   mMediaRouteButton = (MediaRouteButton) findViewById(R.id.media_route_button);
   CastButtonFactory.setUpMediaRouteButton(getApplicationContext(), mMediaRouteButton);

   mCastContext = CastContext.getSharedInstance(this);
}

Để đặt giao diện cho nút Truyền bằng một giao diện, hãy xem phần Tuỳ chỉnh nút Truyền.

Định cấu hình tính năng khám phá thiết bị

CastContext quản lý hoàn toàn quá trình khám phá thiết bị. Khi khởi chạy CastContext, ứng dụng người gửi sẽ chỉ định mã ứng dụng Web Receiver và có thể tuỳ ý yêu cầu lọc không gian tên bằng cách đặt supportedNamespaces trong CastOptions. CastContext giữ một tham chiếu đến MediaRouter trong nội bộ và sẽ bắt đầu quy trình khám phá trong các điều kiện sau:

  • Dựa trên một thuật toán được thiết kế để cân bằng độ trễ phát hiện thiết bị và mức sử dụng pin, tính năng phát hiện đôi khi sẽ tự động bắt đầu khi ứng dụng gửi chuyển sang nền trước.
  • Hộp thoại Truyền đang mở.
  • Cast SDK đang cố gắng khôi phục một phiên truyền.

Quá trình khám phá sẽ dừng khi hộp thoại Truyền đóng hoặc ứng dụng người gửi chuyển sang chế độ nền.

Kotlin
class CastOptionsProvider : OptionsProvider {
    companion object {
        const val CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace"
    }

    override fun getCastOptions(appContext: Context): CastOptions {
        val supportedNamespaces: MutableList<String> = ArrayList()
        supportedNamespaces.add(CUSTOM_NAMESPACE)

        return CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setSupportedNamespaces(supportedNamespaces)
            .build()
    }

    override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
        return null
    }
}
Java
class CastOptionsProvider implements OptionsProvider {
    public static final String CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace";

    @Override
    public CastOptions getCastOptions(Context appContext) {
        List<String> supportedNamespaces = new ArrayList<>();
        supportedNamespaces.add(CUSTOM_NAMESPACE);

        CastOptions castOptions = new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setSupportedNamespaces(supportedNamespaces)
            .build();
        return castOptions;
    }

    @Override
    public List<SessionProvider> getAdditionalSessionProviders(Context context) {
        return null;
    }
}

Cách hoạt động của tính năng quản lý phiên

Cast SDK giới thiệu khái niệm về phiên truyền, việc thiết lập phiên này kết hợp các bước kết nối với thiết bị, khởi chạy (hoặc tham gia) ứng dụng Web Receiver, kết nối với ứng dụng đó và khởi chạy kênh điều khiển nội dung nghe nhìn. Hãy xem Hướng dẫn về vòng đời ứng dụng của Web Receiver để biết thêm thông tin về các phiên truyền và vòng đời của Web Receiver.

Các phiên được quản lý bởi lớp SessionManager mà ứng dụng của bạn có thể truy cập thông qua CastContext.getSessionManager(). Các phiên riêng lẻ được biểu thị bằng các lớp con của lớp Session. Ví dụ: CastSession biểu thị các phiên có thiết bị truyền. Ứng dụng của bạn có thể truy cập vào phiên truyền đang hoạt động hiện tại thông qua SessionManager.getCurrentCastSession().

Ứng dụng của bạn có thể dùng lớp SessionManagerListener để theo dõi các sự kiện của phiên, chẳng hạn như tạo, tạm ngưng, tiếp tục và chấm dứt. Khung này sẽ tự động cố gắng tiếp tục từ một trạng thái kết thúc bất thường/đột ngột trong khi một phiên đang hoạt động.

Các phiên được tạo và huỷ tự động để phản hồi cử chỉ của người dùng từ hộp thoại MediaRouter.

Để hiểu rõ hơn về các lỗi khi bắt đầu truyền, ứng dụng có thể sử dụng CastContext#getCastReasonCodeForCastStatusCode(int) để chuyển đổi lỗi khi bắt đầu phiên thành CastReasonCodes. Xin lưu ý rằng một số lỗi khi bắt đầu phiên (ví dụ: CastReasonCodes#CAST_CANCELLED) là hành vi dự kiến và không nên được ghi lại dưới dạng lỗi.

Nếu cần biết các thay đổi về trạng thái của phiên, bạn có thể triển khai SessionManagerListener. Ví dụ này theo dõi trạng thái có sẵn của CastSession trong Activity.

Kotlin
class MyActivity : Activity() {
    private var mCastSession: CastSession? = null
    private lateinit var mCastContext: CastContext
    private lateinit var mSessionManager: SessionManager
    private val mSessionManagerListener: SessionManagerListener<CastSession> =
        SessionManagerListenerImpl()

    private inner class SessionManagerListenerImpl : SessionManagerListener<CastSession?> {
        override fun onSessionStarting(session: CastSession?) {}

        override fun onSessionStarted(session: CastSession?, sessionId: String) {
            invalidateOptionsMenu()
        }

        override fun onSessionStartFailed(session: CastSession?, error: Int) {
            val castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error)
            // Handle error
        }

        override fun onSessionSuspended(session: CastSession?, reason Int) {}

        override fun onSessionResuming(session: CastSession?, sessionId: String) {}

        override fun onSessionResumed(session: CastSession?, wasSuspended: Boolean) {
            invalidateOptionsMenu()
        }

        override fun onSessionResumeFailed(session: CastSession?, error: Int) {}

        override fun onSessionEnding(session: CastSession?) {}

        override fun onSessionEnded(session: CastSession?, error: Int) {
            finish()
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        mCastContext = CastContext.getSharedInstance(this)
        mSessionManager = mCastContext.sessionManager
        mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession::class.java)
    }

    override fun onResume() {
        super.onResume()
        mCastSession = mSessionManager.currentCastSession
    }

    override fun onDestroy() {
        super.onDestroy()
        mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession::class.java)
    }
}
Java
public class MyActivity extends Activity {
    private CastContext mCastContext;
    private CastSession mCastSession;
    private SessionManager mSessionManager;
    private SessionManagerListener<CastSession> mSessionManagerListener =
            new SessionManagerListenerImpl();

    private class SessionManagerListenerImpl implements SessionManagerListener<CastSession> {
        @Override
        public void onSessionStarting(CastSession session) {}
        @Override
        public void onSessionStarted(CastSession session, String sessionId) {
            invalidateOptionsMenu();
        }
        @Override
        public void onSessionStartFailed(CastSession session, int error) {
            int castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error);
            // Handle error
        }
        @Override
        public void onSessionSuspended(CastSession session, int reason) {}
        @Override
        public void onSessionResuming(CastSession session, String sessionId) {}
        @Override
        public void onSessionResumed(CastSession session, boolean wasSuspended) {
            invalidateOptionsMenu();
        }
        @Override
        public void onSessionResumeFailed(CastSession session, int error) {}
        @Override
        public void onSessionEnding(CastSession session) {}
        @Override
        public void onSessionEnded(CastSession session, int error) {
            finish();
        }
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mCastContext = CastContext.getSharedInstance(this);
        mSessionManager = mCastContext.getSessionManager();
        mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession.class);
    }

    @Override
    protected void onResume() {
        super.onResume();
        mCastSession = mSessionManager.getCurrentCastSession();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession.class);
    }
}

Chuyển đổi phiên phát trực tuyến

Việc duy trì trạng thái phiên là cơ sở của tính năng chuyển luồng phát, trong đó người dùng có thể di chuyển các luồng âm thanh và video hiện có giữa các thiết bị bằng lệnh thoại, Ứng dụng Google Home hoặc màn hình thông minh. Nội dung nghe nhìn ngừng phát trên một thiết bị (nguồn) và tiếp tục phát trên một thiết bị khác (đích). Mọi thiết bị truyền có phần mềm mới nhất đều có thể đóng vai trò là nguồn hoặc đích đến trong quá trình truyền trực tuyến.

Để nhận thiết bị đích mới trong quá trình chuyển hoặc mở rộng luồng phát, hãy đăng ký Cast.Listener bằng CastSession#addCastListener. Sau đó, hãy gọi CastSession#getCastDevice() trong lệnh gọi lại onDeviceNameChanged.

Hãy xem phần Truyền trực tuyến trên Web Receiver để biết thêm thông tin.

Tự động kết nối lại

Khung này cung cấp một ReconnectionService mà ứng dụng người gửi có thể bật để xử lý việc kết nối lại trong nhiều trường hợp đặc biệt, chẳng hạn như:

  • Khôi phục sau khi mất Wi-Fi tạm thời
  • Khôi phục sau khi thiết bị chuyển sang chế độ ngủ
  • Khôi phục sau khi đưa ứng dụng xuống nền
  • Khôi phục nếu ứng dụng gặp sự cố

Dịch vụ này được bật theo mặc định và có thể tắt trong CastOptions.Builder.

Dịch vụ này có thể tự động hợp nhất vào tệp kê khai của ứng dụng nếu bạn bật tính năng tự động hợp nhất trong tệp gradle.

Khung này sẽ khởi động dịch vụ khi có một phiên phát nội dung nghe nhìn và dừng dịch vụ đó khi phiên phát nội dung nghe nhìn kết thúc.

Cách hoạt động của chế độ Điều khiển phương tiện

Khung Cast không dùng lớp RemoteMediaPlayer của Cast 2.x mà dùng lớp RemoteMediaClient mới. Lớp này cung cấp chức năng tương tự trong một tập hợp các API thuận tiện hơn và không cần truyền GoogleApiClient.

Khi ứng dụng của bạn thiết lập CastSession với một ứng dụng Web Receiver hỗ trợ không gian tên nội dung nghe nhìn, một thực thể RemoteMediaClient sẽ tự động được khung tạo; ứng dụng của bạn có thể truy cập vào thực thể này bằng cách gọi phương thức getRemoteMediaClient() trên thực thể CastSession.

Tất cả các phương thức của RemoteMediaClient đưa ra yêu cầu cho Web Receiver sẽ trả về một đối tượng PendingResult có thể dùng để theo dõi yêu cầu đó.

Dự kiến, nhiều phần trong ứng dụng của bạn có thể dùng chung phiên bản RemoteMediaClient và thực tế là một số thành phần nội bộ của khung này, chẳng hạn như bộ điều khiển thu nhỏ liên tục và dịch vụ thông báo. Để làm được điều đó, phiên bản này hỗ trợ việc đăng ký nhiều phiên bản của RemoteMediaClient.Listener.

Đặt siêu dữ liệu về nội dung nghe nhìn

Lớp MediaMetadata biểu thị thông tin về một mục nội dung nghe nhìn mà bạn muốn truyền. Ví dụ sau đây tạo một phiên bản MediaMetadata mới của một bộ phim và đặt tiêu đề, phụ đề và 2 hình ảnh.

Kotlin
val movieMetadata = MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE)

movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle())
movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio())
movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(0))))
movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(1))))
Java
MediaMetadata movieMetadata = new MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE);

movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle());
movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio());
movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(0))));
movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(1))));

Xem phần Lựa chọn hình ảnh để biết cách sử dụng hình ảnh có siêu dữ liệu nội dung nghe nhìn.

Tải nội dung nghe nhìn

Ứng dụng của bạn có thể tải một mục nội dung nghe nhìn, như minh hoạ trong mã sau. Trước tiên, hãy dùng MediaInfo.Builder với siêu dữ liệu của nội dung nghe nhìn để tạo một thực thể MediaInfo. Lấy RemoteMediaClient từ CastSession hiện tại, sau đó tải MediaInfo vào RemoteMediaClient đó. Sử dụng RemoteMediaClient để phát, tạm dừng và điều khiển một ứng dụng trình phát nội dung nghe nhìn đang chạy trên Web Receiver.

Kotlin
val mediaInfo = MediaInfo.Builder(mSelectedMedia.getUrl())
    .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
    .setContentType("videos/mp4")
    .setMetadata(movieMetadata)
    .setStreamDuration(mSelectedMedia.getDuration() * 1000)
    .build()
val remoteMediaClient = mCastSession.getRemoteMediaClient()
remoteMediaClient.load(MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build())
Java
MediaInfo mediaInfo = new MediaInfo.Builder(mSelectedMedia.getUrl())
        .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
        .setContentType("videos/mp4")
        .setMetadata(movieMetadata)
        .setStreamDuration(mSelectedMedia.getDuration() * 1000)
        .build();
RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
remoteMediaClient.load(new MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build());

Ngoài ra, hãy xem phần về cách sử dụng các bản âm thanh và phụ đề.

Định dạng video 4K

Để kiểm tra định dạng video của nội dung nghe nhìn, hãy dùng getVideoInfo() trong MediaStatus để lấy phiên bản hiện tại của VideoInfo. Phiên bản này chứa loại định dạng HDR TV, cũng như chiều cao và chiều rộng của màn hình tính bằng pixel. Các biến thể của định dạng 4K được biểu thị bằng các hằng số HDR_TYPE_*.

Thông báo của điều khiển từ xa đến nhiều thiết bị

Khi người dùng truyền nội dung, các thiết bị Android khác trên cùng mạng sẽ nhận được thông báo để cho phép họ điều khiển quá trình phát. Bất kỳ ai có thiết bị nhận được những thông báo như vậy đều có thể tắt thông báo cho thiết bị đó trong ứng dụng Cài đặt tại phần Google > Google Cast > Hiện thông báo về chế độ điều khiển từ xa. (Thông báo này có một lối tắt đến ứng dụng Cài đặt.) Để biết thêm thông tin chi tiết, hãy xem phần Thông báo có nút điều khiển từ xa của tính năng Truyền.

Thêm bộ điều khiển mini

Theo Danh sách kiểm tra thiết kế Cast, ứng dụng người gửi phải cung cấp một chế độ kiểm soát liên tục, còn được gọi là bộ điều khiển thu nhỏ. Bộ điều khiển này sẽ xuất hiện khi người dùng rời khỏi trang nội dung hiện tại để chuyển đến một phần khác của ứng dụng người gửi. Bộ điều khiển thu nhỏ cung cấp một lời nhắc hữu hình cho người dùng về phiên truyền hiện tại. Bằng cách nhấn vào bộ điều khiển thu nhỏ, người dùng có thể quay lại chế độ xem bộ điều khiển mở rộng toàn màn hình của tính năng Truyền.

Khung này cung cấp một View tuỳ chỉnh, MiniControllerFragment, mà bạn có thể thêm vào cuối tệp bố cục của mỗi hoạt động mà bạn muốn hiển thị bộ điều khiển thu nhỏ.

<fragment
    android:id="@+id/castMiniController"
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:layout_alignParentBottom="true"
    android:visibility="gone"
    class="com.google.android.gms.cast.framework.media.widget.MiniControllerFragment" />

Khi ứng dụng người gửi đang phát một sự kiện phát trực tiếp bằng video hoặc âm thanh, SDK sẽ tự động hiển thị nút phát/dừng thay cho nút phát/tạm dừng trong bộ điều khiển thu nhỏ.

Để đặt giao diện văn bản của tiêu đề và phụ đề của chế độ xem tuỳ chỉnh này, cũng như chọn các nút, hãy xem phần Tuỳ chỉnh Bộ điều khiển thu nhỏ.

Thêm bộ điều khiển mở rộng

Danh sách kiểm tra thiết kế của Google Cast yêu cầu ứng dụng người gửi cung cấp một bộ điều khiển mở rộng cho nội dung nghe nhìn đang được truyền. Bộ điều khiển mở rộng là phiên bản toàn màn hình của bộ điều khiển thu nhỏ.

Cast SDK cung cấp một tiện ích cho bộ điều khiển mở rộng có tên là ExpandedControllerActivity. Đây là một lớp trừu tượng mà bạn phải phân lớp để thêm nút Truyền.

Trước tiên, hãy tạo một tệp tài nguyên trình đơn mới cho bộ điều khiển mở rộng để cung cấp nút Truyền:

<menu xmlns:android="http://schemas.android.com/apk/res/android"
      xmlns:app="http://schemas.android.com/apk/res-auto">

    <item
            android:id="@+id/media_route_menu_item"
            android:title="@string/media_route_menu_title"
            app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
            app:showAsAction="always"/>

</menu>

Tạo một lớp mới mở rộng ExpandedControllerActivity.

Kotlin
class ExpandedControlsActivity : ExpandedControllerActivity() {
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
        super.onCreateOptionsMenu(menu)
        menuInflater.inflate(R.menu.expanded_controller, menu)
        CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item)
        return true
    }
}
Java
public class ExpandedControlsActivity extends ExpandedControllerActivity {
    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        super.onCreateOptionsMenu(menu);
        getMenuInflater().inflate(R.menu.expanded_controller, menu);
        CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item);
        return true;
    }
}

Bây giờ, hãy khai báo hoạt động mới trong tệp kê khai ứng dụng trong thẻ application:

<application>
...
<activity
        android:name=".expandedcontrols.ExpandedControlsActivity"
        android:label="@string/app_name"
        android:launchMode="singleTask"
        android:theme="@style/Theme.CastVideosDark"
        android:screenOrientation="portrait"
        android:parentActivityName="com.google.sample.cast.refplayer.VideoBrowserActivity">
    <intent-filter>
        <action android:name="android.intent.action.MAIN"/>
    </intent-filter>
</activity>
...
</application>

Chỉnh sửa CastOptionsProvider và thay đổi NotificationOptionsCastMediaOptions để đặt hoạt động mục tiêu thành hoạt động mới của bạn:

Kotlin
override fun getCastOptions(context: Context): CastOptions? {
    val notificationOptions = NotificationOptions.Builder()
        .setTargetActivityClassName(ExpandedControlsActivity::class.java.name)
        .build()
    val mediaOptions = CastMediaOptions.Builder()
        .setNotificationOptions(notificationOptions)
        .setExpandedControllerActivityClassName(ExpandedControlsActivity::class.java.name)
        .build()

    return CastOptions.Builder()
        .setReceiverApplicationId(context.getString(R.string.app_id))
        .setCastMediaOptions(mediaOptions)
        .build()
}
Java
public CastOptions getCastOptions(Context context) {
    NotificationOptions notificationOptions = new NotificationOptions.Builder()
            .setTargetActivityClassName(ExpandedControlsActivity.class.getName())
            .build();
    CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
            .setNotificationOptions(notificationOptions)
            .setExpandedControllerActivityClassName(ExpandedControlsActivity.class.getName())
            .build();

    return new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setCastMediaOptions(mediaOptions)
            .build();
}

Cập nhật phương thức LocalPlayerActivity loadRemoteMedia để hiển thị hoạt động mới khi nội dung nghe nhìn từ xa được tải:

Kotlin
private fun loadRemoteMedia(position: Int, autoPlay: Boolean) {
    val remoteMediaClient = mCastSession?.remoteMediaClient ?: return

    remoteMediaClient.registerCallback(object : RemoteMediaClient.Callback() {
        override fun onStatusUpdated() {
            val intent = Intent(this@LocalPlayerActivity, ExpandedControlsActivity::class.java)
            startActivity(intent)
            remoteMediaClient.unregisterCallback(this)
        }
    })

    remoteMediaClient.load(
        MediaLoadRequestData.Builder()
            .setMediaInfo(mSelectedMedia)
            .setAutoplay(autoPlay)
            .setCurrentTime(position.toLong()).build()
    )
}
Java
private void loadRemoteMedia(int position, boolean autoPlay) {
    if (mCastSession == null) {
        return;
    }
    final RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
    if (remoteMediaClient == null) {
        return;
    }
    remoteMediaClient.registerCallback(new RemoteMediaClient.Callback() {
        @Override
        public void onStatusUpdated() {
            Intent intent = new Intent(LocalPlayerActivity.this, ExpandedControlsActivity.class);
            startActivity(intent);
            remoteMediaClient.unregisterCallback(this);
        }
    });
    remoteMediaClient.load(new MediaLoadRequestData.Builder()
            .setMediaInfo(mSelectedMedia)
            .setAutoplay(autoPlay)
            .setCurrentTime(position).build());
}

Khi ứng dụng người gửi đang phát một sự kiện phát trực tiếp bằng video hoặc âm thanh, SDK sẽ tự động hiển thị nút phát/dừng thay cho nút phát/tạm dừng trong bộ điều khiển mở rộng.

Để đặt giao diện bằng cách sử dụng giao diện, hãy chọn nút cần hiển thị và thêm nút tuỳ chỉnh, hãy xem phần Tuỳ chỉnh bộ điều khiển mở rộng.

Điều chỉnh âm lượng

Khung này tự động quản lý âm lượng cho ứng dụng người gửi. Khung này tự động đồng bộ hoá ứng dụng người gửi và ứng dụng Web Receiver để giao diện người dùng người gửi luôn báo cáo âm lượng do Web Receiver chỉ định.

Điều khiển âm lượng bằng nút vật lý

Trên Android, theo mặc định, bạn có thể dùng các nút vật lý trên thiết bị gửi để thay đổi âm lượng của phiên truyền trên Web Receiver cho mọi thiết bị dùng Jelly Bean trở lên.

Điều chỉnh âm lượng bằng nút vật lý trước phiên bản Jelly Bean

Để sử dụng các phím âm lượng thực để điều khiển âm lượng của thiết bị Web Receiver trên các thiết bị Android cũ hơn Jelly Bean, ứng dụng người gửi phải ghi đè dispatchKeyEvent trong các Hoạt động của ứng dụng và gọi CastContext.onDispatchVolumeKeyEventBeforeJellyBean():

Kotlin
class MyActivity : FragmentActivity() {
    override fun dispatchKeyEvent(event: KeyEvent): Boolean {
        return (CastContext.getSharedInstance(this)
            .onDispatchVolumeKeyEventBeforeJellyBean(event)
                || super.dispatchKeyEvent(event))
    }
}
Java
class MyActivity extends FragmentActivity {
    @Override
    public boolean dispatchKeyEvent(KeyEvent event) {
        return CastContext.getSharedInstance(this)
            .onDispatchVolumeKeyEventBeforeJellyBean(event)
            || super.dispatchKeyEvent(event);
    }
}

Thêm chế độ điều khiển nội dung nghe nhìn vào thông báo và màn hình khoá

Chỉ trên Android, Danh sách kiểm tra thiết kế Google Cast yêu cầu ứng dụng người gửi phải triển khai các chế độ điều khiển nội dung nghe nhìn trong một thông báo và trong màn hình khoá, trong đó người gửi đang truyền nhưng ứng dụng người gửi không có tiêu điểm. Khung này cung cấp MediaNotificationServiceMediaIntentReceiver để giúp ứng dụng gửi tạo các nút điều khiển nội dung nghe nhìn trong một thông báo và trong màn hình khoá.

MediaNotificationService sẽ chạy khi người gửi truyền và sẽ hiện một thông báo có hình thu nhỏ và thông tin về mục truyền hiện tại, nút phát/tạm dừng và nút dừng.

MediaIntentReceiver là một BroadcastReceiver xử lý các thao tác của người dùng từ thông báo.

Ứng dụng của bạn có thể định cấu hình thông báo và nút điều khiển nội dung nghe nhìn trên màn hình khoá thông qua NotificationOptions. Ứng dụng của bạn có thể định cấu hình những nút điều khiển sẽ xuất hiện trong thông báo và Activity nào sẽ mở khi người dùng nhấn vào thông báo. Nếu bạn không cung cấp rõ ràng các thao tác, hệ thống sẽ sử dụng các giá trị mặc định là MediaIntentReceiver.ACTION_TOGGLE_PLAYBACKMediaIntentReceiver.ACTION_STOP_CASTING.

Kotlin
// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting".
val buttonActions: MutableList<String> = ArrayList()
buttonActions.add(MediaIntentReceiver.ACTION_REWIND)
buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK)
buttonActions.add(MediaIntentReceiver.ACTION_FORWARD)
buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING)

// Showing "play/pause" and "stop casting" in the compat view of the notification.
val compatButtonActionsIndices = intArrayOf(1, 3)

// Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds.
// Tapping on the notification opens an Activity with class VideoBrowserActivity.
val notificationOptions = NotificationOptions.Builder()
    .setActions(buttonActions, compatButtonActionsIndices)
    .setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS)
    .setTargetActivityClassName(VideoBrowserActivity::class.java.name)
    .build()
Java
// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting".
List<String> buttonActions = new ArrayList<>();
buttonActions.add(MediaIntentReceiver.ACTION_REWIND);
buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK);
buttonActions.add(MediaIntentReceiver.ACTION_FORWARD);
buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING);

// Showing "play/pause" and "stop casting" in the compat view of the notification.
int[] compatButtonActionsIndices = new int[]{1, 3};

// Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds.
// Tapping on the notification opens an Activity with class VideoBrowserActivity.
NotificationOptions notificationOptions = new NotificationOptions.Builder()
    .setActions(buttonActions, compatButtonActionsIndices)
    .setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS)
    .setTargetActivityClassName(VideoBrowserActivity.class.getName())
    .build();

Theo mặc định, chế độ hiện nút điều khiển nội dung nghe nhìn trong thông báo và trên màn hình khoá sẽ được bật. Bạn có thể tắt chế độ này bằng cách gọi setNotificationOptions với giá trị rỗng trong CastMediaOptions.Builder. Hiện tại, tính năng màn hình khoá sẽ bật miễn là bạn bật thông báo.

Kotlin
// ... continue with the NotificationOptions built above
val mediaOptions = CastMediaOptions.Builder()
    .setNotificationOptions(notificationOptions)
    .build()
val castOptions: CastOptions = Builder()
    .setReceiverApplicationId(context.getString(R.string.app_id))
    .setCastMediaOptions(mediaOptions)
    .build()
Java
// ... continue with the NotificationOptions built above
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
        .setNotificationOptions(notificationOptions)
        .build();
CastOptions castOptions = new CastOptions.Builder()
        .setReceiverApplicationId(context.getString(R.string.app_id))
        .setCastMediaOptions(mediaOptions)
        .build();

Khi ứng dụng người gửi đang phát một sự kiện phát trực tiếp bằng video hoặc âm thanh, SDK sẽ tự động hiển thị nút phát/dừng thay cho nút phát/tạm dừng trên chế độ điều khiển thông báo nhưng không hiển thị trên chế độ điều khiển màn hình khoá.

Lưu ý: Để hiển thị các chế độ điều khiển trên màn hình khoá trên các thiết bị trước Lollipop, RemoteMediaClient sẽ tự động yêu cầu lấy tiêu điểm âm thanh thay cho bạn.

Xử lý lỗi

Các ứng dụng gửi cần xử lý tất cả các lệnh gọi lại lỗi và quyết định phản hồi tốt nhất cho từng giai đoạn của vòng đời Cast. Ứng dụng có thể hiển thị hộp thoại lỗi cho người dùng hoặc có thể quyết định huỷ kết nối với Web Receiver.