Configuração do formato do mostrador do relógio

Observação: esta página mostra uma etapa do processo para gerenciar manualmente a configuração do mostrador do relógio. Se você quiser projetar o mostrador do relógio usando uma ferramenta do tipo WYSIWYG (o que você vê é o que você tem), confira primeiro os guias do Watch Face Studio.

Este guia inclui etapas sobre as ferramentas necessárias para configurar um mostrador de relógio usando o formato de mostrador do relógio, algumas sugestões sobre a estrutura do projeto e um guia detalhado para aplicar as ferramentas e criar essa estrutura.

Pré-requisitos

Para preparar seu ambiente de desenvolvimento para o uso do formato de mostrador do relógio, realize as seguintes etapas de configuração:

  1. Instale o SDK para o Android 14 (nível 34 da API) ou versões mais recentes. Se o mostrador do relógio não depender de recursos ou comportamento específicos da versão 2, você poderá instalar o SDK para o Android 13 (nível 33 da API).

    O SDK contém outras ferramentas necessárias, incluindo aapt2 e android.jar.

  2. Como alternativa, instale o Android Studio, que também pode fornecer essas ferramentas.

Estrutura do projeto

Quando você cria um mostrador personalizado que usa o formato de mostrador do relógio, o Android App Bundle que inclui o arquivo de mostrador personalizado precisa ser completamente separado do Android App Bundle que contém a lógica do seu app para Wear OS. Algumas app stores, incluindo o Google Play, impedem que você faça upload de um Android App Bundle que inclua a lógica do Wear OS e um mostrador do relógio personalizado.

Criar pacote de mostrador do relógio

Para criar um Android App Bundle que tenha um arquivo de mostrador do relógio, siga as etapas mostradas nas seções a seguir.

Declarar o uso do formato de mostrador do relógio

No arquivo de manifesto do novo app (AndroidManifest.xml), adicione uma propriedade que indique o uso do formato do mostrador do relógio. A menos que você queira restringir o acesso ao mostrador do relógio para dispositivos com o Wear OS 5 ou mais recente, crie dois APKs de mostrador do relógio diferentes, um compatível com a versão 2 e outro com a versão 1. Saiba como configurar as versões do seu app.

<manifest ...>
    <!--
        Use SDK version 34 for version 2 of WFF, and SDK version 33 for version
        1 of WFF
    -->
    <uses-sdk
        android:minSdkVersion="34"
        android:targetSdkVersion="34" />

    <!--
        WFF is a resource-only format, so the hasCode attribute should be set to
        false to reflect this.
    -->
    <application
        android:label="@string/watch_face_name"
        android:hasCode="false"
        ...>
        <meta-data android:name="com.google.android.wearable.standalone"
            android:value="true" />
        <property
            android:name="com.google.wear.watchface.format.version"
            android:value="2" />
    </application>
</manifest>

Declarar metadados do mostrador do relógio

No diretório de recursos res/xml do app, crie um novo arquivo chamado watch_face_info.xml. É nesse arquivo que você define os metadados do mostrador do relógio:

<?xml version="1.0" encoding="utf-8"?>
<WatchFaceInfo>

    <Preview value="@drawable/watch_face_preview" />
    <Category value="CATEGORY_EMPTY" />
    <AvailableInRetail value="true" />
    <MultipleInstancesAllowed value="true" />
    <Editable value="true" />
</WatchFaceInfo>

Os campos do arquivo representam os seguintes detalhes:

Preview
Faz referência ao drawable que contém uma imagem de visualização do mostrador do relógio.
Category

Define a categoria do mostrador do relógio. Precisa ser uma string ou uma referência a uma string, como @string/ref_name. Cada fabricante de dispositivo pode definir o próprio conjunto de categorias de mostradores de relógio.

Valor padrão: empty_category_meta, que agrupa esse mostrador do relógio com outros mostradores de "categoria vazia" na parte inferior da visualização do seletor.

AvailableInRetail

Indica se o mostrador do relógio está disponível no modo de demonstração na loja do dispositivo. Precisa ser um valor booleano ou uma referência a um valor booleano, como @bool/watch_face_available_in_retail.

Valor padrão: false

MultipleInstancesAllowed

Indica se o mostrador do relógio pode ter vários favoritos. Precisa ser um valor booleano ou uma referência a um valor booleano, como @bool/watch_face_multiple_instances_allowed.

Valor padrão: false

Editable

Indica se o mostrador do relógio é editável, o que significa que ele tem uma configuração ou pelo menos um complemento não fixa. Isso é usado para mostrar ou ocultar o botão Edit do mostrador do relógio na lista de favoritos.

Valor padrão: false

Declarar o nome do mostrador do relógio

No arquivo de manifesto do app (AndroidManifest.xml), defina o atributo android:label como o nome do mostrador do relógio:

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

Declarar detalhes do mostrador do relógio

A estrutura de um documento de mostrador de relógio WFF básico é a seguinte:

<WatchFace width="450" height="450">
  <Scene>
    <!-- Content to be rendered -->
  </Scene>
</WatchFace>

Crie esse arquivo XML como res/raw/watchface.xml ao criar o mostrador do relógio, se estiver trabalhando com um único mostrador. Para oferecer suporte a diferentes formas e tamanhos de tela, declare suporte a várias formas e tamanhos.

O elemento raiz é sempre WatchFace. height e width definem a extensão do espaço de coordenadas para uso no mostrador do relógio, e o mostrador é dimensionado para caber no dispositivo em que está sendo usado. height e width não representam pixels reais.

O Formato do mostrador do relógio organiza vários detalhes sobre o mostrador do relógio:

  • Metadados, como a hora e a contagem de passos que aparecem na imagem de prévia do mostrador do relógio.
  • Configurações do usuário, como temas de cores diferentes para o mostrador do relógio, elementos que podem ser ativados pelo usuário e uma escolha entre vários elementos. A versão 2 do formato do mostrador do relógio apresenta variantes, que podem aparecer em uma configuração do usuário. Cada versão especifica uma configuração predefinida do usuário, especificando o tipo e o estilo dos elementos que aparecem com o horário no mostrador do relógio. Essas predefinições facilitam a criação de grupos de elementos agradáveis visualmente. No app complementar para Wear OS, os usuários veem os diferentes tipos do mostrador do relógio em uma linha rolável.
  • Uma cena que contém os elementos visuais de um mostrador do relógio. Os elementos que aparecem mais próximos do fim da cena aparecem sobre outros elementos. Portanto, a ordem típica é a seguinte:
    • Os ponteiros de um relógio analógico ou o texto de um relógio digital
    • Complicações que mostram informações adicionais, como o dia da semana ou a contagem de passos de um usuário
    • Outros gráficos que oferecem interesse visual ou decorações para o mostrador do relógio, como uma imagem de um acampamento
  • Grupos de elementos, que permitem modificar vários elementos ao mesmo tempo. É possível criar variantes desses grupos em uma cena, o que permite esconder ou modificar seletivamente o conteúdo quando o sistema entra em um modo ambiente de economia de energia.

Os atributos são fortemente definidos e têm diretrizes sobre frequência e valores válidos para evitar a maioria dos erros comuns ao criar um mostrador de relógio.

Declarar suporte a formas do mostrador do relógio (opcional)

Essa etapa só é necessária se você quiser oferecer suporte a comportamentos diferentes para tamanhos diferentes de mostradores do relógio. Pule esta etapa se você quiser que o mostrador do relógio seja dimensionado de acordo com o tamanho do relógio.

No diretório de recursos res/xml do app, declare o conjunto de formas de mostrador do relógio que você aceita em watch_face_shapes.xml:

<WatchFaces>

    <WatchFace shape="CIRCLE" width="300" height="300"
               file="@raw/watchface"/>
    <WatchFace shape="CIRCLE" width="450" height="450"
               file="@raw/watchface_large_circle"/>

    <!-- Remove any references to rectangular watch faces -->
    <WatchFace shape="RECTANGLE" width="380" height="400"
               file="@raw/watchface_rectangle"/>
</WatchFaces>

Em seguida, defina a aparência e o comportamento do mostrador do relógio para cada formato. Se você não tiver definido um arquivo de formas, só vai precisar criar um arquivo, watchface.xml.

Usando o exemplo desta seção, os arquivos XML brutos seriam:

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

Identificar o editor do mostrador do relógio (opcional)

Como opção, declare uma string arbitrária no arquivo de manifesto do seu app para identificar o editor do mostrador do relógio ou o nome e a versão da ferramenta que você está usando:

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

Verificar a correção e o desempenho do mostrador do relógio

Durante o desenvolvimento e antes de fazer o upload para o Google Play, use as ferramentas de validação para verificar se o mostrador do relógio está livre de erros e se ele obedece às recomendações de uso de memória.

Criar o pacote de apps do mostrador do relógio

Para criar o Android App Bundle que contém o mostrador do relógio, use o sistema de build do Gradle. Saiba mais sobre como criar um app usando o Gradle.

Isso é demonstrado nos exemplos do GitHub.