Symfonium API (Allow control from other apps like tasker)

Symfonium exposes an API that allows other applications to interact with it.

The API is accessible via a Broadcast receiver, so all you need to do is send proper broadcast intents.

The receiver component name is “app.symfonik.music.player/app.symfonium.remote.api.ApiReceiver”

For apps that split the component this give:

• Package : “app.symfonik.music.player”
• Class: “app.symfonium.remote.api.ApiReceiver”
• Type: Broadcast

Fill the action value of the Intent to the API you want to call, and fill in the extras as documented below.

Change renderer

• Action: “app.symfonium.api.SELECT_RENDERER”
• Extras :
  • “TYPE” [Int]: The renderer type Possible value:
    • 0 : Local device
    • 1: UPnP Player
    • 3 : Chromecast Player
    • 6 : Remote Media Center
  • “IDENTIFIER” [String/Optional]: The renderer unique ID The value can be seen from the cast screen by pressing the (i) button, you can long press the renderer to automatically copy the value to the clipboard. (Only optional to return to Local device)

Force sync

• Action: “app.symfonium.api.MEDIA_SYNC”
• Extras :
  • “PROVIDER_ID” [Int]: The provider ID (Can be seen in the bottom sheet menu of providers in settings)

Playback control

• Action: “app.symfonium.api.MEDIA_COMMAND”
• Extras :
  • “COMMAND” [String]: The command you want to send Possible value:
    • “play”
    • “pause”
    • “stop”
    • “next”
    • “previous”
    • “shuffle”
    • “repeat”
    • “mute”
    • “togglemute”
    • “seek_relative” (relative position in seconds as int parameter)
    • “seek” (position in seconds as int parameter)
    • “volume” (Volume as int parameter)
    • “set_sleeptimer” (Delay in minutes as int parameter) Requires v6.0+
    • “remove_sleeptimer” Requires v6.0+
  • “INT_PARAMETER” [Int/Optional]: An int value for the commands that requires it

Media start

• Action: “app.symfonium.api.MEDIA_START”
• Extras :
  • “MEDIA_TYPE” [String]: The media type to start Possible value:
    • “playlist”
    • “artist”
    • “album”
    • “genre”
    • “song”
    • “song_mix”
    • “album_mix”
    • “internet_radio” Requires v11.2+
  • “NAME” [String/Optional]: The name of the media (Optional for songs if you provide the filename). Requires v1.9+
  • “ALBUM” [String/Optional]: The album of the media for disambiguation. Requires v14.1+
  • “ARTIST” [String/Optional]: The artist of the media for disambiguation. Requires v14.1+
  • “ID” [Long/Optional]: The Id of the radio or the playlist (optional if you pass the name). Requires v11.2+
  • “FILE” [String/Optional]: The full path of the media for songs only. Requires v1.9+
  • “RESUME” [Boolean/Optional]: If the media should be resumed if possible.
  • “SHUFFLE” [Boolean/Optional]: For media groups like playlist / genre if the content should be shuffled.
  • “QUEUE” [Int/Optional]: 1 to queue the media just after currently playing one. 2 to queue the media at the end of playlist. Requires v1.8+

Setting change

Requires v1.10+

• Action: “app.symfonium.api.CHANGE_SETTINGS”
• Extras :

  • “SETTING” [String]: The setting to change

    Possible value:

    • “wifi_transcode” : Wifi transcoding bitrate
    • “mobile_transcode” : Mobile transcoding bitrate
    • “available_offline” : Available offline filter Requires v3.2+
    • “hide_status_bar” : Toggle hide status bar Requires v14.0+
    • “ignore_camera_hole” : Toggle ignore camera hole Requires v14.0+

  • “INT_PARAMETER” [Int]: Transcoding value

 Possible value for sleep timer wait end of song, hide status bar and ignore_camera_hole:
 * 0 : Disabled
 * 1 : Enabled

 Possible value for offline filter:
 * 0 : Filter disabled
 * 1 : Filter enabled

Possible value for transcoding:
 * -1 : No transcoding
 * 1 : 64 Kbps
 * 2 : 96 Kbps
 * 3 : 128 Kbps
 * 4 : 160 Kbps
 * 5 : 192 Kbps
 * 6 : 256 Kbps
 * 7 : 320 Kbps

Playlist import

Requires v8.0+

Import the playlists from a supported media provider. Existing playlists are automatically skipped.

• Action: “app.symfonium.api.PLAYLIST_IMPORT”
• Extras :
  • “PROVIDER_ID” [Int]: The provider ID (Can be seen in the bottom sheet menu of providers in settings)
  • “PLAYLIST_TYPE” [Int]: Imported playlist type
    • 1: Offline first
    • 2: Read only
    • 3: Online first

Regenerate playlist thumbnail

Requires v11.3+

Update the playlist thumbnail based on the songs thumbnails it contains.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “generate_playlist_thumbnail”
  • “LONG_PARAMETER” [Long]: The playlist ID (Can be seen at the top of the playlist action bottom sheet)

Update playlist stable random sort

Requires v12.1+

Update the playlist thumbnail based on the songs thumbnails it contains.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “refresh_playlist_stable_random”
  • “LONG_PARAMETER” [Long]: The playlist ID (Can be seen at the top of the playlist action bottom sheet)

Load a media queue

Requires v12.0+

Load a media queue and optionally resume playback.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “load_media_queue”
  • “LONG_PARAMETER” [Long]: The ID of the media queue. (Can be seen by pressing the info icon in the media queue bottomsheet.
  • “RESUME” [Boolean]: true to resume playback after loading the queue.

Regenerate genre thumbnail

Requires v11.5+

Update the genre thumbnail based on the songs thumbnails it contains.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “generate_genre_thumbnail”
  • “NAME” [String]: The genre name (Note: You can use the special “--ALL--” value to regenerate all genres thumbnails, beware of duration and battery usage)

Cleanup offline cache

Requires v11.3+

Trigger the Cleanup action from manage offline cache.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “cleanup_offline_cache”

Start backup

Requires v11.3+

Start a backup with the selected settings (Password and at least one option must be passed)

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “start_backup”
  • “PASSWORD” [String]: The backup password. MANDATORY
  • “SETTINGS” [Boolean]: If the backup should contain this.
  • “PROVIDERS” [Boolean]: If the backup should contain this.
  • “EQ_PROFILES” [Boolean]: If the backup should contain this.
  • “INTERNET_RADIO” [Boolean]: If the backup should contain this.
  • “PLAYLISTS” [Boolean]: If the backup should contain this.
  • “AUTO_OFFLINE_RULES” [Boolean]: If the backup should contain this.
  • “USER_DATA” [Boolean]: If the backup should contain this.
  • “USER_DATA_ALL” [Boolean]: If the backup should contain all user data (Requires also user data to be enabled)
  • “CUSTOM_IMAGES” [Boolean]: If the backup should contain this.
  • “FILE_FAVORITES” [Boolean]: If the backup should contain this.
  • “TAG_CACHE” [Boolean]: If the backup should contain this.

Change provider active connection

Requires v13.4+

Force a provider to use it’s primary or secondary connection.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “force_provider_connection”
  • “PROVIDER_ID” [Long]: The ID of the provider. MANDATORY
  • “ACTIVE_CONNECTION” [Int]: 1 for primary connection, 2 for secondary connection. MANDATORY.

Regenerate artists thumbnail

Requires v13.5+

Update the artist thumbnail based on the songs thumbnails it contains.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “generate_artist_thumbnail”
  • “ONLY_MISSING_THUMBNAIL” [Boolean]: When true only update artists without an already defined thumbnail.
  • “NAME” [String]: The artist name (Note: You can use the special “--ALL--” value to regenerate all artists thumbnails, beware of duration and battery usage)

Load application style

Requires v13.6+

Load a saved custom application style.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “load_app_style”
  • “NAME” [String]: The name of the application style

Load profile

Requires v13.6+

Load a saved profile.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “load_profile”
  • “NAME” [String]: The name of the profile

Back to Wiki