Thiết lập Định dạng mặt đồng hồ

Hướng dẫn này bao gồm các bước sử dụng công cụ cần thiết để định cấu hình mặt đồng hồ bằng Định dạng mặt đồng hồ, một số đề xuất về cấu trúc dự án và hướng dẫn từng bước để áp dụng các công cụ nhằm tạo ra cấu trúc đó.

Điều kiện tiên quyết

Để chuẩn bị môi trường phát triển cho việc sử dụng Định dạng mặt đồng hồ, hãy hoàn tất các bước thiết lập sau đây:

  1. Cài đặt SDK cho Android 13 (API cấp 33) trở lên. SDK cũng chứa các công cụ cần thiết khác, bao gồm cả aapt2 và android.jar.
  2. Cài đặt chương trình dòng lệnh bundletool.
  3. Ký phiên bản gỡ lỗi của ứng dụng chứa thiết kế mặt đồng hồ. Bạn có thể tạo Android App Bundle đã ký trong Android Studio hoặc có thể ký bản gỡ lỗi theo cách thủ công.

Cấu trúc dự án

Khi bạn tạo mặt đồng hồ tuỳ chỉnh sử dụng Định dạng mặt đồng hồ, Android App Bundle chứa tệp mặt đồng hồ tuỳ chỉnh phải hoàn toàn tách biệt với Android App Bundle chứa logic của ứng dụng Wear OS. Một số cửa hàng ứng dụng (bao gồm cả Google Play) ngăn bạn tải Android App Bundle lên, trong đó có logic Wear OS và mặt đồng hồ tuỳ chỉnh.

Tạo gói ứng dụng cho mặt đồng hồ

Để tạo tệp Android App Bundle chứa tệp mặt đồng hồ, hãy hoàn tất các bước được trình bày trong những phần sau.

Khai báo việc sử dụng Định dạng mặt đồng hồ

Trong tệp kê khai của ứng dụng mới (AndroidManifest.xml), hãy thêm một thuộc tính ứng dụng cho biết bạn sử dụng Định dạng mặt đồng hồ:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<manifest ...>
    <application ...>
        <property
            android:name="com.google.wear.watchface.format.version"
            android:value="1" />
    </application>
</manifest>

Khai báo siêu dữ liệu mặt đồng hồ

Trong thư mục tài nguyên res/xml của ứng dụng, hãy tạo một tệp mới tên là watch_face_info.xml. Đây là nơi bạn xác định siêu dữ liệu của mặt đồng hồ:

<?xml version="1.0" encoding="utf-8"?>
<WatchFaceInfo>
    <!-- Only "Preview" is required. -->
    <Preview value="@drawable/watch_face_preview" />
    <Category value="CATEGORY_EMPTY" />
    <AvailableInRetail value="true" />
    <MultipleInstancesAllowed value="true" />
    <Editable value="true" />
</WatchFaceInfo>

Các trường trong tệp này đại diện cho các thông tin sau:

Preview
Đề cập đến đối tượng có thể vẽ chứa hình ảnh xem trước của mặt đồng hồ.
Category

Xác định danh mục của mặt đồng hồ. Phải là chuỗi hoặc tham chiếu đến chuỗi, chẳng hạn như @string/ref_name. Mỗi nhà sản xuất thiết bị có thể xác định một tập hợp danh mục mặt đồng hồ riêng.

Giá trị mặc định: empty_category_meta để nhóm mặt đồng hồ này với các mặt đồng hồ thuộc "danh mục trống" khác ở cuối chế độ xem bộ chọn mặt đồng hồ.

AvailableInRetail

Liệu mặt đồng hồ có dùng được ở chế độ giới thiệu bán lẻ của thiết bị hay không. Phải là giá trị boolean hoặc tham chiếu đến giá trị boolean như @bool/watch_face_available_in_retail.

Giá trị mặc định: false

MultipleInstancesAllowed

Liệu mặt đồng hồ có thể có nhiều mục yêu thích hay không. Phải là giá trị boolean hoặc tham chiếu đến giá trị boolean như @bool/watch_face_multiple_instances_allowed.

Giá trị mặc định: false

Editable

Liệu mặt đồng hồ có chỉnh sửa được hay không, tức là mặt đồng hồ có một chế độ cài đặt hoặc ít nhất là một chức năng không cố định. Nút này dùng để hiện hoặc ẩn nút Edit (Chỉnh sửa) cho mặt đồng hồ trong danh sách yêu thích.

Giá trị mặc định: false

Khai báo tên mặt đồng hồ

Trong tệp kê khai của ứng dụng (AndroidManifest.xml), hãy đặt thuộc tính android:label thành tên của mặt đồng hồ:

<application android:label="@string/watch_face_name" >

Khai báo tính năng hỗ trợ hình dạng mặt đồng hồ

Trong thư mục tài nguyên res/xml của ứng dụng, hãy khai báo tập hợp các hình dạng mặt đồng hồ mà bạn hỗ trợ:

<WatchFaces>
    <!-- The default shape is "CIRCLE". -->
    <WatchFace shape="CIRCLE" width="300" height="300"
               file="@raw/watchface"/>
    <WatchFace shape="CIRCLE" width="450" height="450"
               file="@raw/watchface_large_circle"/>
    <WatchFace shape="RECTANGLE" width="380" height="400"
               file="@raw/watchface_rectangle"/>
</WatchFaces>

Khai báo thông tin chi tiết về mặt đồng hồ

Trong thư mục tài nguyên res/raw của ứng dụng, hãy tạo các tệp tương ứng với giá trị thuộc tính file dùng khi bạn khai báo tính năng hỗ trợ cho các hình dạng mặt đồng hồ. Đây là nơi bạn xác định giao diện và hành vi của mặt đồng hồ cho từng hình dạng mặt đồng hồ.

Sử dụng ví dụ từ trang này, các tệp XML thô sẽ là:

  • res/raw/watchface.xml
  • res/raw/watchface_large_circle.xml
  • res/raw/watchface_rectangle.xml

Phần tử gốc luôn là WatchFace:

<WatchFace width="450" height="450" shape="CIRCLE">
    <!-- Remainder of your Watch Face Format definition here. -->
    <!-- If this file defines a watch face for a circular device shape, place
         resources used in this file in the "/res/drawable-nodpi" directory. -->
    <!-- If this file defines a watch face for a rectangular or other
         non-circular shape, place resources ued in this file in the
         "/res/drawable-notround-nodpi" directory. -->
</WatchFace>

Xác định nhà xuất bản mặt đồng hồ (không bắt buộc)

Trong tệp kê khai của ứng dụng, bạn có thể khai báo (không bắt buộc) một chuỗi tuỳ ý dùng để xác định nhà xuất bản của mặt đồng hồ, hoặc tên và phiên bản công cụ mà bạn đang sử dụng:

<application ...>
    ...
    <property
        android:name="com.google.wear.watchface.format.publisher"
        android:value="{toolName}-{toolVersion}" />
</application>

Tạo gói ứng dụng trên mặt đồng hồ

Để tạo Android App Bundle chứa mặt đồng hồ, hãy sử dụng bundletool. Tìm hiểu thêm về cách tạo ứng dụng bằng bundletool.

Xem mẫu GitHub để biết cách chuẩn bị gói ứng dụng cho việc phát hành, cũng như công cụ xác thực để kiểm tra tính chính xác trước khi gửi đến Google Play.