search

bitfocus / companion-module-twitch-api

MIT License
2 stars 3 forks source link

Added "Clip That" functionality #24

Closed linkian209 closed 1 month ago

linkian209 commented 1 month ago

This patch adds channel clipping functionality. The action will call the Twitch clipping endpoint, then it will post a message containing the clip url to the selected channel's chat.

linkian209 commented 1 month ago

As a note to the maintainers of the token server, the OAuth will need to also request the clips:edit scope for this action to work out of the box.

thedist commented 1 month ago

This is not compatible with the revamp that is being worked on that completely reworks the API section, as well as the entire auth process.

Also this sort of function is not the appropriate way to handle what you're attempting to achieve and instead the correct way would be to have the clip URL returned as an instance variable that could then be used in other functions, such as sending to chat. This would also allow the user doing the clipping to actually edit it prior to posting to chat.

linkian209 commented 1 month ago

Thanks for the reply!

Do you have a branch for the API revamp? I recently started using this software and this is a functionality I would love to have for my streams. I’ll do the rework you suggest as well as make up a template action that just posts the clip as is.

thedist commented 1 month ago

The revamp is in a private branch, due to some of it currently being under NDA.

The main focus of the revamp has been to switch the auth to DCF, so it's handled entirely within the Companion module, reworked how API requests are handled so the GOT dependency can be removed, more API endpoints have been added and the actions/feedback/variables from those endpoints, and some EventSub Websockets support.

This is also why it's generally best practice to go through an Issue first, rather than just a pull request without any sort of prior communication, as like many modules there will be work going on that external parties are unaware of or compatibility issues, and some things may already be fixed or implemented in a branch not yet released.

Due to the significant layoffs at Twitch early this year it has delayed progress to some degree as priorities shifted, but we hope to have the module ready for testing near the end of Q3, with release in Q4.