mimoLive® - Användarmanual

Generiska selektorer
Endast exakta träffar
Sök i titeln
Sök i innehåll
Val av inläggstyp

Handbok - Innehållsförteckning

Slutpunkter

Innehållsförteckning

Allmänt

The API, när den är aktiverad, är tillgänglig på "http://localhost:8989/api/v1". Detta är basen URL som måste läggas till varje metod URL som anges nedan.

Om en resurs introducerades efter den första lanseringen av HTTP APIär metoden markerad med ett Tillgänglig sedan information.

/

Metoder som stöds: "GET"
Omdirigeringar till listan över öppna dokument på "/documents".

Dokument

Sökning efter dokument

/dokument

Metoder som stöds: "GET"
Ger en lista över öppna dokument. Se datatypen dokument för vilken information de returnerade objekten innehåller.

/dokument/(DokumentID)

Metoder som stöds: "GET"
Returnerar ett enskilt dokument som specificeras av "(DocumentID)". I den inkluderade delen av svaret returneras även alla "layer"-objekt som används av detta dokument och alla "source"-objekt som ingår i detta dokument (sideloading). Se datatypen dokument för mer information om de data som returneras.

/dokument/(DokumentID)/programOut

Metoder som stöds: "GET"
Den programutgång som för närvarande produceras av det dokument som anges av "(DocumentID)".
Använder samma parametrar som för förhandsgranskning av källan.

Åtgärder för dokument

/dokument/(DokumentID)/setLive

Metoder som stöds: "GET" "POST"
Startar ett program/dokument och utlöser alla tillhörande händelser. Att anropa detta på ett dokument som redan körs kommer inte att resultera i ett fel. Det uppdaterade dokumentobjektet kommer att returneras.

/dokument/(DokumentID)/setOff

Metoder som stöds: "GET" "POST"
Stoppar ett program/dokument. Att anropa detta på en redan stoppad show kommer inte att resultera i ett fel. Det uppdaterade dokumentobjektet kommer att returneras.

*Eftersom ett dokument kan fortsätta att köras efter att du har anropat denna metod kan det returnerade lagerobjektet vara i tillståndet "shutdown" istället för "off".

/dokument/(DokumentID)/toggleLive

Metoder som stöds: "GET" "POST"
Växlar ett program/dokument mellan live och off.

Skikt

Förfrågan om skikt

/dokument/(DokumentID)/lager

Metoder som stöds: "GET"
Returnerar en lista över lager för det dokument som anges med "(DocumentID)". För information om de objekt som returneras, se datatypen lager.

/dokument/(DokumentID)/skikt/(SkiktID)

Metoder som stöds: "GET", "PUT"
Returnerar ett enskilt lager som anges av "(LayerID)" i det dokument som anges av "(DocumentID)". I "included"-delen av svaret returneras även alla "variant"-objekt som är relaterade till detta skikt (sidoladdning). Se datatypen lager för mer information om vilka data som returneras. Tänk på att "ingångsvärdena" från skiktets ändpunkt återspeglar "ingångsvärdena" för den associerade "liveVariant"-varianten.

Ändra ett lager

Metoder som stöds: "GET", "PUT"
För att ställa in namn på lager, ljudvolym eller ingångsvärden utför en "PUT" begäran med en JSON kodat objekt till lagrets slutpunkt. Alternativt kan du använda en "GET" genom att lägga till JSON uppgifter till URL med nyckeln "?update=". I detta fall är JSON data måste vara URL kodad.

Värden som du inte vill ändra bör helt enkelt uteslutas från JSON data. Exempel:

{
    "name": "New name of the Layer",
    "volume": 0.5,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

Efter uppdatering av värdena kommer mimoLive att svara med ett uppdaterat lagerobjekt. Tänk på att inte alla värden kan tillämpas omedelbart eller kanske bara har en effekt efter en annan renderingscykel.

Observera: Attributet "volym" har lagts till i mimoLive 5.6 och ignoreras i tidigare versioner eller om lagret inte har någon volymkontroll. Värdet kommer att klippas till (0, 1), där 0 är tyst och 1 är full volym.

Åtgärder för lager

/dokument/(DokumentID)/lager/(LagerID)/setLive

Metoder som stöds: "GET" "POST"
Aktiverar ett lager, när detta anropas direkt på lagret kommer den senast valda lagervarianten att användas. Att anropa detta på ett redan aktivt lager kommer inte att resultera i ett fel. Det uppdaterade lagerobjektet kommer att returneras.

/dokument/(DokumentID)/lager/(LagerID)/setOff

Metoder som stöds: "GET" "POST"
Avaktiverar ett lager. Att anropa detta på ett redan avaktiverat lager kommer inte att resultera i ett fel. Det uppdaterade skiktobjektet returneras.

*Eftersom ett lager kan välja att göra vissa animationer efter att du har anropat den här metoden kan det returnerade lagerobjektet vara i tillståndet "shutdown" istället för "off".

/dokument/(DokumentID)/lager/(LagerID)/toggleLive

Metoder som stöds: "GET" "POST"
Växlar ett lager mellan "live" och "off".

/dokument/(DokumentID)/lager/(LagerID)/signaler/(SignalID)

Metoder som stöds: "GET" "POST"
Utlöser den signal som anges av "(SignalID)" i den aktuella "live-varianten" eller om lagret inte är live i "active-varianten". Du kan hämta "(SignalID)" från fältet "input-values" i skiktet (identifierat med nyckelsuffixet "_TypeSignal").

/dokument/(DokumentID)/lager/(LagerID)/cycleThroughVariants

Metoder som stöds: "GET" "POST"
Tillgänglig sedan: mimoLive 5.6
Väljer nästa variant efter den för närvarande aktiva varianten av lagret "(LagerID)" som lagrets nya aktiva variant. Detta kan användas för att välja den variant (t.ex. av ett Lower Third-lager) som ska gå live nästa.
Att anropa denna slutpunkt stör inte din show om lagret för närvarande är live. Effekten visas endast när lagret sätts live efteråt.

Varianter

Fråga till Variats

/dokument/(DokumentID)/lager/(LagerID)/varianter

Metoder som stöds: "GET"
Returnerar en lista med varianter för det skikt som anges av "(LayerID)" och det dokument som anges av "(DocumentID)". För information om de objekt som returneras, se datatypen "variants".

/dokument/(DokumentID)/lager/(LagerID)/varianter/(VariantID)

Metoder som stöds: "GET", "PUT"
Returnerar en enskild variant som anges av "(VariantID)" och "(LayerID)" i det dokument som anges av "(DocumentID)". Se datatypen "variants" för mer information om de data som returneras.

Ändra en variant

För att ange namnet på varianten eller ingångsvärdena utför en "PUT" begäran med en JSON kodat objekt till variantens slutpunkt. Värden som du inte vill ändra bör helt enkelt uteslutas från JSON du "PUT". Exempel:

{
    "name": "New name of the Variant",
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

Efter uppdatering av värdena kommer mimoLive att svara med ett uppdaterat variantobjekt. Tänk på att alla värden inte kan tillämpas omedelbart eller kanske inte har effekt förrän efter en annan renderingscykel.

Varianta åtgärder

/dokument/(DokumentID)/lager/(LagerID)/varianter/(VariantID)/setLive

Metoder som stöds: "GET" "POST"
Aktiverar en variant, om det ägande lagret inte är live kommer det också att växlas till live. Att anropa detta på en redan aktiv variant kommer inte att resultera i ett fel. Det uppdaterade variantobjektet kommer att returneras.

/dokument/(DokumentID)/lager/(LagerID)/varianter/(VariantID)/setOff

Metoder som stöds: "GET" "POST"
Avaktiverar en variant. Detta kommer också att leda till att det ägande lagret stängs av.

/dokument/(DokumentID)/lager/(LagerID)/varianter/(VariantID)/toggleLive

Metoder som stöds: "GET" "POST"
Växlar en variant mellan live och off.

/dokument/(DokumentID)/lager/(LagerID)/varianter/(VariantID)/signaler/(SignalID)

Metoder som stöds: "GET" "POST"
Utlöser den signal som anges av "(SignalID)" på varianten. Du kan hämta "(SignalID)" från fältet "input-values" i lagret (identifierat med nyckelsuffixet "_TypeSignal").

Källor

Sökning av källor

/dokument/(DokumentID)/källor

Metoder som stöds: "GET"
Returnerar en lista över källor för det dokument som anges med "(DocumentID)". För information om de objekt som returneras, se datatypen "källskikt".

/dokument/(DokumentID)/källor/(KällID)

Metoder som stöds: "GET", "PUT"
Returnerar en enskild källa som anges av "(SourceID)" i det dokument som anges av "(DocumentID)". I den inkluderade delen av svaret returneras även alla "filter"-objekt som är relaterade till denna källa (sidoladdning). Se datatypen "sources" för mer information om vilka data som returneras.

/dokument/(DokumentID)/källor/(KällID)/preview

Metoder som stöds: "GET"
Returnerar en grafisk förhandsgranskning av den källa som anges av "(SourceID)" i det dokument som anges av "(DocumentID)". Slutpunkten stöder följande parametrar:

ParameterStandardBeskrivning
formatpngDet format som förhandsgranskningen returneras i. Tillåtna värden: png, jpeg, mjpeg, mpng
fps10Framerate för förhandsgranskning av rörliga bilder. Gäller endast för formaten mjpeg och mpng. Observera att 1 fps ungefär motsvarar 1% av CPU utnyttjande.
bredd(dokumentets bredd)Förhandsgranskningens maximala bredd. Bilden kommer att skalas ned för att passa in i den angivna bredden.
höjd(dokumentets bredd)Förhandsgranskningens maximala höjd. Bilden kommer att skalas ned för att passa in i den angivna höjden.

Ändra en källa

För att ange namnet på källan eller ingångsvärdena (endast om källan har några, t.ex. om det är en kompositionskälla) utför en "PUT" begäran med en JSON kodat objekt till källans slutpunkt. Värden som du inte vill ändra bör helt enkelt uteslutas från JSON du "PUT". Exempel:

{
    "name": "New name of the Source",
    "gain": 1.25,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

*Attributet "gain" har lagts till i mimoLive 5.6 och ignoreras i tidigare versioner eller om källan inte har någon gain-kontroll. Värdet kommer att klippas till (0, 2), där 0 är tyst, 1 är standard och 2 ungefär fördubblar volymen.

Källa Åtgärder

/dokument/(DokumentID)/källor/(KällID)/signaler/(SignalID)

Metoder som stöds: "GET" "POST"
Utlöser den signal som anges av "(SignalID)" på källan (endast om källan har "input-values", t.ex. om det är en Composition Source). Du kan hämta "(SignalID)" från källans "input-values"-fält (identifierat med nyckelsuffixet "_TypeSignal").

Filter

Förfrågningar om filter

/dokument/(DokumentID)/källor/(KällID)/filter

Metoder som stöds: "GET"
Returnerar en lista med filter för den källa som anges av "(SourceID)" och det dokument som anges av "(DocumentID)". För information om de objekt som returneras, se datatypen "filter".

/dokument/(DokumentID)/källor/(KällID)/filter/(FilterID)

Metoder som stöds: "GET", "PUT"
Returnerar ett enskilt filter som anges av "(FilterID)" och "(SourceID)" i det dokument som anges av "(DocumentID)". Se datatypen "filters" för mer information om de data som returneras.

Ändra ett filter

För att ställa in ingångsvärden utför en "PUT" begäran med en JSON kodat objekt till filtrets slutpunkt. Värden som du inte vill ändra bör helt enkelt uteslutas från JSON du "PUT". Exempel:

{
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

/dokument/(DokumentID)/källor/(KällID)/filter/(FilterID)/signaler/(SignalID)

Metoder som stöds: "GET" "POST"
Utlöser den signal som anges av "(SignalID)" på filtret. Du kan hämta "(SignalID)" från fältet "input-values" i filtret (identifierat med nyckelsuffixet "_TypeSignal").

Utgångsdestinationer

Fråga efter utmatningsdestinationer

/dokument/(DokumentID)/utdata-destinationer

textileRef:9996801466400ba8908856:linkStartMarker:“Metoder som stöds: "GET"
Tillgänglig sedan: mimoLive 4.2
Listar alla utdatadestinationer för det angivna dokumentet.
För information om de objekt som returneras, se datatypen ""output-destinations"":{TOPIC-LÄNK+data-typesh1(}. section-output-destinations).

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

Metoder som stöds: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Tillgänglig sedan: mimoLive 4.2
Returnerar den utdatadestination som anges av "(OutputDestinationID)".
För information om de objekt som returneras, se datatypen ""output-destinations"":{TOPIC-LÄNK+data-typesh1(}. section-output-destinations).

Ändra en utmatningsdestination

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

Metoder som stöds: "PATCH"
Tillgänglig sedan: mimoLive 4.2
Uppdatera valda egenskaper för den utdatadestination som anges av "(OutputDestinationID)".
Returnerar den uppdaterade utdatadestinationen.

Följande egenskaper är modifierbara:

  • "titel"
  • "börjar med show"
  • "stoppar med show"
  • Innehållet i objektet "inställningar" (se Beskrivning av inställningar. section-individual-settings) för mer information)

Uppdaterad beskrivning måste ges i JSON:Format för uppdatering av API . grov uppdatering). Exempel:

{
  "data": {
    "type": "output-destinations",
    "id": "4FF003EA-D071-43FD-845F-DCD4A25DFA00",
    "attributes": {
      "title": "Our Recording",
      "starts-with-show": true,
      "settings": {
        "location": "~/Movies"
      }
    }
  }
}

Utgång Destination Åtgärder

/dokument/(DokumentID)/utdata-destinationer/(UtdataDestinationID)/setLive

Metoder som stöds: "GET" "POST"
Tillgänglig sedan: mimoLive 4.2
Får utdatadestinationen som anges av "(OutputDestinationID)" att gå live, om den är korrekt konfigurerad och tillåten att gå live (t.ex. baserat på mimoLive-licensieringsstatus).
Om utdatadestinationen kan gå live returneras utdatadestinationen med sitt nya "live-state", annars returneras ett "409 Conflict"-fel.

*Eftersom en utdatadestination kan behöva utföra en del arbete innan den är live (t.ex. kontakta en extern tjänst för att skapa en livestream), kan det returnerade utdatadestinationsobjektet vara i tillstånd "startup" istället för "live".

/dokument/(DokumentID)/utdata-destinationer/(UtdataDestinationID)/setOff

Metoder som stöds: "GET" "POST"
Tillgänglig sedan: mimoLive 4.2
Stoppar den utdatadestination som anges med "(OutputDestinationID)".
Om utmatningsdestinationen får stoppas returneras utmatningsdestinationen, annars returneras ett "409 Conflict"-fel.

*Eftersom en utdatadestination kan behöva utföra visst arbete innan den stoppar driften, kan den returnerade utdatadestinationen vara i tillstånd "shutdown" istället för "preview" (vilket skulle vara standard för en välkonfigurerad utdatadestination).

Lageruppsättningar

Lageruppsättningar introducerades i mimoLive 5.0 och gör det möjligt att ställa in livestatus för flera lager samtidigt, vilket möjliggör skapandet av lättviktiga scener för olika situationer i en show. De kan endast skapas och hanteras i mimoLive. API åtkomst är begränsad till erhållande och återkallande (aktiverande) lageruppsättningar.

Fråga efter lageruppsättningar

/dokument/(DokumentID)/lageruppsättningar

textileRef:9996801466400ba8908856:linkStartMarker:“Metoder som stöds: "GET"
Tillgänglig sedan: mimoLive 5.0
Listar alla lageruppsättningar för det angivna dokumentet.
För information om de objekt som returneras, se datatypen ""layer-sets"":{TOPIC-LÄNK+data-typesh1(}. section-layer-sets).

/dokument/(DokumentID)/lageruppsättningar/(Lageruppsättnings-ID)

Metoder som stöds: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Tillgänglig sedan: mimoLive 5.0
Returnerar den skiktuppsättning som anges med "(LayerSetID)".
För information om de objekt som returneras, se datatypen ""layer-sets"":{TOPIC-LÄNK+data-typesh1(}. section-layer-sets).

Åtgärder för lageruppsättning

/dokument/(DocumentID)/lageruppsättningar/(LayerSetID)/återkalla

Metoder som stöds: "GET" "POST"
Tillgänglig sedan: mimoLive 5.0
Återkallar (aktiverar) den lageruppsättning som anges med "(LayerSetID)", vilket gör att alla lager antar det live-tillstånd som registrerats i lageruppsättningen.
Returnerar lageruppsättningen efter återkallelse, dvs. med "active == true".

Datalager

/dokument/(DokumentID)/datalager/(LagerID)

Metoder som stöds: "GET", "PUT", "RADERA"
mimoLive erbjuder möjligheten att lagra data som du tillhandahåller i dokumentfilen, till exempel för att återställa ett tillstånd vid ett senare tillfälle. Du är fri att välja ett "StoreID" själv, men var medveten om att det inte finns något sätt att lista alla datalager som är associerade med ett dokument (du kan dock skapa någon form av index butik som håller reda på dina andra, dynamiskt namngivna butiker).

Skapa/uppdatera ett datalager

För att skapa eller uppdatera ett datalager skicka ett "PUT" till ett valfritt "StoreID" med tillhörande data i brödtexten i din förfrågan. Om operationen var framgångsrik kommer mimoLive att svara med en "200 OK"-status.

Läs innehållet i ett datalager

För att läsa ett tidigare lagrat datalager begär du det enkelt via "GET". Uppgifterna kommer att returneras exakt som du angav dem i "PUT" för att lagra det. Om inget datalager med detta ID hittades för detta dokument kommer mimoLive att returnera ett "404 Not Found"-fel.

Radera ett befintligt datalager

För att radera ett datalager när du inte längre behöver det utfärdar du helt enkelt en "RADERA" för det "StoreID" som du vill radera. I händelse av att datalagret inte fanns där från början kommer mimoLive att svara med ett "404 Not Found"-fel.

Din feedback

Hur skulle du betygsätta din erfarenhet av den här funktionen i mimoLive?

Senaste uppdatering Manual Sidor

Nyhetsbrev via e-post

Svenska

Delta i 24/7 Live Zoom® Demo

*krävs