■■■ What is URL scheme ■■■

URL scheme is a mechanism for launching an application using URL. It is also used to control an application by adding parameters to the URL.
Rabbit Player has supported URL scheme since version 1.3.0.

■■■ How to use URL scheme ■■■

- Type in the address field of Safari on iOS.
- Using a launcher app for iOS.

■■■ Basic format ■■■

■ Execute one command
rabbitplayer://command

■ Execute one command with one option
rabbitplayer://command?option=value

■ Execute one command with more than one option
rabbitplayer://command?option1=value1&option2=value2

■ Execute multiple commands
rabbitplayer://command1?option=value;command2

■■■ Usage examples ■■■

■ Launch the Rabbit Player simply
rabbitplayer://

■ Play music
rabbitplayer://play

■ Pause music
rabbitplayer://pause

■ Like the currently playing song
rabbitplayer://like

■ Clear the play queue
rabbitplayer://clear

■ Add all songs of the tag "Soundtrack" to the play queue
rabbitplayer://add?tag=Soundtrack

■ After clearing the play queue, add all songs of the tag "Soundtrack" and start playback
rabbitplayer://clear;add?tag=Soundtrack;play

■■■ Command list ■■■

The inside of [] is abbreviation. Abbreviations can also be used as command.

■ play[p]
Play music.

■ play-toggle[pt]
Toggle play/pause.

■ pause[pa, stop, s]
Pause music.

■ next[n]
Play the next song.

■ prev[back, b]
Play the previous song.

■ like[l]
Add Like to the currently playing song.

■ dislike[d]
Add Dislike to the currently playing song.

■ set?<Configuration options>
Change various settings. The following options are available.

---------- Configuration options ------------
A list of configuration options that can be used with the set command.

It is used as follows.
rabbitplayer://set?repeat=all

◆ repeat=(none, one, all)
Switch repeat mode.

◆ random=(none, shuffle, random)
Switch random mode.

◆ crossfade=(on, off)
Toggle crossfade ON/OFF.

◆ reverb=(on, off)
Toggle reverb ON/OFF.

◆ eq=(on, off)
Toggle equalizer ON/OFF.
-------------------------------------------------------

■ clear[c]
Clear the play queue.

■ add[a]?<Song specification option>
Add songs specified in the <Song specification option> to the play queue (it will not duplicate).

■ add-force[af]?<Song specification option>
Same as add command, but duplicate addition is possible.

■ remove[r]?<Song specification option>
Remove songs specified in the <Song specification option> from the play queue.

■ filter-include[fi]?<Song specification option>
Make the play queue only songs with specified in the <Song specification option>.

■ filter-exclude[fe]?<Song specification option>
Make the play queue only songs without specified in the <Song specification option>. (same as remove command)

--------------- <Song specification option> ---------------
The following options are available for add, add-force, remove, filter-include, and filter-exclude command.

It is used as follows.
rabbitplayer://add?tag=soundtrack

◆ song[s]=name
One song most matching the specified name.

◆ album[a]=name
All songs of the album that best matches the specified name.

◆ artist[ar]=name
All songs of the artist that best matches the specified name.

◆ tag[t]=name
All songs of the tag that most closely match the specified name.

◆ playlist[p]=name
All songs of the playlist (Rabbit Player or iTunes) that most closely matches the specified name.

◆ playlist-rabbit[pr]=name
◆ playlist-itunes[pi]=name
It is the same as playlist option, but in the case of -rabbit, it is searches only from playlists of Rabbit Player, in case of -itunes it searches only from playlists of iTunes.

Adding s to the option name makes it possible to match multiple targets.

For example, in the following cases, all songs that including "rain" are added to the play queue.
rabbitplayer://add?songs=rain

The following is option list with appending s.

◆ songs[ss]=name
◆ albums[as]=name
◆ artists[as]=name
◆ tags[ts]=name
◆ playlists[ps]=name
◆ playlists-rabbit[psr]=name
◆ playlists-itunes[psi]=name
---------------------------------------------------------------