Skip to content

Widgets

Anjishnu Nandi edited this page Jun 21, 2026 · 2 revisions

Complete guide to setting up and customizing Rhythm's home screen widgets.


๐Ÿ“ฑ Widget Types

Rhythm offers three types of widgets to suit different needs:

Lyrics Widget

  • Purpose: Display current track lyrics on your home screen
  • Real-time: Synced with playback position
  • Compact: Minimal footprint with scrolling text

Modern Glance Widgets

  • Technology: Built with Jetpack Glance framework
  • Design: Material 3 with dynamic theming
  • Layouts: 6 responsive sizes
  • Requirements: Android 8.0+
  • Features: Real-time updates, customizable appearance

Legacy Widgets

  • Technology: Traditional RemoteViews
  • Compatibility: Maximum compatibility across devices
  • Layouts: 7 sizes including 5x5
  • Requirements: Android 8.0+
  • Features: Battery-efficient, theme-adaptive

๐ŸŽจ Glance Widgets (Recommended)

Available Layouts

1. Extra Small (2x1)

  • Size: 110dp ร— 48dp (2ร—1 cells)
  • Features:
    • Song title and artist (scrolling text)
    • Play/pause button
    • Compact horizontal layout
  • Best for: Quick glance at current track

2. Small (2x2)

  • Size: 120dp ร— 120dp (2ร—2 cells)
  • Features:
    • Album artwork
    • Song title and artist
    • Play/pause and skip controls
    • Compact square layout
  • Best for: Minimal home screen footprint

3. Medium (3x2)

  • Size: 250dp ร— 120dp (3ร—2 cells)
  • Features:
    • Album artwork
    • Song title, artist, album
    • Full playback controls
    • Horizontal layout
  • Best for: Standard widget size

4. Wide (4x2)

  • Size: 320dp ร— 120dp (4ร—2 cells)
  • Features:
    • Large album artwork
    • Complete metadata
    • Full playback controls
    • Extended horizontal layout
  • Best for: Wide home screens

5. Large (3x3)

  • Size: 250dp ร— 250dp (3ร—3 cells)
  • Features:
    • Large album artwork
    • Complete track information
    • Full playback controls
    • Vertical layout with maximum info
  • Best for: Dedicated music widget space

6. Extra Large (4x4)

  • Size: 320dp ร— 320dp (4ร—4 cells)
  • Features:
    • Maximum album artwork display
    • All metadata visible
    • Large playback controls
    • Premium visual experience
  • Best for: Music-focused home screen

๐Ÿ“ Legacy Widgets

Available Layouts

  1. Extra Small (2x1): Minimal horizontal strip
  2. Small (2x2): Compact square
  3. Medium (3x2): Standard horizontal
  4. Large (3x3): Large square
  5. Wide (4x2/5x2): Extended horizontal
  6. Extra Large (4x4): Large display
  7. 5x5: Maximum size with full controls

๐Ÿ”ง Adding a Widget

Android 12+

  1. Long-press on your home screen
  2. Tap Widgets
  3. Scroll to find Rhythm Music
  4. Choose between:
    • Rhythm Widget (Glance - Modern)
    • Rhythm Music Widget (Legacy)
  5. Drag to home screen
  6. Resize to desired size using corner handles
  7. Widget auto-updates to optimal layout

Android 8-11

  1. Long-press on empty home screen area
  2. Tap Widgets in popup menu
  3. Find Rhythm in widget list
  4. Long-press and drag widget to home screen
  5. Drop in desired location
  6. Resize using corner/edge handles

โš™๏ธ Widget Customization

Glance Widget Settings

Access widget settings: Rhythm โ†’ Settings โ†’ Widget Settings

Corner Radius

  • Range: 0-32dp
  • Default: 24dp
  • Effect: Rounded corners for modern look
  • Note: Glance widgets only

Transparency

  • Range: 0-100%
  • Default: 85%
  • Effect: Widget background opacity
  • Note: Adapts to wallpaper

Album Art Display

  • Toggle: Show/hide album artwork
  • Default: Enabled
  • Effect: Display current track artwork

Information Display

  • Show/hide song title
  • Show/hide artist name
  • Show/hide album name
  • Customizable metadata visibility

Auto-Update Behavior

Widgets update automatically when:

  • Track changes
  • Playback state changes (play/pause)
  • Metadata is edited
  • Artwork is updated

Update Method: WorkManager background tasks Frequency: Real-time for playback events Battery Impact: Minimal, optimized scheduling


๐ŸŽฏ Widget Controls

Available Actions

Playback Controls

  • Play/Pause: Toggle playback
  • Skip Next: Jump to next track
  • Skip Previous: Return to previous track
  • Tap Album Art: Open Rhythm app

Limitations

  • No seek bar (due to widget size constraints)
  • No volume control (use system controls)
  • No queue management (open app for full features)

๐Ÿ”„ Widget Updates

Real-Time Updates

Widgets update instantly for:

  • โœ… Track changes
  • โœ… Play/pause state
  • โœ… Album artwork changes
  • โœ… Metadata edits

Background Updates

  • Technology: WorkManager periodic tasks
  • Frequency: Event-driven
  • Battery: Optimized with job scheduling
  • Restrictions: Respects Android Doze mode

๐Ÿ› Troubleshooting

Widget Not Updating

Solutions:

  1. Disable Battery Optimization:

    • Settings โ†’ Apps โ†’ Rhythm โ†’ Battery
    • Select "Unrestricted"
  2. Grant Notification Permission:

    • Required for foreground service
    • Settings โ†’ Apps โ†’ Rhythm โ†’ Permissions โ†’ Notifications
  3. Remove and Re-add Widget:

    • Long-press widget โ†’ Remove
    • Add widget again from widget menu
  4. Update Rhythm:

    • Check for latest version
    • Install updates from GitHub/F-Droid

Widget Shows "Loading" or Blank

Causes:

  • App not running in background
  • Permissions not granted
  • Widget cache corruption

Solutions:

  1. Open Rhythm app once
  2. Play a song
  3. Minimize app (don't force close)
  4. Widget should populate

Widget Controls Not Working

Checks:

  • Ensure Rhythm has required permissions
  • Verify app is not force-stopped
  • Check notification access is enabled
  • Restart device if issue persists

Widget Appears Stretched or Cropped

Launcher Compatibility:

  • Some launchers have widget sizing issues
  • Try different widget layout size
  • Use stock launcher for best compatibility
  • Report launcher-specific issues on GitHub

๐Ÿ’ก Best Practices

Optimal Widget Sizes

  • Phone Portrait: 3ร—2 Medium or 4ร—2 Wide
  • Phone Landscape: 4ร—2 Wide or 5ร—2 Extended
  • Tablet: 4ร—4 Extra Large or 5ร—5 Maximum
  • Foldable (Closed): 2ร—2 Small or 3ร—2 Medium
  • Foldable (Open): 4ร—4 or 5ร—5

Battery Optimization

  • Widgets are highly optimized
  • Updates only when necessary
  • No polling for changes
  • Event-driven architecture
  • Minimal battery impact (<1%)

Home Screen Design Tips

  1. Placement: Put widget where you frequently glance
  2. Size: Match widget to your usage (controls vs. artwork)
  3. Theme: Glance widgets auto-adapt to Material You colors
  4. Wallpaper: Choose wallpaper that complements widget transparency
  5. Density: Don't overcrowd home screen with multiple widgets

๐Ÿ”ฎ Upcoming Widget Features

Planned

  • Custom widget themes
  • Multiple widget instances with different settings
  • Lock screen widgets (Android 13+)
  • Queue preview
  • Playback progress bar

๐Ÿ“Š Widget Comparison

Feature Glance Widgets Legacy Widgets
Material 3 Design โœ… Yes โš ๏ธ Limited
Dynamic Theming โœ… Full โš ๏ธ Basic
Customizable Corners โœ… Yes โŒ No
Transparency Control โœ… Yes โŒ No
Layout Count 6 7
Max Size 4ร—4 5ร—5
Battery Efficiency โœ… Optimized โœ… Optimized
Update Speed โšก Instant โšก Instant

Recommendation: Use Glance widgets for modern design and customization.


๐Ÿ”— Related Documentation


Need help? Join our Telegram Community or Discord Server!

Clone this wiki locally