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

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

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

Khung trình gửi tham chiếu đến tệp nhị phân của 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 trình gửi. Ứng dụng người gửi hoặc Ứng dụng truyền đề cập đến một ứng dụng cũng chạy trên người gửi. Ứng dụng Trình nhận web là ứng dụng HTML chạy trên thiết bị hỗ trợ tính năng Truyền.

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

Luồng ứng dụng

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

  • Khung Truyền sẽ 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ẽ hiển thị hộp thoại Truyền cùng danh sách các thiết bị Truyền đã phát hiện.
  • Khi người dùng chọn một thiết bị Truyền, khung sẽ cố chạy ứng dụng Trình thu nhận web trên thiết bị truyền.
  • Khung này sẽ gọi các lệnh gọi lại trong ứng dụng gửi để xác nhận rằng ứng dụng Trình nhận web đã khởi chạy.
  • Khung này tạo một kênh liên lạc giữa người gửi và ứng dụng Trình nhận web.
  • Khung này sử dụng kênh giao tiếp để tải và điều khiển quá trình phát nội dung nghe nhìn trên Web receiver.
  • Khung sẽ đồng bộ hoá trạng thái phát nội dung nghe nhìn giữa người gửi và Trình nhận trên web: khi người dùng thực hiện thao tác trên giao diện người dùng của người gửi, khung sẽ chuyể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 trê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 người gửi.
  • Khi người dùng nhấp vào nút Truyền để ngắt kết nối khỏi Thiết bị truyền, khung sẽ ngắt kết nối ứng dụng của người gửi khỏi Web receiver.

Để biết danh sách đầy đủ tất cả các lớp, phương thức và sự kiện trong SDK Android của Google Cast, hãy xem Tài liệu tham khảo API Google Cast Sender 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 SDK Truyền:

uses-sdk

Đặt các cấp độ API Android tối thiểu và mục tiêu mà SDK Truyền hỗ trợ. Hiện tại, mức tối thiểu là API cấp 21 và mục tiêu là API cấp 28.

<uses-sdk
        android:minSdkVersion="21"
        android:targetSdkVersion="28" />

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 của riêng mình, thì bạn nên sử dụng biến thể của Theme.AppCompat khi nhắm đến phiên bản SDK Android tối thiểu là trước Lollipop.

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

Khởi chạy Ngữ cảnh truyền

Khung này có một đối tượng singleton toàn cầu (CastContext) đ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 tuỳ chọn cần thiết cho việc khởi chạy singleton CastContext. OptionsProvider cung cấp một thực thể của CastOptions có chứa các tuỳ chọn ảnh hưởng đến hành vi của khung. Quan trọng nhất trong số này là mã ứng dụng Web receiver, dùng để lọc kết quả khám phá và chạy ứng dụng Web receiver khi 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 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 chạy từng phầ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);
    }
}

Các tiện ích Cast UX

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

  • Lớp phủ giới thiệu: Khung này cung cấp một Khung hiển thị tuỳ chỉnh, IntroductoryOverlay, hiện cho người dùng thấy để thu hút sự chú ý vào nút Truyền trong lần đầu tiên có bộ thu. Ứng dụng Người gửi 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ẽ hiển thị bất kể thiết bị truyền có sẵn hay không. Khi người dùng nhấp vào nút Truyền lần đầu tiên, hộp thoại Truyền sẽ hiển thị 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ị được kết nối, nút này sẽ hiển thị siêu dữ liệu của nội dung nghe nhìn hiện tại (chẳng hạn như tiêu đề, tên phòng thu và hình thu nhỏ) hoặc cho phép người dùng ngắt kết nối khỏi Thiết bị truyền. "Nút truyền" đôi khi được gọi là "Biểu tượng truyền".

  • Trình điều khiển thu nhỏ: Khi người dùng đang 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 để sang một màn hình khác trong ứng dụng gửi, bộ điều khiển thu nhỏ sẽ hiển thị ở 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 đang truyền nội dung, nếu họ nhấp vào thông báo nội dung nghe nhìn hoặc bộ điều khiển thu nhỏ, thì bộ điều khiển mở rộng sẽ khởi chạy. Bộ điều khiển mở rộng sẽ hiển thị siêu dữ liệu nội dung nghe nhìn 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 đang 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 thấy siêu dữ liệu nội dung nghe nhìn và bộ điều khiển chế độ phát hiện đang truyền.

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

Hướng dẫn sau đây bao gồm nội dung mô tả về 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 bao gồm 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 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 việc thêm MediaRouteButton dưới dạng Cast button trở nên rất dễ dàng. Trước tiên, bạn phải thêm một mục trong 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 kế thừa từ FragmentActivity, bạn có thể thêm MediaRouteButton vào bố cục của mình.

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

Để thiết lập giao diện của 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 chế độ khám phá thiết bị

Việc khám phá thiết bị được CastContext quản lý hoàn toàn. Khi khởi chạy CastContext, ứng dụng gửi sẽ chỉ định mã ứng dụng Web Nhận và có thể tuỳ ý yêu cầu lọc không gian tên bằng cách đặt supportedNamespaces trong CastOptions. CastContext lưu giữ thông tin tham chiếu đến MediaRouter trong nội bộ và sẽ bắt đầu quá 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ễ khám phá thiết bị và mức sử dụng pin, đôi khi, quá trình khám phá 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ở.
  • SDK Truyền đang tìm cách khôi phục một phiên Truyền.

Quá trình khám phá sẽ dừng lại khi hộp thoại Truyền đóng hoặc ứng dụng 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

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

Các phiên hoạt động được quản lý bằng 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 đại diện cho các phiên có thiết bị truyền. Ứng dụng của bạn có thể truy cập phiên Truyền đang hoạt động thông qua SessionManager.getCurrentCastSession().

Ứng dụng của bạn có thể sử dụng lớp SessionManagerListener để theo dõi các sự kiện trong 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 tìm cách tiếp tục sau khi một phiên bị chấm dứt bất thường/đột ngột trong khi một phiên đang hoạt động.

Phiên hoạt động được tạo và thu gọn tự động theo cử chỉ của người dùng từ hộp thoại MediaRouter.

Để hiểu rõ hơn về lỗi khởi động tính năng Truyền, các ứng dụng có thể sử dụng CastContext#getCastReasonCodeForCastStatusCode(int) để chuyển đổi lỗi bắt đầu phiên thành CastReasonCodes. Xin lưu ý rằng một số lỗi 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 lưu ý về các thay đổi trạng thái của phiên, bạn có thể triển khai SessionManagerListener. Ví dụ này theo dõi tình trạng sẵn có 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
    }

    override fun onResume() {
        super.onResume()
        mCastSession = mSessionManager.currentCastSession
        mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession::class.java)
    }

    override fun onPause() {
        super.onPause()
        mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession::class.java)
        mCastSession = null
    }
}
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();
    }
    @Override
    protected void onResume() {
        super.onResume();
        mCastSession = mSessionManager.getCurrentCastSession();
        mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession.class);
    }
    @Override
    protected void onPause() {
        super.onPause();
        mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession.class);
        mCastSession = null;
    }
}

Chuyển sự kiện phát trực tiếp

Việc giữ nguyên trạng thái phiên là cơ sở của quá trình chuyển sự kiện phát trực tuyến, trong đó người dùng có thể di chuyển các luồng âm thanh và video hiện có trên 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 đến). Mọi thiết bị truyền có chương trình cơ sở mới nhất đều có thể đóng vai trò là nguồn hoặc đích đến trong quá trình chuyển luồng.

Để có thiết bị đích mới trong quá trình chuyển hoặc mở rộng luồng, 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 bài viết Chuyển luồng 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 của 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 góc nhỏ, chẳng hạn như:

  • Khôi phục sau khi mất Wi-Fi tạm thời
  • Khôi phục từ chế độ ngủ của thiết bị
  • Khôi phục sau khi chạy ứng dụng ở chế độ 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à bạn có thể tắt trong CastOptions.Builder.

Dịch vụ này có thể tự động được 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ẽ bắt đầu dịch vụ khi có một phiên phát nội dung đa phương tiệ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 tính năng Điều khiển nội dung nghe nhìn

Khung Cast sẽ ngừng sử dụng lớp RemoteMediaPlayer trong Cast 2.x và thay bằng một lớp mới RemoteMediaClient, 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à tránh phải truyền vào GoogleApiClient.

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

Tất cả phương thức của RemoteMediaClient đưa ra yêu cầu đến Trình nhận web sẽ trả về một đối tượng PendingResult có thể dùng để theo dõi yêu cầu đó.

Theo dự kiến, thực thể của RemoteMediaClient có thể được chia sẻ giữa nhiều phần của ứng dụng và trên 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 nhỏ cố định và dịch vụ thông báo. Do đó, thực thể này hỗ trợ đăng ký nhiều thực thể của RemoteMediaClient.Listener.

Thiết lập siêu dữ liệu đa phương tiện

Lớp MediaMetadata biểu thị thông tin về mục nội dung đa phương tiện bạn muốn Truyền. Ví dụ sau đây sẽ tạo một phiên bản MediaMetadata mới của một bộ phim và đặt tiêu đề, phụ đề cũng như hai 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))));

Hãy xem phần Lựa chọn hình ảnh về cách sử dụng hình ảnh cùng với siêu dữ liệu đa phương tiệ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 đa phương tiện, như minh hoạ trong mã sau. Trước tiên, hãy sử 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 đó. Dùng RemoteMediaClient để phát, tạm dừng và điều khiển ứng dụng trình phát nội dung đa phương tiện chạy trên Trình nhận web.

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 sử dụng các bản nhạc đa phương tiện.

Định dạng video 4K

Để kiểm tra định dạng video của nội dung nghe nhìn, hãy sử dụng getVideoInfo() trong MediaStatus để nhận thực thể hiện tại của VideoInfo. Phiên bản này chứa loại định dạng TV HDR, chiều cao và chiều rộng hiển thị 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 điều khiển từ xa đến nhiều thiết bị

Khi người dùng đang truyền, các thiết bị Android khác trên cùng một mạng cũng sẽ nhận được thông báo để cho phép họ điều khiển quá trình phát. Bất cứ ai nhận được các 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 trên Google > Google Cast > Hiển thị thông báo điều khiển từ xa. (Thông báo bao gồm lối tắt đến ứng dụng Cài đặt.) Để biết thêm thông tin, hãy xem phần Truyền thông báo điều khiển từ xa.

Thêm tay điều khiển thu nhỏ

Theo Danh sách kiểm tra thiết kế cho tính năng Truyền, ứng dụng gửi phải cung cấp chức năng điều khiển liên tục được gọi là bộ điều khiển 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 để đến một phần khác của ứng dụng gửi. Bộ điều khiển mini sẽ hiển thị lời nhắc cho người dùng về phiên Truyền hiện tại. Bằng cách nhấn vào tay đ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 Cast.

Khung này cung cấp một Thành phần hiển thị tuỳ chỉnh, MiniControllerFragment. Bạn có thể thêm thành phần hiển thị này 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 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 gửi của bạn đang phát một video hoặc âm thanh trực tiếp, SDK sẽ tự động hiển thị nút phát/dừng thay cho nút phát/tạm dừng trong tay điều khiển nhỏ.

Để đặt giao diện văn bản cho tiêu đề và phụ đề của khung hiển thị tuỳ chỉnh này và để 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 gửi phải cung cấp bộ điều khiển mở rộng cho nội dung nghe nhìn đang được truyền. Tay điều khiển mở rộng là phiên bản toàn màn hình của tay điều khiển mini.

SDK Truyền cung cấp một tiện ích cho bộ điều khiển mở rộng có tên là ExpandedControllerActivity. Đây là lớp trừu tượng mà bạn phải tạo lớp con để 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 của bạn trong tệp kê khai ứng dụng bên 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 đồng thời 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 gửi của bạn đang phát video hoặc âm thanh trực tiếp, 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ác giao diện, chọn nút sẽ hiển thị và thêm các nút tuỳ chỉnh, hãy xem phần Tuỳ chỉnh Bộ điều khiển mở rộng.

Chỉnh âm lượng

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

Kiểm soát â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ị sử dụng Jelly Bean trở lên.

Kiểm soát âm lượng bằng nút vật lý trước Jelly Bean

Để sử dụng các phím âm lượng vật lý nhằm điều chỉnh âm lượng của thiết bị Web Nhận trên các thiết bị Android cũ hơn Jelly Bean, ứng dụng gửi phải ghi đè dispatchKeyEvent trong Hoạt động của họ 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 các 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ế của Google Cast yêu cầu một ứng dụng của người gử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á, nơi người gửi đang truyền nhưng ứng dụng của người gửi không có tâm điểm. Khung này cung cấp MediaNotificationServiceMediaIntentReceiver để giúp ứng dụng gửi tạo 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á.

MediaNotificationService chạy khi trình gửi đang truyền và sẽ hiển thị 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 trong thông báo.

Ứng dụng của bạn có thể định cấu hình chế độ điều khiển thông báo và nội dung nghe nhìn từ 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 nào sẽ xuất hiện trong thông báo và Activity nào cần 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 hành động, thì các giá trị mặc định, MediaIntentReceiver.ACTION_TOGGLE_PLAYBACKMediaIntentReceiver.ACTION_STOP_CASTING sẽ được sử dụng.

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

Tính năng hiển thị các nút điều khiển nội dung nghe nhìn trên thông báo và màn hình khoá được bật theo mặc định và có thể bị tắt 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 gửi của bạn đang phát video hoặc âm thanh trực tiếp, 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 thanh điều khiển thông báo nhưng không hiển thị trên bảng điều khiển màn hình khoá.

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

Xử lý lỗi

Điều quan trọng là các ứng dụng gửi phải 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 trong vòng đời của tính năng Truyền. Ứng dụng có thể cho người dùng thấy hộp thoại lỗi hoặc có thể quyết định chia nhỏ kết nối với Web receiver.