Di chuyển ứng dụng Android Sender từ Cast SDK phiên bản 2 sang Khung ứng dụng truyền (CAF)

Quy trình sau đây cho phép bạn chuyển đổi ứng dụng dành cho người gửi Android từ Cast SDK v2 thành CAF Sender, dựa trên singleton CastContext.

SDK người gửi CAF của Cast sử dụng CastContext để thay mặt bạn quản lý GoogleAPIClient. CastContext quản lý vòng đời, lỗi và lệnh gọi lại cho bạn, giúp đơn giản hóa đáng kể việc phát triển một ứng dụng Cast.

Giới thiệu

  • CAF Sender vẫn được phân phối như một phần của Dịch vụ Google Play bằng cách sử dụng trình quản lý SDK Android
  • Các gói mới đã được thêm vào, chịu trách nhiệm tuân thủ danh sách kiểm tra của Google Cast Design (com.google.android.gms.cast.framework.*)
  • CAF Sender cung cấp các tiện ích tuân thủ các yêu cầu của Cast UX; phiên bản 2 không cung cấp bất kỳ thành phần giao diện người dùng nào và yêu cầu bạn triển khai các tiện ích này.
  • Bạn không cần phải sử dụng GoogleApiClient để sử dụng Cast API nữa.
  • Phụ đề chi tiết trong CAF Sender tương tự như phiên bản 2.

Phần phụ thuộc

V2 và CAF có các phần phụ thuộc giống nhau trên các thư viện hỗ trợ và Dịch vụ Google Play (9.2.0 trở lên) như mô tả trong Hướng dẫn về tính năng của thư viện hỗ trợ

Phiên bản SDK Android tối thiểu mà CAF hỗ trợ là 9 (Gingerbread).

Khởi chạy

Trong CAF, cần có một bước khởi động rõ ràng cho khung Cast. Thao tác này bao gồm việc khởi chạy singleton CastContext, sử dụng OptionsProvider thích hợp để chỉ định mã ứng dụng Web receiver và mọi tuỳ chọn chung khác.

public class CastOptionsProvider implements OptionsProvider {

    @Override
    public CastOptions getCastOptions(Context context) {
        return new CastOptions.Builder()
                .setReceiverApplicationId(context.getString(R.string.app_id))
                .build();
    }

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

Khai báo OptionsProvider trong thẻ "ứng dụng" của tệp AndroidManifest.xml trong ứng dụng:

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

Khởi chạy từng phần CastContext trong phương thức onCreate của từng Hoạt động:

private CastContext mCastContext;

protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.video_browser);
    setupActionBar();

    mCastContext = CastContext.getSharedInstance(this);
}

Những bước này là không cần thiết trong phiên bản 2.

Khám phá thiết bị

Trong CAF, quá trình khám phá do khung bắt đầu và dừng tự động khi ứng dụng xuất hiện ở nền trước và chuyển sang chế độ nền tương ứng. Không nên sử dụng MediaRouteSelectorMediaRouter.Callback.

Nút Truyền và hộp thoại Truyền

Như trong phiên bản 2, các thành phần này do thư viện hỗ trợ MediaRouter cung cấp.

Nút Truyền vẫn được MediaRouteButton triển khai và có thể được thêm vào hoạt động của bạn (sử dụng ActionBar hoặc Toolbar) dưới dạng một mục trong trình đơn trong trình đơn.

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

Ghi đè phương thức onCreateOptionMenu() của từng Hoạt động bằng cách sử dụng CastButtonFactory để kết nối MediaRouteButton với khung Truyền:

private MenuItem mediaRouteMenuItem;

public boolean onCreateOptionsMenu(Menu menu) {
    super.onCreateOptionsMenu(menu);
    getMenuInflater().inflate(R.menu.browse, menu);
    mediaRouteMenuItem =
        CastButtonFactory.setUpMediaRouteButton(getApplicationContext(),
                                                menu,
                                                R.id.media_route_menu_item);
    return true;
}

Khi ai đó nhấn vào nút này, hộp thoại Truyền sẽ tự động hiển thị.

Điều khiển thiết bị

Trong CAF, việc kiểm soát thiết bị chủ yếu do khung xử lý. Ứng dụng người gửi không cần xử lý (và không nên xử lý) việc kết nối với thiết bị và chạy ứng dụng Trình thu nhận web bằng GoogleApiClient. Hoạt động tương tác giữa người gửi và Trình nhận web hiện được biểu thị dưới dạng "phiên". Lớp SessionManager xử lý vòng đời của phiên và tự động bắt đầu cũng như dừng phiên theo cử chỉ của người dùng: một phiên bắt đầu khi người dùng chọn một thiết bị Truyền trong hộp thoại Truyền và kết thúc khi người dùng nhấn vào nút "Dừng truyền" trong hộp thoại Truyền hoặc khi ứng dụng gửi tự chấm dứt. Bạn có thể thông báo cho ứng dụng gửi về các sự kiện trong vòng đời của phiên bằng cách đăng ký SessionManagerListener với SessionManager. Các lệnh gọi lại SessionManagerListener xác định phương thức gọi lại cho tất cả các sự kiện trong vòng đời của phiên.

Lớp CastSession đại diện cho một phiên có Thiết bị truyền. Lớp này có các phương thức để kiểm soát âm lượng của thiết bị và trạng thái tắt tiếng, được thực hiện trước đây trong phiên bản 2 bằng các phương thức trên Cast.CastApi.

Trong phiên bản 2, lệnh gọi lại Cast.Listener đã cung cấp thông báo về các thay đổi đối với trạng thái thiết bị, bao gồm âm lượng, trạng thái tắt tiếng, trạng thái chờ, v.v.

Trong CAF, thông báo về việc thay đổi trạng thái âm lượng/tắt tiếng vẫn được gửi thông qua phương thức gọi lại trong Cast.Listener; những trình nghe này được đăng ký bằng CastSession. Tất cả thông báo về trạng thái thiết bị còn lại đều được gửi qua lệnh gọi lại CastStateListener; những trình nghe này được đăng ký bằng CastSession. Đảm bảo bạn vẫn huỷ đăng ký trình nghe khi các mảnh, hoạt động hoặc ứng dụng liên quan chuyển sang chế độ nền.

Logic kết nối lại

Giống như phiên bản 2, CAF cố gắng thiết lập lại các kết nối mạng bị mất do mất tín hiệu Wi-Fi tạm thời hoặc các lỗi mạng khác. Việc này hiện được thực hiện ở cấp phiên; một phiên có thể chuyển sang trạng thái "bị tạm ngưng" khi mất kết nối và sẽ chuyển trở lại trạng thái "đã kết nối" khi kết nối được khôi phục. Khung này sẽ đảm nhận việc kết nối lại với ứng dụng Trình thu nhận web và kết nối lại bất kỳ kênh Truyền nào trong quá trình này.

Ngoài ra, CAF cũng thêm tính năng tự động tiếp tục phiên được bật theo mặc định (và có thể huỷ kích hoạt thông qua CastOptions. Nếu ứng dụng của người gửi được chuyển tới nền hoặc bị chấm dứt (do vuốt qua hoặc do sự cố) trong khi một phiên Truyền đang diễn ra, thì khung sẽ cố gắng tiếp tục phiên đó khi ứng dụng gửi quay lại nền trước hoặc được chạy lại. SessionManager sẽ tự động xử lý việc này. Lệnh gọi lại thích hợp sẽ được thực hiện trên bất kỳ thực thể SessionManagerListener nào đã đăng ký.

Đăng ký kênh tuỳ chỉnh

Ở phiên bản 2, các kênh tuỳ chỉnh (triển khai bằng cách sử dụng Cast.MessageReceivedCallback) được đăng ký với Cast.CastApi. Trong CAF, các kênh tuỳ chỉnh sẽ được đăng ký bằng thực thể CastSession. Bạn có thể đăng ký bằng phương thức gọi lại SessionManagerListener.onSessionStarted. Đối với các ứng dụng đa phương tiện, bạn không cần phải đăng ký rõ ràng kênh điều khiển nội dung nghe nhìn qua Cast.CastApi.setMessageReceivedCallbacks nữa; hãy xem phần sau để biết thêm thông tin chi tiết.

Điều khiển phương tiện

Lớp v2 RemoteMediaPlayer không được dùng nữa và không nên được sử dụng. Trong CAF, lớp này được thay thế bằng lớp RemoteMediaClient mới, cung cấp chức năng tương đương trong một API thuận tiện hơn. Bạn không cần phải khởi chạy hoặc đăng ký đối tượng này một cách rõ ràng; khung sẽ tự động tạo thực thể cho đối tượng và đăng ký kênh nội dung đa phương tiện cơ bản tại thời điểm bắt đầu phiên nếu ứng dụng Web receiver đang được kết nối để hỗ trợ không gian tên nội dung đa phương tiện.

Bạn có thể truy cập RemoteMediaClient dưới dạng phương thức getRemoteMediaClient của đối tượng CastSession.

Trong phiên bản 2, mọi yêu cầu về nội dung đa phương tiện được đưa ra trên RemoteMediaPlayer sẽ trả về một RemoteMediaPlayer.MediaChannelResult thông qua lệnh gọi lại PendingResult.

Trong CAF, tất cả các yêu cầu về nội dung đa phương tiện được đưa ra trên RemoteMediaClient đều trả về RemoteMediaClient.MediaChannelResult thông qua lệnh gọi lại PendingResult có thể dùng để theo dõi tiến trình và kết quả cuối cùng của yêu cầu.

RemoteMediaPlayer v2 sẽ gửi thông báo về các thay đổi đối với trạng thái trình phát nội dung đa phương tiện trên Trình nhận trên web thông qua RemoteMediaPlayer.OnStatusUpdatedListener.

Trong CAF, RemoteMediaClient cung cấp các lệnh gọi lại tương đương thông qua giao diện RemoteMediaClient.Listener. Bạn có thể đăng ký số lượng trình nghe bất kỳ bằng RemoteMediaClient, cho phép nhiều thành phần người gửi chia sẻ một thực thể duy nhất của RemoteMediaClient được liên kết với phiên.

Trong phiên bản 2, ứng dụng gửi phải đảm nhận việc đồng bộ hoá giao diện người dùng với trạng thái của trình phát nội dung đa phương tiện trên Trình nhận web.

Trong CAF, lớp UIMediaController sẽ đảm nhận hầu hết trách nhiệm này.

Lớp phủ giới thiệu

Phiên bản 2 không cung cấp giao diện người dùng lớp phủ giới thiệu.

CAF cung cấp khung hiển thị tuỳ chỉnh IntroductoryOverlay để làm nổi bật nút Truyền khi người dùng nhìn thấy nút này lần đầu tiên.

Bộ điều khiển mini

Ở phiên bản 2, bạn cần triển khai một bộ điều khiển thu nhỏ từ đầu trong ứng dụng dành cho người gửi.

Trong CAF, SDK cung cấp khung hiển thị tuỳ chỉnh MiniControllerFragment mà bạn có thể thêm vào tệp bố cục ứng dụng của các hoạt động mà bạn muốn hiển thị bộ điều khiển thu nhỏ.

Thông báo và màn hình khoá

Trong phiên bản 2, SDK không cung cấp bộ điều khiển cho thông báo và màn hình khoá. Đối với SDK đó, bạn cần tích hợp các tính năng này vào ứng dụng của người gửi bằng cách sử dụng các API khung Android.

Trong CAF, SDK cung cấp NotificationsOptions.Builder để giúp bạn tạo các chế độ điều khiển nội dung nghe nhìn cho thông báo và màn hình khoá vào ứng dụng của người gửi. Bạn có thể bật các chế độ điều khiển thông báo và màn hình khoá bằng CastOptions khi khởi chạy CastContext.

public CastOptions getCastOptions(Context context) {
    NotificationOptions notificationOptions = new NotificationOptions.Builder()
            .setTargetActivityClassName(VideoBrowserActivity.class.getName())
            .build();
    CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
            .setNotificationOptions(notificationOptions)
            .build();

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

Mở rộng bộ điều khiển

Trong phiên bản 2, bạn cần triển khai một bộ điều khiển mở rộng từ đầu trong ứng dụng của người gửi.

CAF cung cấp một lớp trình trợ giúp UIMediaController giúp bạn dễ dàng xây dựng bộ điều khiển mở rộng của riêng mình.

CAF thêm tiện ích bộ điều khiển mở rộng được tạo sẵn ExpandedControllerActivity mà bạn chỉ cần thêm vào ứng dụng của mình. Bạn không cần phải triển khai một bộ điều khiển mở rộng tuỳ chỉnh bằng cách sử dụng UIMediaController nữa.

Quyền phát âm thanh

Trong phiên bản 2, bạn cần sử dụng MediaSessionCompat để quản lý quyền phát âm thanh.

Trong CAF, quyền phát âm thanh sẽ được quản lý tự động.

Ghi nhật ký gỡ lỗi

Trong CAF, không có tuỳ chọn ghi nhật ký.

Ứng dụng mẫu

Chúng tôi có hướng dẫn trong lớp học lập trìnhứng dụng mẫu sử dụng CAF.