Symfonium-API (Steuerung durch andere Apps wie Tasker erlauben)

Symfonium stellt eine API bereit, über die andere Apps mit Symfonium interagieren können.

Die API ist über einen Broadcast-Receiver erreichbar. Du musst lediglich passende Broadcast-Intents senden.

Der Komponentenname des Receivers lautet “app.symfonik.music.player/app.symfonium.remote.api.ApiReceiver”.

Wenn eine App die Komponente in einzelne Felder aufteilt, verwende folgende Werte:

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

Trage in Action die aufzurufende API-Aktion ein und ergänze die unten dokumentierten Extras.

Der Receiver ist für andere installierte Apps zugänglich und prüft keine aufruferspezifische Berechtigung. Erlaube daher nur vertrauenswürdigen Apps, diese API zu verwenden, insbesondere wenn du vertrauliche Extras wie ein Sicherungspasswort übergibst.

Wiedergabegerät wechseln

• Action: “app.symfonium.api.SELECT_RENDERER”
• Extras :
  • “TYPE” [Int]: Typ des Wiedergabegeräts Dokumentierte Werte:
    • 0 : Lokales Gerät
    • 1: UPnP-Wiedergabegerät
    • 3 : Chromecast-Wiedergabegerät
    • 6 : Entferntes Mediencenter
  • “IDENTIFIER” [String/Optional]: eindeutige ID des Wiedergabegeräts Du findest den Wert in der Auswahl der Wiedergabegeräte über die Schaltfläche (i). Halte das Wiedergabegerät gedrückt, um die ID in die Zwischenablage zu kopieren. Nur beim Wechsel zurück zu Lokales Gerät ist dieses Extra optional.

Synchronisierung erzwingen

• Action: “app.symfonium.api.MEDIA_SYNC”
• Extras :
  • “PROVIDER_ID” [Int]: ID der Medienquelle (sichtbar im Aktionsmenü der Medienquelle in den Einstellungen)

Wiedergabesteuerung

• Action: “app.symfonium.api.MEDIA_COMMAND”
• Extras :
  • “COMMAND” [String]: zu sendender Befehl Mögliche Werte:
    • “play”
    • “pause”
    • “stop”
    • “next”
    • “previous”
    • “shuffle”
    • “repeat”
    • “mute”
    • “togglemute”
    • “seek_relative” (relative Position in Sekunden als Int-Parameter)
    • “seek” (Position in Prozent von 0 bis 100 als Int-Parameter)
    • “volume” (Lautstärke als Int-Parameter)
    • “set_sleeptimer” (Verzögerung in Minuten als Int-Parameter) Erfordert v6.0+
    • “remove_sleeptimer” Erfordert v6.0+
  • “INT_PARAMETER” [Int/Optional]: Int-Wert für Befehle, die einen Parameter benötigen

Medienstart

• Action: “app.symfonium.api.MEDIA_START”
• Extras :
  • “MEDIA_TYPE” [String]: zu startender Medientyp Mögliche Werte:
    • “playlist”
    • “artist”
    • “album”
    • “genre”
    • “song”
    • “song_mix”
    • “album_mix”
    • “internet_radio” Erfordert v11.2+
  • “NAME” [String/Optional]: Name des Mediums (für Titel optional, wenn du den Dateinamen angibst). Erfordert v1.9+
  • “ALBUM” [String/Optional]: Album des Mediums zur eindeutigen Zuordnung. Erfordert v14.1+
  • “ARTIST” [String/Optional]: Interpret des Mediums zur eindeutigen Zuordnung. Erfordert v14.1+
  • “ID” [Long/Optional]: ID des Internetradiosenders oder der Wiedergabeliste (optional, wenn du den Namen übergibst). Erfordert v11.2+
  • “FILE” [String/Optional]: vollständiger Pfad des Mediums, nur für Titel. Erfordert v1.9+
  • “RESUME” [Boolean/Optional]: legt fest, ob die Wiedergabe des Mediums nach Möglichkeit fortgesetzt wird.
  • “SHUFFLE” [Boolean/Optional]: legt fest, ob Gruppen wie Wiedergabelisten oder Genres in zufälliger Reihenfolge wiedergegeben werden.
  • “QUEUE” [Int/Optional]: 1 reiht das Medium direkt hinter dem aktuell wiedergegebenen Element ein. 2 reiht es am Ende der Warteschlange ein. Erfordert v1.8+

Einstellung ändern

Erfordert v1.10+

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

  • “SETTING” [String]: zu ändernde Einstellung

    Mögliche Werte:

    • “wifi_transcode” : Transkodierungsbitrate im WLAN
    • “mobile_transcode” : Transkodierungsbitrate im Mobilfunknetz
    • “available_offline” : Nicht offline verfügbare Medien ausblenden Erfordert v3.2+
    • “hide_status_bar” : Statusleiste ausblenden umschalten Erfordert v14.0+
    • “ignore_camera_hole” : Statusleiste und Kamera-Aussparung ignorieren umschalten Erfordert v14.0+

  • “INT_PARAMETER” [Int]: Transkodierungswert

 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

Wiedergabelisten importieren

Erfordert v8.0+

Importiert Wiedergabelisten aus einer unterstützten Medienquelle. Bereits vorhandene Wiedergabelisten werden automatisch übersprungen.

• Action: “app.symfonium.api.PLAYLIST_IMPORT”
• Extras :
  • “PROVIDER_ID” [Int]: ID der Medienquelle (sichtbar im Aktionsmenü der Medienquelle in den Einstellungen)
  • “PLAYLIST_TYPE” [Int]: Typ der importierten Wiedergabeliste
    • 1: Offline
    • 2: Nur lesen
    • 3: Online

Vorschaubild einer Wiedergabeliste neu erzeugen

Erfordert v11.3+

Erzeugt das Vorschaubild der Wiedergabeliste aus den Vorschaubildern der enthaltenen Titel neu.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “generate_playlist_thumbnail”
  • “LONG_PARAMETER” [Long]: ID der Wiedergabeliste (sichtbar oben im Aktionsmenü der Wiedergabeliste)

Stabile Zufallssortierung einer Wiedergabeliste aktualisieren

Erfordert v12.1+

Aktualisiert die stabile Zufallssortierung der Wiedergabeliste.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “refresh_playlist_stable_random”
  • “LONG_PARAMETER” [Long]: ID der Wiedergabeliste (sichtbar oben im Aktionsmenü der Wiedergabeliste)

Warteschlange laden

Erfordert v12.0+

Lädt eine gespeicherte Warteschlange und setzt die Wiedergabe optional fort.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “load_media_queue”
  • “LONG_PARAMETER” [Long]: ID der Warteschlange. (Du findest sie über das Info-Symbol im Aktionsmenü der Warteschlange.)
  • “RESUME” [Boolean]: true, um die Wiedergabe nach dem Laden der Warteschlange fortzusetzen.

Genre-Vorschaubild neu erzeugen

Erfordert v11.5+

Erzeugt das Genre-Vorschaubild aus den Vorschaubildern der enthaltenen Titel neu.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “generate_genre_thumbnail”
  • “NAME” [String]: Name des Genres (Mit dem speziellen Wert “--ALL--” kannst du die Vorschaubilder aller Genres neu erzeugen. Beachte die Dauer und den Akkuverbrauch.)

Offline-Cache bereinigen

Erfordert v11.3+

Löst die Aktion Bereinigen in der Verwaltung des Offline-Caches aus.

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

Sicherung starten

Erfordert v11.3+

Startet eine Sicherung mit den ausgewählten Inhalten. Ein Passwort und mindestens eine Inhaltsoption sind erforderlich.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “start_backup”
  • “PASSWORD” [String]: Passwort der Sicherung. ERFORDERLICH
  • “SETTINGS” [Boolean]: legt fest, ob die Sicherung die Einstellungen enthält.
  • “PROVIDERS” [Boolean]: legt fest, ob die Sicherung die Medienquellen enthält.
  • “EQ_PROFILES” [Boolean]: legt fest, ob die Sicherung die Equalizer-Profile enthält.
  • “INTERNET_RADIO” [Boolean]: legt fest, ob die Sicherung Internetradiosender enthält.
  • “PLAYLISTS” [Boolean]: legt fest, ob die Sicherung Wiedergabelisten enthält.
  • “AUTO_OFFLINE_RULES” [Boolean]: legt fest, ob die Sicherung Regeln für den automatischen Cache enthält.
  • “USER_DATA” [Boolean]: legt fest, ob die Sicherung Benutzerdaten enthält.
  • “USER_DATA_ALL” [Boolean]: legt fest, ob die Sicherung alle Mediendaten enthält (USER_DATA muss ebenfalls aktiviert sein).
  • “CUSTOM_IMAGES” [Boolean]: legt fest, ob die Sicherung benutzerdefinierte Bilder enthält (USER_DATA muss ebenfalls aktiviert sein).
  • “FILE_FAVORITES” [Boolean]: legt fest, ob die Sicherung Datei-Favoriten enthält.
  • “TAG_CACHE” [Boolean]: legt fest, ob die Sicherung den Tag-Cache enthält.

Aktive Verbindung einer Medienquelle ändern

Erfordert v13.4+

Erzwingt für eine Medienquelle die primäre oder sekundäre Verbindung.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “force_provider_connection”
  • “PROVIDER_ID” [Long]: ID der Medienquelle. ERFORDERLICH
  • “ACTIVE_CONNECTION” [Int]: 1 für die primäre Verbindung, 2 für die sekundäre Verbindung. ERFORDERLICH.

Interpreten-Vorschaubilder neu erzeugen

Erfordert v13.5+

Erzeugt das Vorschaubild eines Interpreten aus den Vorschaubildern seiner Titel neu.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “generate_artist_thumbnail”
  • “ONLY_MISSING_THUMBNAIL” [Boolean]: Bei true werden nur Interpreten ohne vorhandenes Vorschaubild aktualisiert.
  • “NAME” [String]: Name des Interpreten (Mit dem speziellen Wert “--ALL--” kannst du die Vorschaubilder aller Interpreten neu erzeugen. Beachte die Dauer und den Akkuverbrauch.)

Applikationsstil laden

Erfordert v13.6+

Lädt einen gespeicherten benutzerdefinierten Applikationsstil.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “load_app_style”
  • “NAME” [String]: Name des Applikationsstils

Profil laden

Erfordert v13.6+

Lädt ein gespeichertes Profil.

• Action: “app.symfonium.api.CUSTOM_ACTION”
• Extras :
  • “ACTION” [String]: “load_profile”
  • “NAME” [String]: Name des Profils

Zurück zum Wiki