Horologist

703 stars
by Google

Horologist is a group of libraries that aim to supplement Wear OS developers with features that are commonly required by developers but not yet available.

View on GitHub

Documentation

Horologist logo

Horologist is a group of libraries that aim to supplement Wear OS developers with features that are
commonly required by developers but not yet available.

Maintained Versions

The currently maintained branches of Horologist are.

Version Branch Min SDK (Wear) Kotlin/JDK Description
0.7.x release-0.7.x 26 2.2.0 / 17 Wear Compose 1.5.x, Compose 1.8.x and generally latest stable Androidx.
0.8.x main 26 2.2 / 17 Wear Compose 1.6.x, Compose 1.9.x and generally latest relevant alphas of Androidx.

Maintenance branches will not delete existing APIs and they should remain stable. However
the main branch will actively update to incorporate new API guidance, removing or changing
APIs.

Build & test (nightly release)
Build & test


🎵 Media

Horologist provides the Media Toolkit: a set of libraries to build Media apps on Wear OS and a
sample app that you can run to see the toolkit in action.

The toolkit is designed using a clean architecture and includes:

  • Core & Playback Modules:
    • horologist-media-core (:media:core): Core domain models, interfaces, and state representations for media playback, agnostic of the underlying player implementation.
    • horologist-media-data (:media:data): Implementation of the domain module using AndroidX Media3.
    • horologist-media3-backend (:media:backend-media3): Background playback service and engine built on Media3, enforcing Wear OS specific routing rules (e.g. requiring Bluetooth output).
  • UI & Presentation Modules:
  • Audio & Volume Modules:
  • Utilities & Services:
    • media:media3-logging: Diagnostic logging utilities for tracking Media3 player events on Wear OS.
    • media:media3-outputswitcher: Output switching and Bluetooth pairing prompt controllers.
    • media:sync: Offline content, download queue, and play state synchronization between phone and watch.
  • Applications & Benchmarks:
    • media sample (:media:sample): Main media player sample app (UAMP clone) showcasing local and streaming music, downloads, volume control, and Navigation 3.
    • media:benchmark & media:sample-benchmark: Macrobenchmarks and performance test suites for the libraries and the sample application.
Player Screen Browse Screen Entity Screen Volume Screen

📅 Composables

High quality prebuilt composables, such as Time and Date pickers.

DatePicker TimePickerWith12HourClock TimePicker
README image
SegmentedProgressIndicator

📐 Compose Layout

Layout related functionality such as a Navigation Aware Scaffold.

fillMaxRectangle()

🔲 Compose Material

Opinionated implementation of the components of
the Wear Material Compose library
, based on the specifications
of Wear Material Design Kit
.

🔐 Auth

Libraries to help developers to build apps following
the Sign-In guidelines for Wear OS
.

DataLayer

The Horologist DataLayer library, provide common abstractions on top of the
Wearable DataLayer.
It includes libraries to build
prompts on the phone to improve
engagement with the correspondent Wear app and a
sample to see the prompts in actions.
Find guidance in the project documentation.

☰ Tiles

Kotlin coroutines flavoured TileService.

horologist-tiles


Why the name?

The name mirrors the Accompanist name, and is also Watch
related.

https://en.wiktionary.org/wiki/horologist

horologist (Noun)
Someone who makes or repairs timepieces, watches or clocks.

Contributions

Please contribute! We will gladly review any pull requests submitted.
Make sure to read the Contributing page to know what our expectations of
contributions are.

License

Copyright 2023 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dispatch Newsletter
Be the first to discover new Compose libraries
Curated Insights
Digest in 5 minutes or less
Android Analysis
Entertaining takes on happenings
Insider Tips
From top Android developers
Hidden Gems
You won't find elsewhere
"
"I enjoy getting Dispatch in my inbox. The content is light, fun, and still useful. I especially appreciate the small tips that are in each issue."
— Annyce Davis
ex-Vice President of Engineering @ Meetup | GDE for Android
Join thousands of Android devs who look forward to Dispatch every week