search

bitfocus / companion-module-requests

Repository for tracking module requests
96 stars 10 forks source link

Support for Proclaim by Faithlife? #600

Closed Ryknown closed 6 months ago

Ryknown commented 2 years ago

Hello. Is there any support for Proclaim by Faithlife? This is presentation software similar to ProPresenter, which is supported by Companion. Thank you. Ryknown

Ryknown commented 2 years ago

I'll add that Proclaim does now have support in the Elgato Stream Deck. Uses would be to add a song, Bible verse, play a video, mute audio, un-mute audio, advance slides, skip slides...

Ryknown commented 2 years ago

.. synchronize the transition of slides on multiple PC/Mac computers. We have multiple (2) instances of Proclaim running on different machines to serve video/slides to video walls and Led projectors.

Cameron-D commented 2 years ago

I wanted this too so I started working on porting the StreamDeck plugin to a Companion module but very quickly ran into a significant block - the API that the SD plugin uses is only accessible from the computer that Proclaim is running on.

All my development is done on a Linux box (no Proclaim builds...) so I can't even build it for localhost access only.

I also looked at the API that the mobile app uses, its different to the one that they use for SD, and requires a lot of active state tracking which isn't really feasible in a Companion module (i.e. there is no 'Next Slide' function, you need to know the ID of the slide you are on, work out the next slide ID, and send a request to transition to that slide).

I'm going contact Faithlife support and see if they'll add some options to allow remote control API access from any device (or maybe an IP whitelist) so I can continue working on this.

Ryknown commented 2 years ago

Thank you, @Cameron-D !

Cameron-D commented 2 years ago

I think I have this module working now. I'm still waiting to hear back from Faithlife about proper remote access to the API so I'm not going to ask to have this module made official in Companion just yet.

To start with, I made a tiny single-purpose proxy to access the Proclaim API from a remote computer so I could actually get development underway: https://github.com/Cameron-D/proclaim-proxy (Turns out this was literally two lines of Go!). I've not yet actually tried this in production, but don't see why it wouldn't work.

Then there's the Companion module itself, currently at: https://github.com/Cameron-D/companion-module-faithlife-proclaim

It seems to work quite well in my at-home testing, but I definitely need to take it through some more thorough tests before I'd be happy to call it done and request it be made official.

Currently has support for next/prev slide and item, jumping to specific song parts (verse X, chorus Y, etc.), on/off air and feedback/variable for on-air state. This seems to be everything (and more) that the official StreamDeck plugin supports.

Ryknown commented 2 years ago

This is amazing, @Cameron-D ! Thank you!

Cameron-D commented 2 years ago

Just to update - Received a response that they'd moved my request to their feedback site (which I wasn't aware of until then), perhaps having some interest shown there will help: https://feedback.faithlife.com/boards/faithlife-proclaim/posts/stream-deck-proclaim

Either way I plan on doing some proper testing of the module when I find the time, to at least get that half of everything complete.

Ryknown commented 2 years ago

Thank you! I have up-voted it!

Ryan

From: Cameron @.> Sent: Thursday, November 4, 2021 8:41:36 PM To: bitfocus/companion-module-requests @.> Cc: Ryknown @.>; Author @.> Subject: Re: [bitfocus/companion-module-requests] Support for Proclaim by Faithlife? (#600)

Just to update - Received a response that they'd moved my request to their feedback site (which I wasn't aware of until then), perhaps having some interest shown there will help: https://feedback.faithlife.com/boards/faithlife-proclaim/posts/stream-deck-proclaim

Either way I plan on doing some proper testing of the module when I find the time, to at least get that half of everything complete.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/bitfocus/companion-module-requests/issues/600#issuecomment-961604662, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AV2XM7MGDSKC3Y7UC2DXAEDUKNG7BANCNFSM5E64PC3A. Triage notifications on the go with GitHub Mobile for iOShttps://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

cpuguru07 commented 2 years ago

While not directly related to this Companion module, users interested in this module may also be interested in this request on the Proclaim Feedback Forum to add support for URI cues (so Proclaim can trigger Companion buttons): https://feedback.faithlife.com/boards/faithlife-proclaim/posts/uri-cue-item

JordanSjodinFaithlife commented 2 years ago

@Cameron-D thanks for your work here! I'm thinking of adding a simple password that can be configured in Proclaim. And then allow access to outside localhost when that password is sent in a header or something. How's that sound? Seems maybe easier than doing an ip whitelist (in case the IP addresses change)

Cameron-D commented 2 years ago

@JordanSjodinFaithlife Something like that sounds like it would work well.

JordanSjodinFaithlife commented 2 years ago

We just release the new update (3.2.0.0038 or greater)with a slightly reworked Remote settings that allows you to specify a password.

We also made some documentation to go along with it!

https://support.faithlife.com/hc/en-us/articles/4972373093005

josephdadams commented 2 years ago

https://github.com/bitfocus/companion-module-requests/issues/773#issuecomment-1093003185

cpuguru07 commented 1 year ago

Really interested in this module; it seems like it shouldn't be difficult to build - Proclaim is a free download (can be used for free with watermark) and the API is well-documented. In the meantime, I'm using the Generic HTTP module to issue GET commands. Haven't been able to figure out how to retrieve the proclaimAuthToken, but was able to retrieve it manually and store it in a custom variable.

josephdadams commented 1 year ago

@cpuguru07 https://github.com/bitfocus/companion/wiki/Module-Development if you want to get started!

hussra commented 6 months ago

I've been working on a Companion 3.x module for Proclaim, for which the work by @Cameron-D was a huge help. So far it is working well in my testing (on Companion 3.1.2 on a 4GB Raspberry Pi 4) but could do with me doing a bit more testing.

hussra commented 6 months ago

https://github.com/bitfocus/companion-module-logos-proclaim

hussra commented 6 months ago

A Proclaim module is now in the Companion 3.2 beta releases.

(Unfortunately it looks like there was a problem with the Companion nightly builds overnight, and only the Windows version of 3.2.0+6622 is so far available on https://user.bitfocus.io/download)