logo

Live Production Software Forums

www.vmix.com

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

Notification

Icon
Error
XML API should include more data of each <overlay> - Currently only includes pan X,Y and zoom X,Y
Options
Go to last post Go to first unread
Previous Topic Next Topic
stigaard  
#1 Posted : Thursday, April 29, 2021 6:24:42 AM(UTC)
stigaard

Rank: Advanced Member

Groups: Registered
Joined: 5/20/2015(UTC)
Posts: 493
Man
Denmark
Location: Copenhagen, Denmark

Thanks: 389 times
Was thanked: 100 time(s) in 79 post(s)
The XML API currently only returns pan X,Y and zoom X,Y for each layer of each input (Virtual Set or input used as 'multi view'. (See attached XML snippet.)

It could include way more data such as:

  • active (whether the layer is actually activated or deactivated)
  • zoomZ
  • cropX1
  • cropX2
  • cropY1
  • cropY2
  • borderActive
  • borderThickness
  • borderRadius
  • borderColor


Code:
<input key="a9967373-edee-4322-9efe-e29885d6bc25" number="4" type="VirtualSet" title="1 virtualstudiosets.com_9B-MID" shortTitle="1 virtualstudiosets.com_9B-MID" state="Paused" position="0" duration="0" loop="False" selectedIndex="2">
1 virtualstudiosets.com_9B-MID
<overlay index="0" key="69d87c32-54e0-4450-a356-315932d72efb"/>
<overlay index="1" key="5addb368-dc84-4797-81e3-1791b3b3190c"/>
<overlay index="2" key="c4f3834b-1844-49c8-a190-b3a0bcf0565c"/>
<overlay index="3" key="0adf56e8-b1fa-4e6d-a6f7-9735429cd466">
<position panY="-0.7" zoomY="0.3"/>
</overlay>
<position zoomX="1.5" zoomY="1.5"/>
</input>
Back to top
WWW BLOG

Wanna join the discussion?! Login to your vMix Forums forum account, or Register a new forum account.
Back to top  
tk421  
#2 Posted : Sunday, June 6, 2021 1:18:27 AM(UTC)
tk421

Rank: Member

Groups: Registered
Joined: 5/8/2021(UTC)
Posts: 11
Canada
Location: Burnaby

Thanks: 1 times
Was thanked: 11 time(s) in 3 post(s)
+1
Back to top
tk421  
#3 Posted : Sunday, June 6, 2021 1:23:28 AM(UTC)
tk421

Rank: Member

Groups: Registered
Joined: 5/8/2021(UTC)
Posts: 11
Canada
Location: Burnaby

Thanks: 1 times
Was thanked: 11 time(s) in 3 post(s)
Working with virtual meeting talent that are too nervous to remember to stay in the center of their screen can be very difficult to PIP. This API functionality would greatly benefit a workflow for this. I would bet many people are in this situation.
Back to top
Dragon  
#4 Posted : Sunday, June 6, 2021 9:21:18 AM(UTC)
Dragon

Rank: Newbie

Groups: Registered
Joined: 6/6/2021(UTC)
Posts: 5
Germany

Thanks: 2 times
+1 This feature would be very very useful for me.

Additional to stigaards example I would like to have the information which input is connected to which layer. I can set this using the "SetLayer" command, but I can not read it from VMix.

Would be very nice if you could add this information to the XML.
Back to top
doggy  
#5 Posted : Sunday, June 6, 2021 3:35:42 PM(UTC)
doggy

Rank: Advanced Member

Groups: Registered
Joined: 12/27/2012(UTC)
Posts: 5,222
Belgium
Location: Belgium

Thanks: 293 times
Was thanked: 955 time(s) in 790 post(s)
Originally Posted by: Dragon Go to Quoted Post

Additional to stigaards example I would like to have the information which input is connected to which layer. I can set this using the "SetLayer" command, but I can not read it from VMix.

Would be very nice if you could add this information to the XML.


the <overlay index="X" ......> gives the key of the input in a layer !
So on can read it and get more details from the layered input consequently
Back to top
thanks 1 user thanked doggy for this useful post.
Dragon on 6/6/2021(UTC)
ron2210  
#6 Posted : Sunday, June 6, 2021 6:19:56 PM(UTC)
ron2210

Rank: Member

Groups: Registered
Joined: 8/4/2020(UTC)
Posts: 16
Man
India
Location: Mumbai

Thanks: 16 times
Was thanked: 4 time(s) in 2 post(s)
+1
Plus the ability to Set Crop via Shortcuts/API
Back to top
Dragon  
#7 Posted : Sunday, June 6, 2021 8:34:06 PM(UTC)
Dragon

Rank: Newbie

Groups: Registered
Joined: 6/6/2021(UTC)
Posts: 5
Germany

Thanks: 2 times
Originally Posted by: doggy Go to Quoted Post

the <overlay index="X" ......> gives the key of the input in a layer !
So on can read it and get more details from the layered input consequently


Thank you! I thought I tested that. Now I tested it again and it works sometimes but not everytime.

Have a look at my setup:
Input setup

I have 4 Inputs.
  • Colour green
  • Colour blue
  • Multiview1
    • Layer left: green
    • Layer right: blue

  • VirtualSet with many layers:
    • Layer 1 (Skyline): green
    • layer 3(screen 1): green
    • layer 9: blue


This is the XML I receive, I've shortened some part of the input tag, but I think everything important is present:
Code:

    <inputs>
        <input key="d91d9d63-dc10-47ed-a843-2b14db28eacd" number="1" [...]>Colour green</input>
        <input key="0d04de60-7cea-48aa-8b17-51540ef549f2" number="2" [...]>Colour blue</input>
        <input key="0e3742bb-b818-4c26-9d5d-02d55e8781d9" number="3" [...]selectedIndex="1">
            MultiView1
            <overlay index="0" key="d91d9d63-dc10-47ed-a843-2b14db28eacd">
                <position panX="-0.40625" zoomX="0.724074" zoomY="0.724074" />
            </overlay>
            <overlay index="1" key="0d04de60-7cea-48aa-8b17-51540ef549f2">
                <position panX="0.40625" zoomX="0.724074" zoomY="0.724074" />
            </overlay>
            <overlay index="2" key="429cb531-867a-4fbf-9852-a9d7ac390f73" />
        </input>
        <input key="bbb385bb-4bbd-4643-9d5f-33db7ce42a08" number="4" type="VirtualSet" title="1 virtualstudiosets.com_9B_WIDE" [...] selectedIndex="0">
            1 virtualstudiosets.com_9B_WIDE
            <overlay index="0" key="d91d9d63-dc10-47ed-a843-2b14db28eacd">
                <position panY="0.03375" zoomX="0.65" zoomY="0.65" />
            </overlay>
            <overlay index="1" key="d84f4686-65cd-4753-98b7-d0e5d7cec51c" />
            <overlay index="2" key="e5cd1ad8-79be-45db-98b9-f72af3a7370d">
                <position panX="-0.7" zoomX="0.3" zoomY="0.5" />
            </overlay>
            <overlay index="3" key="aabbf9c4-9e26-445e-959a-ab7dced2040f">
                <position panX="-0.7" zoomX="0.3" zoomY="0.5" />
            </overlay>
            <overlay index="4" key="45858620-332a-4134-8dc1-f33d1c32471a">
                <position panX="0.7" zoomX="0.3" zoomY="0.5" />
            </overlay>
            <overlay index="5" key="fdafa658-f907-4c5f-9aa4-06fb2c24b540">
                <position panX="0.7" zoomX="0.3" zoomY="0.5" />
            </overlay>
            <overlay index="6" key="79a55452-e327-42ad-8aca-c41663d1ad04">
                <position panY="0.09" zoomX="0.28" zoomY="0.28" />
            </overlay>
            <overlay index="7" key="1785a74e-a867-41fd-9355-c1f897aa9121">
                <position panY="-0.375" zoomY="0.5" />
            </overlay>
            <overlay index="8" key="141d61a1-6fa4-4b7a-91d6-4fef3263fd15">
                <position panY="-0.375" zoomX="0.2" zoomY="0.5" />
            </overlay>
            <overlay index="9" key="8db60d52-df8c-4684-b7fa-84bd09149886">
                <position panY="-0.375" zoomX="0.2" zoomY="0.5" />
            </overlay>
        </input>
    </inputs>


So as you can see it's working fine for MultiView 1. Both overlays have their key set to the key of Input number 1 and 2. This is the expected behaviour.
But for input number 4 things start to go wrong:
Overlay index 0 is connected to Input number 1 (d91d9d63-dc10-47ed-a843-2b14db28eacd), this is correct. But Overlay index 2 is connected to input key e5cd1ad8-79be-45db-98b9-f72af3a7370d. This key does not exist anywhere else in the XML document. Overlay index 2 should be connected to input number 2 (0d04de60-7cea-48aa-8b17-51540ef549f2). Same problem exists with overlay index 8, this should be connected to input number 2.

So I would like to change my feature request to a likely bug report. I'm using vMix version 24.0.0.58 in the Pro edition.

Should I post the bug report somewhere else or is this fine in this thread?

Also it would be nice if someone could confirm my analysis.
Back to top
doggy  
#8 Posted : Sunday, June 6, 2021 9:08:47 PM(UTC)
doggy

Rank: Advanced Member

Groups: Registered
Joined: 12/27/2012(UTC)
Posts: 5,222
Belgium
Location: Belgium

Thanks: 293 times
Was thanked: 955 time(s) in 790 post(s)
Originally Posted by: Dragon Go to Quoted Post


But for input number 4 things start to go wrong:
Overlay index 0 is connected to Input number 1 (d91d9d63-dc10-47ed-a843-2b14db28eacd), this is correct. But Overlay index 2 is connected to input key e5cd1ad8-79be-45db-98b9-f72af3a7370d. This key does not exist anywhere else in the XML document. Overlay index 2 should be connected to input number 2 (0d04de60-7cea-48aa-8b17-51540ef549f2). Same problem exists with overlay index 8, this should be connected to input number 2.

So I would like to change my feature request to a likely bug report. I'm using vMix version 24.0.0.58 in the Pro edition.

Should I post the bug report somewhere else or is this fine in this thread?

Also it would be nice if someone could confirm my analysis.


believe they refer to their placeholders which are not inputs but IMO thy should reflectwhen an input is assigned . Report it! (Released section , not here)
Back to top
Users browsing this topic
Guest
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.

Privacy Policy | Powered by YAF.NET | YAF.NET © 2003-2024, Yet Another Forum.NET
This page was generated in 0.159 seconds.