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 người gửi Android từ Cast SDK phiên bản 2 sang 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 hoá đáng kể việc phát triển ứng dụng Cast.

Giới thiệu

  • CAF Sender vẫn được phân phối trong Dịch vụ Google Play bằng trình quản lý SDK Android
  • Các gói mới đã được thêm vào để đảm nhận trách nhiệm tuân thủ Danh sách kiểm tra thiết kế của Google Cast (com.google.android.gms.cast.framework.*)
  • CAF Sender cung cấp các tiện ích tuân thủ yêu cầu về trải nghiệm người dùng của Cast; v2 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 để 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ùng các phần phụ thuộc trên 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ề các 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, bạn cần có một bước khởi chạy rõ ràng cho khung Cast. Việ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 của Trình nhận web 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ẻ "application" 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 mỗi Hoạt động:

private CastContext mCastContext;

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

    mCastContext = CastContext.getSharedInstance(this);
}

Các bước này 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á được khung tự động bắt đầu và dừng khi ứng dụng lần lượt chuyển sang nền trước và nền sau. Bạn không nên sử dụng MediaRouteSelector và MediaRouter.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 được cung cấp bởi thư viện hỗ trợ MediaRouter.

Nút Truyền vẫn được triển khai bằng MediaRouteButton và có thể được thêm vào hoạt động của bạn (bằng cách sử dụng ActionBar hoặc Toolbar), dưới dạng một mục 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 mỗi Hoạt động bằng cách sử dụng CastButtonFactory để kết nối MediaRouteButton với khung Cast:

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 người dùng nhấn vào nút này, hộp thoại Truyền sẽ tự động xuất hiện.

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

Trong CAF, việc điều khiển thiết bị chủ yếu do khung xử lý. Ứng dụng gửi không cần xử lý (và không nên cố gắng xử lý) việc kết nối với thiết bị và chạy ứng dụng Trình 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 một "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 các phiên để phản hồi 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 chính ứng dụng của người gửi chấm dứt. Ứng dụng của người gửi có thể được thông báo về các sự kiện trong vòng đời của phiên bằng cách đăng ký SessionManagerListener với SessionManager. Lệnh gọi lại SessionManagerListener xác định các phương thức gọi lại cho tất cả sự kiện trong vòng đời của phiên.

Lớp CastSession đại diện cho một phiên hoạt động với thiết bị Truyền. Lớp này có các phương thức để kiểm soát âm lượng và trạng thái tắt tiếng của thiết bị, vốn được thực hiện 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 thay đổi trạng thái âm lượng/tắt tiếng vẫn được gửi qua các phương thức gọi lại trong Cast.Listener; các trình nghe này được đăng ký bằng CastSession. Tất cả thông báo còn lại về trạng thái thiết bị đều được gửi qua lệnh gọi lại CastStateListener; các trình nghe này được đăng ký với CastSession. Hãy nhớ huỷ đăng ký trình nghe khi các mảnh, hoạt động hoặc ứng dụng liên kết 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 về 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 mọi kênh Truyền 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ể bị huỷ kích hoạt thông qua CastOptions. Nếu ứng dụng của người gửi được chuyển sang chế độ nền hoặc bị chấm dứt (bằng cách vuốt đi hoặc do sự cố) trong khi phiên Truyền đang diễn ra, thì khung sẽ cố gắng tiếp tục phiên đó khi ứng dụng của người gửi quay lại nền trước hoặc được chạy lại; việc này được SessionManager tự động xử lý, từ đó sẽ đưa ra các lệnh gọi lại thích hợp trên mọi thực thể SessionManagerListener đã đăng ký.

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

Trong phiên bản 2, các kênh tuỳ chỉnh (được triển khai bằng Cast.MessageReceivedCallback) được đăng ký với Cast.CastApi. Trong CAF, các kênh tuỳ chỉnh được đăng ký bằng thực thể CastSession. Bạn có thể thực hiện việc đăng ký trong 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 thông qua Cast.CastApi.setMessageReceivedCallbacks nữa; hãy xem phần sau để biết thêm 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 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 nghe nhìn cơ bản tại thời điểm bắt đầu phiên nếu ứng dụng Trình nhận web đang kết nối hỗ trợ không gian tên nội dung nghe nhìn.

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

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

Trong CAF, tất cả yêu cầu về nội dung nghe nhìn được đưa ra trên RemoteMediaClient đều trả về một RemoteMediaClient.MediaChannelResult thông qua lệnh gọi lại PendingResult. Lệnh gọi lại này 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 phiên bản 2 sẽ gửi thông báo về các thay đổi trong trạng thái trình phát nội dung nghe nhìn trên Trình nhậ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ỳ với RemoteMediaClient. Điều này cho phép nhiều thành phần của 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 của người 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 nghe nhìn trên Trình nhận web.

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

Lớp phủ giới thiệu

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

CAF cung cấp một chế độ xem tuỳ chỉnh IntroductoryOverlay để làm nổi bật nút Truyền khi nút này xuất hiện lần đầu tiên cho người dùng.

Trình điều khiển thu nhỏ

Trong 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 của người gửi.

Trong CAF, SDK cung cấp một chế độ xem tuỳ chỉnh, MiniControllerFragment, bạn có thể thêm chế độ xem này 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 gửi bằng cách sử dụng API khung Android.

Trong CAF, SDK cung cấp một NotificationsOptions.Builder để giúp bạn tạo các nút đ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 nút đ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();
}

Bộ điều khiển mở rộng

Trong phiên bản 2, bạn cần triển khai 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ợ 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 một tiện ích trình điều khiển mở rộng tạo sẵn ExpandedControllerActivity mà bạn có thể 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 trình điều khiển mở rộng tuỳ chỉnh bằng UIMediaController nữa.

Tập trung âm thanh

Trong phiên bản 2, bạn cần sử dụng MediaSessionCompat để quản lý tiêu điểm âm thanh.

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

Ghi nhật ký gỡ lỗi

Trong CAF, không có lựa chọn ghi nhật ký.

Ứng dụng mẫu

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