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
guidogast  
#1 Posted : Tuesday, October 13, 2020 2:29:47 AM(UTC)
guidogast

Rank: Advanced Member

Groups: Registered
Joined: 5/19/2017(UTC)
Posts: 41
Netherlands
Location: The Netherlands

Thanks: 7 times
Was thanked: 23 time(s) in 14 post(s)
Hello,

For my M5Stick Tally Project, I'd like to expand some functionality to also display whether vMix is streaming/recording. However, I can't find a way in the documentation to read the status of vMix. The WEB API is used to trigger events and turn stuff on or off, and the TCP API only accepts subsciptions to TALLY or ACTS neither of which will give me the information I need. Am I looking past something, or is it simply not possible to know what the status of vMix is using the current API?

Cheers,
Guido
elgarf  
#2 Posted : Tuesday, October 13, 2020 2:35:56 AM(UTC)
elgarf

Rank: Advanced Member

Groups: Registered
Joined: 10/23/2015(UTC)
Posts: 425
Man
Russian Federation

Thanks: 19 times
Was thanked: 181 time(s) in 111 post(s)
Hello,

TCP API have XMLTEXT command.

Quote:

Format: XMLTEXT XPATH

Example Request: XMLTEXT vmix/inputs/input[1]/@title\r\n

Example Response: XMLTEXT OK This is the title of the first input\r\n

Example Request: XMLTEXT vmix/inputs/input[6]/text[@name='Headline']\r\n

Example Response: XMLTEXT OK This is the value of Headline text field in title input that is the number 6 (index 5) input.\r\n

Description: Uses the XPATH syntax to retrieve individual text values of the XML state.


Use

Code:
vmix/streaming

Code:
vmix/recording

Code:
vmix/external


As XPath parameter.
guidogast  
#3 Posted : Tuesday, October 13, 2020 2:54:23 AM(UTC)
guidogast

Rank: Advanced Member

Groups: Registered
Joined: 5/19/2017(UTC)
Posts: 41
Netherlands
Location: The Netherlands

Thanks: 7 times
Was thanked: 23 time(s) in 14 post(s)
Originally Posted by: elgarf Go to Quoted Post
Hello,

TCP API have XMLTEXT command.

Quote:

Format: XMLTEXT XPATH

Example Request: XMLTEXT vmix/inputs/input[1]/@title\r\n

Example Response: XMLTEXT OK This is the title of the first input\r\n

Example Request: XMLTEXT vmix/inputs/input[6]/text[@name='Headline']\r\n

Example Response: XMLTEXT OK This is the value of Headline text field in title input that is the number 6 (index 5) input.\r\n

Description: Uses the XPATH syntax to retrieve individual text values of the XML state.


Use

Code:
vmix/streaming

Code:
vmix/recording

Code:
vmix/external


As XPath parameter.


Awesome, thanks elgarf! A follow up question, though:
It isn't possible to subscribe to the XMLTEXT, so I need to poll to know the status. Is there another, more efficient way, of retrieving the data rather than polling it every 5 seconds?
elgarf  
#4 Posted : Tuesday, October 13, 2020 3:25:56 AM(UTC)
elgarf

Rank: Advanced Member

Groups: Registered
Joined: 10/23/2015(UTC)
Posts: 425
Man
Russian Federation

Thanks: 19 times
Was thanked: 181 time(s) in 111 post(s)
Not sure you can subscribe to XMLTEXT

https://www.vmix.com/help23/TCPAPI.html
guidogast  
#5 Posted : Tuesday, October 13, 2020 3:31:03 AM(UTC)
guidogast

Rank: Advanced Member

Groups: Registered
Joined: 5/19/2017(UTC)
Posts: 41
Netherlands
Location: The Netherlands

Thanks: 7 times
Was thanked: 23 time(s) in 14 post(s)
It isn't possible, that's the problem. I'll add it on the features request board.

Thanks for your help elgarf!
Users browsing this topic
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.