logo

Live Production Software Forums


Welcome Guest! To enable all features please Login or Register.

Notification

Icon
Error

Options
Go to last post Go to first unread
gre2gor  
#1 Posted : Thursday, September 24, 2026 4:51:19 PM(UTC)
gre2gor

Rank: Advanced Member

Groups: Registered
Joined: 12/14/2018(UTC)
Posts: 88
Slovenia

Was thanked: 18 time(s) in 7 post(s)
Hi vMix Team,

I would like to consolidate a long-standing Instant Replay API request into one clear proposal.

vMix Replay already has a very powerful control API. We can play events by ID, modify the selected event, change angles, set text, etc.

What is still missing is reliable READ access to the Replay event state, together with one very important CONTROL function:

Selecting a Replay event directly by its ID without starting playback.

This would make a huge difference for external replay controllers, Companion / Stream Deck integrations, graphics systems and custom sports-production workflows.

WHAT I WOULD LIKE TO QUERY

Ideally the API should expose the current Replay event list, with information such as:


  • Event ID
  • Event List / Category
  • IN point
  • OUT point
  • Duration
  • Selected / not selected
  • Selected camera angles
  • Text / description for each camera angle
  • Tags, if available


And for Replay A/B playback state:


  • currently selected Event ID
  • currently PLAYING Event ID
  • current camera angle
  • selected / armed camera angles
  • current event duration
  • current event time remaining
  • number of selected events
  • current event number within the selected playback sequence, for example 2 of 5
  • total remaining duration of the selected replay package


It is important to distinguish between:


  1. the event currently selected in the Replay UI
  2. the event currently being played on Replay A/B
  3. the camera angle currently playing
  4. the camera angles enabled for that event


These are different pieces of information and are all useful to external applications.

DIRECT SELECTION BY ID

We already have:

Code:
ReplayPlayEventsByID


but we still need something like:

Code:
ReplaySelectEventByID
Value=0123


and preferably:

Code:
ReplaySelectEventsByID
Value=0123,0127,0132


This should SELECT the event or events, exactly as clicking them in the Replay Controller would, without starting playback.

At the moment First / Last / Next / Previous selection is not enough for a serious external replay controller.

WHY replay2.xml IS NOT THE SOLUTION

Yes, much of the event information exists in
Code:
replay2.xml
, and several of us are already parsing it.

But that is a workaround, not an API.

There are several problems:


  • it is a local session file instead of a supported API
  • not all values appear to update immediately
  • event text and changed IN/OUT points can become difficult to track reliably
  • there is no reliable API link between "what vMix is currently selecting/playing" and the corresponding event in replay2.xml
  • an external controller should not need filesystem access to the Replay recording computer
  • workarounds such as PlayEventByID followed by Pause can interfere with live replay operation


The information already exists inside vMix.

We are mainly asking for it to be exposed in a supported and reliable way.

WHY THIS MATTERS

For us this is not just about making another remote-control panel.

With this information an external application could show something like:

Code:

EVENT 0123
GOAL - #91
ANGLES: CAM 1 + CAM 3
DURATION: 00:08.4
PLAYING: CAM 3
PACKAGE: 2 / 4
REMAINING: 00:21


That opens up a lot of professional workflows:


  • true two-way Stream Deck / Companion feedback
  • dedicated hardware replay controllers
  • custom Replay Controller interfaces
  • automatic graphics based on replay metadata
  • automatically displaying player/event information when the replay starts
  • director / producer "character output" displays similar to larger replay systems
  • highlight management
  • replay review systems
  • automated logging
  • remote replay operation
  • selecting any event instantly by ID instead of navigating Next / Previous


For sports production this is especially valuable.

For example, the replay operator may have several angles marked for a goal.

An external graphics or control system should be able to know:

"This is Event 0123, CAM 1 and CAM 3 are enabled, the event text says GOAL #91, the event is 8.4 seconds long, and CAM 3 is currently playing."

Today there is no clean and reliable way to obtain that complete state from the API.

THIS IS NOT A REQUEST FOR A NEW REPLAY UI

vMix does not need to build all these custom workflows.

Give us the data and a few missing ID-based functions and the community can build them.

There have been requests around Replay event lists, IDs, tags, durations, selected clips and API access for many years, and several users have already built their own replay2.xml workarounds.

A supported Replay Events API would eliminate many of those hacks at once.

MINIMUM USEFUL IMPLEMENTATION

Even a minimal first implementation would already be extremely useful:


  1. Query all Replay events and their metadata
  2. Query selected Event ID(s)
  3. Query selected camera angles
  4. Query currently playing Event ID on Replay A/B
  5. Query current playing camera angle
  6. Query event duration / remaining time
  7. Query event text / description
  8. ReplaySelectEventByID
  9. ReplaySelectEventsByID


Everything else could be expanded later.

RELATED REQUESTS

This does not appear to be an isolated request. Similar Replay API functionality has been requested by users for many years.

List of Instant Replay Events / Replay API
API addition: List of Instant Replay Events

This request dates back to 2016 and already discusses exposing Replay Events, IDs, IN/OUT points, duration, description and selection by ID.

Currently selected Replay Event ID
ID of currently selected replay event in API

Another request specifically asking for the ID of the currently selected Replay event to be exposed through the API.

Replay API / additional shortcuts
Replay API - Request for new shortcuts

Discussion about additional Replay API control and the limitations of using replay2.xml as a workaround.

Replay Character Out / API XML data
Expose API/XML data to enable custom-built replay "character outs"

A recent and strongly supported request for exposing Replay data so external applications can build professional replay information / character output displays.

WHY I THINK THESE REQUESTS BELONG TOGETHER

Although these forum threads ask for slightly different functions, they all point to the same underlying limitation:

External applications can CONTROL many parts of vMix Replay, but they cannot reliably READ the Replay state and event metadata.

This creates an unnecessary gap.

The API already allows:

Code:
ReplayPlayEventsByID


So vMix already understands Replay Event IDs as a public control concept.

The missing piece is exposing those same IDs and their state back to the API, together with direct selection by ID.

SUMMARY

The most important additions would be:

Code:

Replay event list + metadata
Selected Event ID(s)
Playing Event ID
Selected camera angles
Playing camera angle
Event duration / time remaining
Event text / description

ReplaySelectEventByID
ReplaySelectEventsByID


This would enable a much more complete ecosystem around vMix Replay without requiring vMix itself to build every specialized controller or graphics workflow.

There appear to be dozens of users across multiple forum threads and many years asking for different parts of the same functionality.

I think exposing the Replay state properly through the API would solve many of these requests at once.

Give us the Replay data, and we can build the tools around it.

Thanks!
RichDanby  
#2 Posted : Thursday, September 24, 2026 5:32:34 PM(UTC)
RichDanby

Rank: Advanced Member

Groups: Registered
Joined: 2/23/2019(UTC)
Posts: 138
United Kingdom

Thanks: 19 times
Was thanked: 29 time(s) in 26 post(s)
It sounds like vMix 30 will add more data access, hopefully removing the need for replay2.xml workarounds.

vMix 30 changes overview : https://youtu.be/1RqWgqCibIM?si=heJUoi5CCaj-gD_d&t=1005
Users browsing this topic
Guest (2)
Forum Jump  
You cannot post new topics in this forum.
You cannot reply to topics in this forum.
You cannot delete your posts in this forum.
You cannot edit your posts in this forum.
You cannot create polls in this forum.
You cannot vote in polls in this forum.