ontime icon indicating copy to clipboard operation
ontime copied to clipboard

Request for timer status functionality

Open je71175 opened this issue 2 years ago • 6 comments

Would it be possible to incorporate the status of the timer into onTime ? For example the status as "Stopped" "Paused" "Running" are available to other systems. (API, OSC, Companion)

I am thinking specifically for OSC status messages and API status inquiry / web sockets, and also since you have developed a companion module -I am hoping that the companion buttons could also be coded to a colour which coresponds ot the timer status (as I have seen with some other modules)

thanks !

je71175 avatar Aug 08 '22 13:08 je71175

Hi @je71175 , the playback status is already available to the APIs but is not streamed. Do you have a specific workflow / integration in mind?

Feedback is absolutely a must for companion module. It would be great to have some input, would you mind creating an issue in the module repo?

cpvalente avatar Aug 08 '22 15:08 cpvalente

Aside from the onTime UI, we primarily use OSC (via OSC Pilot app) for controlling apps, and in building the onTime OSC controls, it would be good to have a visual indication of what onTime is doing in OSC Pilot. Have also begun looking into Central Control platform (https://centralcontrol.io/) in addition to Companion. It seems to have a good following in video land, and supports OSC and API. (Have heard some horror stories of Companion on live shows, particularly for complex mappings, but touch wood no personal issues). thanks

je71175 avatar Aug 09 '22 02:08 je71175

This sounds like a good opportunity to build up the OSC integration a bit more. How would you imagine this? Would there be a poll endpoint in OSC? If you could help me build a schema I am happy to prioritise this.

Meanwhile seems like Central Control already have a rundown timer. What is the use case for integrating ontime with this?

Again, I am actively rebuilding the APIs so it is perfect timing to look into this

cpvalente avatar Aug 09 '22 08:08 cpvalente

Hi - i was primarily using central control because it has support for control units and general hardware/ devices (eg HyperDeck). Basically an alternative to companion and a stream deck, or even alongside companion for some redundancy. I haven't looked into their timers functionality much, but on the surface OnTime is much more comprehensive and workflow friendly for our needs. So the ask was for other apps in our workflow- companion, Central Control, etc, to have some feedback / sync as to what was happening with OnTime. I was thinking at a minimum, each time OnTime changes it status it sends an OSC message, OSC polling of OnTime would be excellent also.

je71175 avatar Sep 01 '22 05:09 je71175

Thank you for the clarification. I see a lot of movement towards OSC APIs so it would be definitely a good idea to support this.

It would be great to have some help identifying the structure here.

  • What would the osc endpoint be? a single /ontime/poll? What data does it return?
  • Should ontime send data at events? (like it does now every second, see docs)
  • What does an MVP look like, ie: what is the minimal functionality to be able to integrate with Central Control and enable your workflow

cpvalente avatar Sep 02 '22 11:09 cpvalente

For the Query (poll) functionality, implement a response to OSC message "/ontime/status" the current status keywords sent with /ontime (play, pause, stop, finished) is perfect. thank you

je71175 avatar Oct 16 '22 16:10 je71175

Hi @je71175, would you object to a message called /ontime/get-playback? I believe this establishes a better pattern for status getters

cpvalente avatar Oct 27 '22 17:10 cpvalente

Perfect! Thank you

Sent from Outlook for iOShttps://aka.ms/o0ukef


From: Carlos Valente @.> Sent: Friday, October 28, 2022 1:50:39 AM To: cpvalente/ontime @.> Cc: Jason Ellemor @.>; Mention @.> Subject: Re: [cpvalente/ontime] Request for timer status functionality (Issue #190)

Hi @je71175https://github.com/je71175, would you object to a message called /ontime/get-playback? I believe this establishes a better pattern for status getters

— Reply to this email directly, view it on GitHubhttps://github.com/cpvalente/ontime/issues/190#issuecomment-1293870667, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AHBF4PA5GGGTAGJW7BDGGLLWFK6G7ANCNFSM555EV3XQ. You are receiving this because you were mentioned.Message ID: @.***>

je71175 avatar Oct 28 '22 04:10 je71175