Cider Docs
GitHubTwitterWebsite
  • 👋README
  • docs
    • 1.client
      • Disclaimer
      • Troubleshooting FAQs
      • RPC Documentation
    • 2.other
      • Client Protocol Schema
    • 3.legacy-docs
      • 2.compilation
        • Compiling on Linux
        • Compiling on macOS
        • Compiling on Windows
      • 3.legacy-plugins
        • Additional Links
        • REST API
        • Creating a Basic Plugin
        • documentation
        • Frontend API
        • Publishing to GitHub
        • Renderer
        • Unsorted Features
      • 4.themes
        • Available Attributes
        • Publishing to GitHub
        • Theme Definitions (theme.json)
        • Creating a Theme
        • Using Resources in Themes
Powered by GitBook
On this page
  • URL Schema
  • Additional Protocols

Was this helpful?

Edit on GitHub
Export as PDF
  1. docs
  2. 2.other

Client Protocol Schema

A list of various bits of documentation for the app.

The client uses a set list of protocols, including custom and overriding ones for AM apps. This is a list of all the protocols that the client uses.

  • cider

  • itms

  • itmss

  • music

  • itunes

URL Schema

The URL schema is as follows: protocol://{action}/{type}/{id}

The available actions are:

  • play

  • open

The available types are:

  • s (song)

  • a (album)

  • p (playlist)

  • r (radio)

The ID must be the catalog ID of the item as the library item may not be available.

Additional Protocols

The client also handles additional protocols such as:

  • Apple Music URLs: protocol://music.apple.com/...

  • Our Discord Server: protocol://discord

  • Our GitHub: protocol://github

  • OpenCollective: protocol://donate

  • An AppData URL: protocol://appdata (For troubleshooting)

  • Any standard app route. Such as protocol://settings or protocol://am/home

Previous2.otherNext3.legacy-docs

Last updated 4 months ago

Was this helpful?