Last Modified : 2025-02-16

Music

The Music component allows you to define a song of your choice that will play when you enter the zone associated with it.

The music is looped infinitely, so you can enjoy it as long as you remain in the zone. It plays in the background, allowing you to use other applications without interruption.

If the default loop behavior doesn't suit your needs, you can define checkpoints (referred to as levels) in your music playback. When the music reaches the end, it will restart from the last checkpoint instead of the beginning.

Music levels (checkpoints) are described in more detail below.

Music Levels in Music Player Page
Music Levels in Music Player Page

The Music component consists of the following:

Field Description
Music The location of the music file you want to play. Note that if you delete or move the file on your device, the application will no longer be able to play it, and you will need to update the file path.
Music Levels Also known as checkpoints, these are timestamps in your music where playback progress is saved. For example, if you leave the zone and return later, or if the music reaches the end, playback will resume from the last checkpoint. The base level [00:00] is always included by default.

Music Levels

Music levels allow you to save the playback progress of your music. When the music is replayed, it will start from the last level reached rather than the beginning. This is particularly useful for music with distinct sections (e.g., part 1, part 2, etc.).

When you leave the zone, the last level reached is saved. However, a timeout mechanism is in place: if you stay outside the zone for too long, the saved level will gradually decrement until it reaches the base level [00:00]. The timeout duration is determined by the time difference between the saved level and the previous level.

To create a new music level, play the music in the Music Player. When you reach the desired timestamp, click the button below to save it as a new level. You can pause the music for precision or manually edit the timestamp for accuracy.

Save Music Level
Save the current timestamp as a new music level.

Example

To illustrate, consider a music track with three levels: [00:00], [03:00], [08:00].

When you enter the zone for the first time, the music starts from the base level [00:00].

After 3 minutes, the music reaches the second level [03:00]. After another 5 minutes, it reaches the third level [08:00].

If you leave the zone after 1 minute at the third level, the saved level is [08:00], and the timeout is 5 minutes (the difference between 08:00 and 03:00). You must re-enter the zone within this time to resume from the third level.

If you re-enter within the timeout, the music resumes from the third level. If not, the saved level decrements to the second level [03:00], and the new timeout becomes 3 minutes (the difference between 03:00 and 00:00).

If you still don’t re-enter within this new timeout, the saved level decrements to the base level [00:00], and the timeout is removed since the base level cannot be decremented further.

The total timeout from the third level to the base level is 8 minutes, which corresponds to the timestamp of the last level [08:00].

Relation with Parent zone Music

When you enter a zone, its associated music plays. If the zone has a parent zone, the parent zone’s music will not play, but it will track your progress through the music levels.

This means that if your current music level increases, the parent zone’s music level will also increase (if a corresponding level exists).

Example

For example, suppose your music has three levels: [00:00], [03:00], [08:00], and the parent zone’s music has two levels: [00:00], [15:00].

When you enter the zone for the first time, the music starts from the base level [00:00].

After 3 minutes, the music reaches the second level [03:00], and the parent zone’s music level increments to [15:00].

If you leave the zone and enter the parent zone, the music will start from the second level [15:00].

If you continue in the child zone and reach the third level [08:00], the parent zone's music level remains at [15:00] since it has no corresponding third level.

If you leave both zones, each zone has its own timeout:

  • Child zone: Timeout is 5 minutes (08:00 - 03:00)
  • Parent zone: Timeout is 15 minutes (15:00 - 00:00)

Default Music

The default music is an optional track that plays when you are not in any zone. You can configure it in the application settings.