Requests/Events: Media Source/VLC

[tt2468]

Adds the following requests into a new category called MediaControl:

• PlayPauseMedia
• RestartMedia
• StopMedia
• NextMedia
• PreviousMedia
• GetMediaDuration
• GetMediaTime
• SetMediaTime
• ScrubMedia
• GetMediaState
• GetMediaSourcesList

Adds the following events into a new category called Media

• MediaPlaying
• MediaPaused
• MediaRestarted
• MediaStopped
• MediaNext
• MediaPrevious
• MediaStarted
• MediaEnded

Notes:

• I believe this requires at least OBS 25.0.8
• As with any large code change/addition, it would be nice to get some testers to bug test this. You should be able to download the plugin binaries through Azure pipelines.

Resolves #494

[tconley]

Would love to test this. i'm interested in creating a dock that gives playback controls and countown timer for media. idealy this would be for the program view as well as the preview view in studio mode.

[tt2468]

@tconley If you download the windows artifact from this page, it has an installer for obs-websocket with these features: https://dev.azure.com/Palakis/obs-websocket/_build/results?buildId=1243&view=artifacts&type=publishedArtifacts

[tconley]

Cool. I'm able to issue the requests like below.
{ "request-type":"PlayPauseMedia", "sourceName":"movie1", "playPause":false, "message-id":"12324" }

Should 'MediaPlaying' be return anytime that media is playing or only when i've triggered it via PlayPauseMedia? For example if I click 'transition' in OBS Studio I get info back from websocket about that fact that SwitchScenes has happened, but I'm not getting back MediaPlaying

[tconley]

Cool. I'm able to issue the requests like below.
{ "request-type":"PlayPauseMedia", "sourceName":"movie1", "playPause":false, "message-id":"12324" }

Should 'MediaPlaying' be return anytime that media is playing or only when i've triggered it via PlayPauseMedia? For example if I click 'transition' in OBS Studio I get info back from websocket about that fact that SwitchScenes has happened, but I'm not getting back MediaPlaying

Figured that out, I am getting MediaStarted/MediaEnded events

[tt2468]

@tconley So the requests simple forward to internal requests in OBS, and the events simply forward signals coming from OBS.

In my testing, the media source had very different event behavior than the VLC source did. I honestly could not tell you whether something should or should not happen.

[tconley]

I was able to use these to come up with little webpage that finds all the media sources of typeID ffmpeg_source , added play/pause buttons and also a button to change the audio monitoring type for that source. super helpful to have this committed to obs-websocket!

[tt2468]

@tconley New request GetMediaSourcesList hot off the press.

[tconley]

@tt2468 PlayRickRollInCurrentScene might be a good addition too :-)

[PurpleMyst]

Hi! I need exactly this PR. Is it production ready? Can I just compile it myself and use it?

[tt2468]

@PurpleMyst I've just merged the main branch into the pr branch to update it to the latest features. Once the checks finish, you will be able to download the precompiled binaries for your appropriate OS here: https://dev.azure.com/Palakis/obs-websocket/_build/results?buildId=1282&view=artifacts&type=publishedArtifacts

[PurpleMyst]

Ah thank you. I'm not familiar with the windows compilation story and was having a hard time figuring it out.