Feature Request: Fire an event when a skip is performed

[humzakh]

The desktop version of SponsorBlock displays a small notification when a skip occurs. It would be useful if this happened on Android TV as well.

There is an integration that allows you to create notifications on Android TV using automations: https://www.home-assistant.io/integrations/nfandroidtv

If "iSponsorBlockTV add-on" fired a trigger upon performing a skip, it could be used in an automation to display a notification on the TV.

[bertybuttface]

Happy to accept a pull request but I won't be implementing this as I don't feel the need for it.

[humzakh]

I managed to implement it using a Python script that listens to the log file and triggers a webhook when a segment is skipped. Unfortunately not a solution worthy of a pull request, but it works.

[bertybuttface]

You could possibly ask upstream for a webhook to be added to the config file which is optionally fired when an event is skipped. If that is implemented there I will add support for it here.

https://github.com/dmunozv04/iSponsorBlockTV

[bertybuttface]

If upstream accepts webhooks as in scope then we can implement this more cleanly.

dmunozv04/iSponsorBlockTV#246

[SquirrelsMcGee]

Would love to see this, having to explain why parts of videos are being skipped or why ads don't have any sound to visitors is a personal annoyance of mine 😅

Seriously though, I think this would be a great UX improvement. I have an LG WebOS TV with it's own notification system so having events that I can listen to with Home Assistant automations would be perfect

[SquirrelsMcGee]

Also @humzakh, could you share that script? I'm interested in at least a short term solution

[humzakh]

Sure thing, @SquirrelsMcGee.

Here are the steps to use it:

1. Install the 'Advanced SSH & Web Terminal' addon and get that configured.
2. Create and save an automation with a webhook trigger. We need the webhook ID from it to put in the script below.
   • Set up the notification action for your TV. There should be a WebOS integration for the notify action.
   • To make it look more like the desktop notification, I added this icon to the TV notification: https://sponsor.ajay.app/LogoSponsorBlockSimple256px.png
3. Copy the below script and store it in /config/scripts/sponsorblock_trigger.py.
   • Don't forget to set the WEBHOOK_ID variable (and HA_URL if yours is different).
4. In 'Advanced SSH & Web Terminal' settings, go to the Configuration tab and add the following to init_commands:
   • nohup /usr/bin/python /config/scripts/sponsorblock_trigger.py > /tmp/sponsorblock_trigger.log &
5. Restart 'Advanced SSH & Web Terminal' from its Info tab.
   • You'll probably want to enable the 'Start on boot' and 'Watchdog' options in this tab.
6. Watch a sponsored video on your TV.

Let me know if you have any questions.

#!/usr/bin/python

import subprocess
from datetime import datetime

# config
HA_URL = 'http://homeassistant.local:8123'
WEBHOOK_ID = 'YOUR WEBHOOK ID HERE'

WEBHOOK_TRIGGER = f'{HA_URL}/api/webhook/{WEBHOOK_ID}'


def post_action(line):
    print(f'SponsorBlockTrigger: {line}')
    subprocess.run(['/usr/bin/curl', '-X', 'POST', WEBHOOK_TRIGGER])


def monitor_logs(start_time):
    match_phrase = 'Skipping segment: seeking to'

    # start a process that continously prints iSponsorBlockTV logs
    process = subprocess.Popen('/usr/bin/ha addons logs 932a64e5_isponsorblocktv -f',
                               stdout=subprocess.PIPE,
                               stderr=subprocess.PIPE,
                               text=True,
                               shell=True)

    try:
        for line in process.stdout:
            if match_phrase in line:
                # check if matched line is from after this script started
                line_time = datetime.strptime(line.split(' - ')[0], '%Y-%m-%d %H:%M:%S,%f')
                if line_time > start_time:
                    post_action(line.strip())
    except KeyboardInterrupt:
        print('KeyboardInterrupt!')
    finally:
        process.terminate()


if __name__ == '__main__':
    print('Start monitoring SponsorBlock...')
    START_TIME = datetime.now()
    monitor_logs(START_TIME)
    print('Stop monitoring SponsorBlock...')

[SquirrelsMcGee]

Thank you very much @humzakh ! 😄

[SquirrelsMcGee]

Update, the script works, however I had to make a small edit because of some extra characters in the log (I think they're colour codes?)

Anyway, I added this and it fixed it for me

import re

...

            if match_phrase in line:
                # check if matched line is from after this script started
                line = re.sub(r'\x1b\[[0-9;]*m', '', line) #remove bad chars from string
                line_time = datetime.strptime(line.split(' - ')[0], '%Y-%m-%d %H:%M:%S,%f')