[GH-ISSUE #190] Player hooks with data arguments

kerem commented

2026-03-14 13:05:57 +03:00

Owner

Originally created by @sewnie on GitHub (May 5, 2023).
Original GitHub issue: https://github.com/aome510/spotify-player/issues/190

Is your feature request related to a problem? Please describe.
Recently, I have stopped using spotify-player simply because libreapot does not has support for external connections such as last.fm, and can not do notifications without Dbus.

Describe the solution you'd like
A hook system that launches a program with arguments set in the configuration for events such as pre, post, during (second interval) for sub-events for playing, pausing, skipping, etc..

I can use these to pass to notification or lastfm scrobller clients.

Describe alternatives you've considered
Using librespot or spotifyd directly, I believe librespot has direct support for this feature, so I don't think it would be trivial to implement it here.

Originally created by @sewnie on GitHub (May 5, 2023). Original GitHub issue: https://github.com/aome510/spotify-player/issues/190 **Is your feature request related to a problem? Please describe.** Recently, I have stopped using spotify-player simply because libreapot does not has support for external connections such as last.fm, and can not do notifications without Dbus. **Describe the solution you'd like** A hook system that launches a program with arguments set in the configuration for events such as pre, post, during (second interval) for sub-events for playing, pausing, skipping, etc.. I can use these to pass to notification or lastfm scrobller clients. **Describe alternatives you've considered** Using librespot or spotifyd directly, I believe librespot has direct support for this feature, so I don't think it would be trivial to implement it here.

kerem

2026-03-14 13:05:57 +03:00

closed this issue
added the
enhancement
label

kerem commented

2026-03-14 13:06:14 +03:00

Author

Owner

@sewnie commented on GitHub (Jul 21, 2023):

@aome510 i would like to hear from this.

i am tired of the propietary spotify client.

@sewnie commented on GitHub (Jul 21, 2023): @aome510 i would like to hear from this. i am tired of the propietary spotify client.

kerem commented

2026-03-14 13:06:19 +03:00

Author

Owner

@aome510 commented on GitHub (Jul 21, 2023):

I've been quite busy lately, so I won't be able to implement this soon. However, will put this up in my TODO list and see look into ways to integrate the last.fm APIs, if any.

@aome510 commented on GitHub (Jul 21, 2023): I've been quite busy lately, so I won't be able to implement this soon. However, will put this up in my TODO list and see look into ways to integrate the last.fm APIs, if any.

kerem commented

2026-03-14 13:06:24 +03:00

Author

Owner

@sewnie commented on GitHub (Jul 21, 2023):

well, this feature request is for hooks, which is alot simpler than implementing the last.fm API, since that can be handled by another program making the stack simpler.

@sewnie commented on GitHub (Jul 21, 2023): well, this feature request is for hooks, which is alot simpler than implementing the last.fm API, since that can be handled by another program making the stack simpler.

kerem commented

2026-03-14 13:06:29 +03:00

Author

Owner

@aome510 commented on GitHub (Aug 26, 2023):

Plan to implement this next week or so. Does writing player events in a cache file work? You can write a script to watch for changes in that file every second or so, and port that to last.fm client. Lmk if I need to include any fields other than the event data (I plan to include the timestamp).

@aome510 commented on GitHub (Aug 26, 2023): Plan to implement this next week or so. Does writing player events in a cache file work? You can write a script to watch for changes in that file every second or so, and port that to last.fm client. Lmk if I need to include any fields other than the event data (I plan to include the timestamp).

kerem commented

2026-03-14 13:06:34 +03:00

Author

Owner

@sewnie commented on GitHub (Aug 26, 2023):

honestly been using the propietary spotify client for a long while now, i'd much rather have librespot itself actually supporting this shit rather than me having to send last.fm api requests constantly

@sewnie commented on GitHub (Aug 26, 2023): honestly been using the propietary spotify client for a long while now, i'd much rather have librespot itself actually supporting this shit rather than me having to send last.fm api requests constantly

kerem commented

2026-03-14 13:06:39 +03:00

Author

Owner

@aome510 commented on GitHub (Aug 26, 2023):

Just saw this issue: https://github.com/jpochyla/psst/issues/424. Look like lastfm scrobbling is supported via Spotify connect, so it should work by default with spotify_player. I just double check on last.fm website and it shows all the scrobbles when I use spotify_player. Can you confirm? If that's the case, I'll close this issue.

@aome510 commented on GitHub (Aug 26, 2023): Just saw this issue: https://github.com/jpochyla/psst/issues/424. Look like `lastfm` scrobbling is supported via Spotify connect, so it should work by default with `spotify_player`. I just double check on last.fm website and it shows all the scrobbles when I use `spotify_player`. Can you confirm? If that's the case, I'll close this issue. <img width="1279" alt="Screenshot 2023-08-26 at 4 32 40 PM" src="https://github.com/aome510/spotify-player/assets/40011582/eb4da994-33fd-4d7d-9480-ee0d5bf50a1b">

kerem commented

2026-03-14 13:06:44 +03:00

Author

Owner

@sewnie commented on GitHub (Aug 26, 2023):

Wow, okay!!!! I'll check tommorow!!

I will be very happy if this is true.

@sewnie commented on GitHub (Aug 26, 2023): Wow, okay!!!! I'll check tommorow!! I will be very happy if this is true.

kerem commented

2026-03-14 13:06:49 +03:00

Author

Owner

@sewnie commented on GitHub (Aug 27, 2023):

SEEMS TO WORK!!
although, spotify cant quite see what i'm playing, so that spotify yearly thing wont quite work

@sewnie commented on GitHub (Aug 27, 2023): ![image](https://github.com/aome510/spotify-player/assets/47404953/792e26b7-5fe6-44ad-81cf-be1bc6ec6afc) SEEMS TO WORK!! although, spotify cant quite see what i'm playing, so that spotify yearly thing wont quite work

kerem commented

2026-03-14 13:06:54 +03:00

Author

Owner

@sewnie commented on GitHub (Aug 27, 2023):

thank u

@sewnie commented on GitHub (Aug 27, 2023): thank u

kerem commented

2026-03-14 13:07:00 +03:00

Author

Owner

@aome510 commented on GitHub (Aug 27, 2023):

although, spotify cant quite see what i'm playing, so that spotify yearly thing wont quite work

Related https://github.com/librespot-org/librespot/issues/913. That's one thing I miss from the official app and wish that librespot figure out ways to reverse-engineer the feature.

@aome510 commented on GitHub (Aug 27, 2023): > although, spotify cant quite see what i'm playing, so that spotify yearly thing wont quite work Related https://github.com/librespot-org/librespot/issues/913. That's one thing I miss from the official app and wish that `librespot` figure out ways to reverse-engineer the feature.

kerem commented

2026-03-14 13:07:05 +03:00

Author

Owner

@sewnie commented on GitHub (Aug 27, 2023):

~~It is a bit infuriating to be honest, considering its been a problem for 4 years and no one had stepped up and reversed engineered it :(~~

@sewnie commented on GitHub (Aug 27, 2023): ~~It is a bit infuriating to be honest, considering its been a problem for 4 years and no one had stepped up and reversed engineered it :(~~

kerem commented

2026-03-14 13:07:10 +03:00

Author

Owner

@sewnie commented on GitHub (Aug 31, 2023):

Wait, this issue still remains.

@sewnie commented on GitHub (Aug 31, 2023): Wait, this issue still remains.

kerem commented

2026-03-14 13:07:15 +03:00

Author

Owner

@sewnie commented on GitHub (Aug 31, 2023):

I do want to have some form of player hooks to be honest; my use case being to avoid constant D-Bus requests.

@sewnie commented on GitHub (Aug 31, 2023): I do want to have some form of player hooks to be honest; my use case being to avoid constant D-Bus requests.

kerem commented

2026-03-14 13:07:20 +03:00

Author

Owner

@aome510 commented on GitHub (Sep 2, 2023):

I do want to have some form of player hooks to be honest; my use case being to avoid constant D-Bus requests.

Does writing player events into a file work? I'm not too familiar with the player hook concept and how to implement one.

@aome510 commented on GitHub (Sep 2, 2023): > I do want to have some form of player hooks to be honest; my use case being to avoid constant D-Bus requests. Does writing player events into a file work? I'm not too familiar with the player hook concept and how to implement one.

kerem commented

2026-03-14 13:07:25 +03:00

Author

Owner

@sewnie commented on GitHub (Sep 3, 2023):

Player hooks is to launch a program with certain metadata (such as song, album, title) as arguments, on certain events (such as play, new song, pause, etc)

@sewnie commented on GitHub (Sep 3, 2023): Player hooks is to launch a program with certain metadata (such as song, album, title) as arguments, on certain events (such as play, new song, pause, etc)

kerem commented

2026-03-14 13:07:30 +03:00

Author

Owner

@aome510 commented on GitHub (Sep 3, 2023):

Implemented in #244. Refer to https://github.com/aome510/spotify-player/blob/add-player-hook/docs/config.md#player-event-hook-command for how to use the command.

@aome510 commented on GitHub (Sep 3, 2023): Implemented in #244. Refer to https://github.com/aome510/spotify-player/blob/add-player-hook/docs/config.md#player-event-hook-command for how to use the command.

kerem commented

2026-03-14 13:07:35 +03:00

Author

Owner

@sewnie commented on GitHub (Sep 4, 2023):

why json? :(

@sewnie commented on GitHub (Sep 4, 2023): why json? :(

kerem commented

2026-03-14 13:07:40 +03:00

Author

Owner

@aome510 commented on GitHub (Sep 4, 2023):

why json? :(

for consistency with CLI commands' output and because the app already supports exporting Spotify data in JSON format.

@aome510 commented on GitHub (Sep 4, 2023): > why json? :( for consistency with CLI commands' output and because the app already supports exporting Spotify data in JSON format.

kerem commented

2026-03-14 13:07:46 +03:00

Author

Owner

@sewnie commented on GitHub (Sep 4, 2023):

Why not ususe JSON for big Spotify data? For example for simple data it should simply be it in plain text, and the arguments to be passed as the arguments themselves:

script "Playing" "Artist" "Album" "Song", this ensures that scripting is very easy. I'd appreciate it if you did this as this is what I had expected..

@sewnie commented on GitHub (Sep 4, 2023): Why not ususe JSON for big Spotify data? For example for simple data it should simply be it in plain text, and the arguments to be passed as the arguments themselves: `script "Playing" "Artist" "Album" "Song"`, this ensures that scripting is very easy. I'd appreciate it if you did this as this is what I had expected..

kerem commented

2026-03-14 13:07:51 +03:00

Author

Owner

@sewnie commented on GitHub (Sep 7, 2023):

I can't use this feature; setting player_event_hook_command to a valid binary path gives: player_event_hook_command: None.

player_event_hook_command = "spotify_player-hook"

2023-09-07T16:28:20.475855Z  INFO spotify_player: General configurations: AppConfig { theme: "sewn", client_id: "XXXXXXXXXXXXXXXXXXXXX", client_port: 8080, copy_command: Command { command: "xclip", args: ["-sel", "c"] }, player_event_hook_command: None, playback_format: "{track}\n{artists} - {album}\n{metadata}"...

@sewnie commented on GitHub (Sep 7, 2023): I can't use this feature; setting `player_event_hook_command` to a valid binary path gives: `player_event_hook_command: None`. ```toml player_event_hook_command = "spotify_player-hook" ``` ``` 2023-09-07T16:28:20.475855Z INFO spotify_player: General configurations: AppConfig { theme: "sewn", client_id: "XXXXXXXXXXXXXXXXXXXXX", client_port: 8080, copy_command: Command { command: "xclip", args: ["-sel", "c"] }, player_event_hook_command: None, playback_format: "{track}\n{artists} - {album}\n{metadata}"... ```

kerem commented

2026-03-14 13:07:56 +03:00

Author

Owner

@aome510 commented on GitHub (Sep 7, 2023):

Please refer to the linked document to use a correct format. It should be player_event_hook_command = { command = "spotify_player-hook", args = [] }

Regarding why JSON but not plain text with arguments,

different events have different fields, passing the fields as command's arguments simply does not scale.
script can be arbitrarily complexed as user wants, the passing data to the script logic from spotify_player side is not. As a result, the passing data logic should be simple (e.g passing the event as a single input).

@aome510 commented on GitHub (Sep 7, 2023): Please refer to the linked document to use a correct format. It should be `player_event_hook_command = { command = "spotify_player-hook", args = [] }` Regarding why JSON but not plain text with arguments, 1. different events have different fields, passing the fields as command's arguments simply does not scale. 2. script can be arbitrarily complexed as user wants, the passing data to the script logic from `spotify_player` side is not. As a result, the passing data logic should be simple (e.g passing the event as a **single** input).

kerem commented

2026-03-14 13:08:01 +03:00

Author

Owner

@sewnie commented on GitHub (Sep 7, 2023):

different events have different fields, passing the fields as command's arguments simply does not scale.

#!/bin/sh

echo "command: $1"

case "$1" in
        Changed) echo "old_track_id: $3, new_track_id: $3" ;;
        Playing) echo "track_id: $2, position_ms: $3, duration_ms: $4" ;;
        Paused) echo "track_id: $2, position_ms: $3, duration_ms: $4" ;;
        EndOfTrack) echo "track_id: $2" ;;
esac

I hightly suggest to you to please use a arguement system, as it makes my life and others much easier when scripting for spotify-player.

@sewnie commented on GitHub (Sep 7, 2023): > different events have different fields, passing the fields as command's arguments simply does not scale. ```sh #!/bin/sh echo "command: $1" case "$1" in Changed) echo "old_track_id: $3, new_track_id: $3" ;; Playing) echo "track_id: $2, position_ms: $3, duration_ms: $4" ;; Paused) echo "track_id: $2, position_ms: $3, duration_ms: $4" ;; EndOfTrack) echo "track_id: $2" ;; esac ``` I hightly suggest to you to please use a arguement system, as it makes my life and others much easier when scripting for spotify-player.

kerem commented

2026-03-14 13:08:06 +03:00

Author

Owner

@aome510 commented on GitHub (Sep 7, 2023):

I hightly suggest to you to please use a arguement system, as it makes my life and others much easier when scripting for spotify-player.

Ok, I'll think about it.

@aome510 commented on GitHub (Sep 7, 2023): > I hightly suggest to you to please use a arguement system, as it makes my life and others much easier when scripting for spotify-player. Ok, I'll think about it.

kerem commented

2026-03-14 13:08:11 +03:00

Author

Owner

@aome510 commented on GitHub (Sep 7, 2023):

Just a note that with the arguments approach, new user will be confused between the arguments, e.g is it Changed old_track_id new_track_id or Changed new_track_id old_track_id? Then they are required to actually read the document, which many don't usually.

@aome510 commented on GitHub (Sep 7, 2023): Just a note that with the arguments approach, new user will be confused between the arguments, e.g is it `Changed old_track_id new_track_id` or `Changed new_track_id old_track_id`? Then they are required to actually read the document, which many don't usually.

kerem commented

2026-03-14 13:08:16 +03:00

Author

Owner

@sewnie commented on GitHub (Sep 7, 2023):

Well? They need to read the docs to understand what the hooks do, their arguments and commands to begin with.

@sewnie commented on GitHub (Sep 7, 2023): Well? They need to read the docs to understand what the hooks do, their arguments and commands to begin with.

kerem commented

2026-03-14 13:08:21 +03:00

Author

Owner

@aome510 commented on GitHub (Sep 10, 2023):

Should be updated with https://github.com/aome510/spotify-player/pull/251.

@aome510 commented on GitHub (Sep 10, 2023): Should be updated with https://github.com/aome510/spotify-player/pull/251.

Rows
Columns

[GH-ISSUE #190] Player hooks with data arguments #1034