Algemeen

De APIis, indien ingeschakeld, beschikbaar op "http://localhost:8989/api/v1". Dit is de basis URL die moet worden toegevoegd aan elke methode URL hieronder vermeld.

Als een bron is geïntroduceerd na de initiële lancering van de HTTP APIwordt de methode gemarkeerd met een Beschikbaar sinds informatie.

/

Ondersteunde methoden: "GET"
Verwijst naar de lijst met open documenten op "/documenten".

/apparaten

Ondersteunde methoden: "GET"
Retourneert een lijst van momenteel beschikbare videoapparaten op het hostsysteem. Elk item bevat een identificatie en een menselijk leesbare naam. Nuttig voor het toewijzen van opnameapparaten aan Bronnen.

/apparaten/(ApparaatID)

Ondersteunde methoden: "GET"
Retourneert details voor het apparaat gespecificeerd door "(DeviceID)", inclusief de naam en eigenschappen.

Documenten

Documenten opvragen

/documenten

Ondersteunde methoden: "GET"
Resulteert in een lijst met open documenten. Zie het gegevenstype documenten voor meer informatie over de geretourneerde objecten.

/documenten/(DocumentID)

Ondersteunde methoden: "GET"
Retourneert een enkel document gespecificeerd door "(DocumentID)". In het inbegrepen gedeelte van het antwoord worden alle "laag" objecten die gebruikt worden door dit document en alle "bron" objecten in dit document ook geretourneerd (sideloading). Zie het gegevenstype documenten voor meer informatie over de geretourneerde gegevens.

/documenten/(DocumentID)/programmaUit

Ondersteunde methoden: "GET"
De programma-uitvoer die momenteel wordt geproduceerd door het document dat is opgegeven door "(DocumentID)".
Neemt dezelfde parameters als bronvoorvertoningen.

Document acties

/documenten/(DocumentID)/setLive

Ondersteunde methoden: "GET" "POST"
Start een show/document en activeert alle bijbehorende gebeurtenissen. Dit aanroepen op een al lopend document zal niet resulteren in een fout. Het bijgewerkte documentobject wordt geretourneerd.

/documenten/(DocumentID)/setOff

Ondersteunde methoden: "GET" "POST"
Stopt een show/document. Als je dit aanroept bij een show die al gestopt is, zal er geen fout optreden. Het bijgewerkte documentobject wordt geretourneerd.

Omdat een document kan besluiten te blijven draaien nadat je deze methode hebt aangeroepen, kan het geretourneerde laagobject de status "shutdown" hebben in plaats van "off".

/documenten/(DocumentID)/toggleLive

Ondersteunde methoden: "GET" "POST"
Schakelt een show/document tussen live en uit.

Lagen

Lagen opvragen

/documenten/(DocumentID)/lagen

Ondersteunde methoden: "GET"
Retourneert een lijst met lagen voor het document gespecificeerd door "(DocumentID)". Zie het gegevenstype lagen voor informatie over de objecten die worden geretourneerd.

/documenten/(DocumentID)/lagen/(LayerID)

Ondersteunde methoden: "GET", "PUT"
Retourneert een enkele laag gespecificeerd door de "(LayerID)" in het document gespecificeerd door "(DocumentID)". In het gedeelte "inclusief" van het antwoord worden alle "variant"-objecten met betrekking tot deze laag ook geretourneerd (zijwaarts laden). Zie het gegevenstype van de lagen voor meer informatie over de geretourneerde gegevens. Houd er rekening mee dat de "input-waarden" van het layer endpoint de "input-waarden" van de bijbehorende "liveVariant" variant weergeven.

Een laag wijzigen

Ondersteunde methoden: "GET", "PUT"
Voer een " " uit om de naam van de laag, het audiovolume of de invoerwaarden in te stellen.PUT" verzoek met een JSON gecodeerd object naar het eindpunt van de laag. Je kunt ook een "GET" verzoek door de JSON gegevens naar de URL met de sleutel "?update=". In dit geval wordt de JSON gegevens moeten URL gecodeerd.

Waarden die je niet wilt wijzigen moeten gewoon worden uitgesloten van de JSON gegevens. Voorbeeld:

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

Na het bijwerken van de waarden zal mimoLive reageren met een bijgewerkt laagobject. Houd er rekening mee dat niet alle waarden onmiddellijk kunnen worden toegepast of pas na een andere rendercyclus effect kunnen hebben.

Opmerking: Het "volume" attribuut is toegevoegd in mimoLive 5.6 en wordt genegeerd in eerdere versies of als de laag geen volumeregeling heeft. De waarde wordt geclipt naar (0, 1), waarbij 0 stil is en 1 vol volume.

Laagacties

/documenten/(DocumentID)/lagen/(LaagID)/setLive

Ondersteunde methoden: "GET" "POST"
Activeert een laag, als dit direct op de laag wordt aangeroepen, wordt de laatst geselecteerde laagvariant gebruikt. Als je dit aanroept op een laag die al actief is, zal er geen fout optreden. Het bijgewerkte laagobject wordt geretourneerd.

/documenten/(DocumentID)/lagen/(LaagID)/setOff

Ondersteunde methoden: "GET" "POST"
Deactiveert een laag. Als je dit aanroept op een laag die al gedeactiveerd is, zal er geen fout optreden. Het bijgewerkte laagobject wordt geretourneerd.

Omdat een laag kan besluiten om animaties uit te voeren nadat je deze methode hebt aangeroepen, kan het geretourneerde laagobject de status "shutdown" hebben in plaats van "off".

/documenten/(DocumentID)/lagen/(LayerID)/toggleLive

Ondersteunde methoden: "GET" "POST"
Schakelt een laag tussen "live" en "uit".

/documenten/(DocumentID)/lagen/(LayerID)/signalen/(SignalID)

Ondersteunde methoden: "GET" "POST"
Activeert het signaal gespecificeerd door "(SignalID)" in de huidige "live-variant" of als de laag niet live is in de "actieve-variant". Je kunt het "(SignalID)" uit het "input-values" veld van de laag halen (geïdentificeerd door het sleutelachtervoegsel "_TypeSignal").

/documenten/(DocumentID)/lagen/(LaagID)/cycleThroughVariants

Ondersteunde methoden: "GET" "POST"
Beschikbaar sinds: mimoLive 5.6
Selecteert de eerstvolgende variant na de huidige actieve variant van laag "(LayerID)" als de nieuwe actieve variant van de laag. Dit kan worden gebruikt om de variant te selecteren (bijv. van een Lower Third-laag) die live moet gaan. volgende.
Het aanroepen van dit eindpunt verstoort je show niet als de laag op dat moment live is. Het effect wordt alleen weergegeven als de laag daarna live wordt gezet.

/documenten/(DocumentID)/lagen/(LaagID)/cycleThroughVariantsBackwards

Ondersteunde methoden: "GET" "POST"
Selecteert de vorige variant (het omgekeerde van /cycleThroughVariants) zonder de huidige live-status te beïnvloeden. Het effect wordt zichtbaar wanneer de laag of de geselecteerde variant live wordt gezet.

/documenten/(DocumentID)/lagen/(LaagID)/setLiveFirstVariant

Ondersteunde methoden: "GET" "POST"
Activeert de eerste variant van de laag en zet de laag live.

/documenten/(DocumentID)/lagen/(LaagID)/setLiveLastVariant

Ondersteunde methoden: "GET" "POST"
Activeert de laatste variant van de laag en zet de laag live.

/documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand)

Ondersteunde methodes:"GET" "POST"
Stuurt een media controle commando naar het medium dat gebonden is aan ingang "(SourceInputKey)" van de gespecificeerde laag. Merk op dat de bron van de ingang rapporteert welke commando's het ondersteunt; zie /documents/(DocumentID)/sources/(SourceID).

Opdracht voor mediabesturing	Beschrijving
spelen	Start het afspelen van media.
pauze	Pauzeert de huidige weergave zonder de positie te resetten.
stop	Stopt het afspelen en zet de mediapositie terug naar het begin.
omgekeerde	Speelt media in omgekeerde richting af.
terugspoelen	Hiermee gaat het afspelen achteruit, meestal sneller dan normaal.
fastforward	Hiermee gaat het afspelen snel vooruit.
skiptostart	Springt naar het begin van de media.
skiptoend	Springt naar het einde van de media.
skip terug	Gaat met een interval van 10 seconden achteruit.
skipahead	Gaat 10 seconden vooruit.
record	Start de opname van de media-ingang.
shuffle	Schakelt de willekeurige afspeelvolgorde voor media-items in.
herhaal	Herhaal de huidige media.

Varianten

Varianten opvragen

/documenten/(DocumentID)/lagen/(LayerID)/varianten

Ondersteunde methoden: "GET"
Retourneert een lijst met varianten voor de laag gespecificeerd door "(LayerID)" en het document gespecificeerd door "(DocumentID)". Zie het gegevenstype "varianten" voor informatie over de geretourneerde objecten.

/documenten/(DocumentID)/lagen/(LayerID)/varianten/(VariantID)

Ondersteunde methoden: "GET", "PUT"
Retourneert een enkele variant gespecificeerd door "(VariantID)" en "(LayerID)" in het document gespecificeerd door "(DocumentID)". Zie het gegevenstype "varianten" voor meer informatie over de geretourneerde gegevens.

Een variant wijzigen

Als u de naam van de variant of invoerwaarden wilt instellen, voert u een "PUT" verzoek met een JSON gecodeerd object naar het variant eindpunt. Waarden die je niet wilt wijzigen moeten eenvoudigweg worden uitgesloten van de JSON u "PUT". Voorbeeld:

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

Na het bijwerken van de waarden zal mimoLive reageren met een bijgewerkt variantobject. Houd er rekening mee dat niet alle waarden onmiddellijk kunnen worden toegepast of pas na een andere rendercyclus effect kunnen hebben.

Variant acties

/documenten/(DocumentID)/lagen/(LayerID)/varianten/(VariantID)/setLive

Ondersteunde methoden: "GET" "POST"
Activeert een variant, als de eigen laag niet live is wordt deze ook live gezet. Als je dit aanroept op een variant die al actief is, levert dit geen fout op. Het bijgewerkte variantobject wordt geretourneerd.

/documenten/(DocumentID)/lagen/(LayerID)/varianten/(VariantID)/setOff

Ondersteunde methoden: "GET" "POST"
Deactiveert een variant. Hierdoor wordt ook de eigen laag uitgeschakeld.

/documenten/(DocumentID)/lagen/(LayerID)/varianten/(VariantID)/toggleLive

Ondersteunde methoden: "GET" "POST"
Schakelt een variant tussen live en uit.

/documenten/(DocumentID)/lagen/(LayerID)/varianten/(VariantID)/signalen/(SignalID)

Ondersteunde methoden: "GET" "POST"
Activeert het signaal gespecificeerd door "(SignalID)" op de variant. Je kunt het "(SignalID)" uit het veld "input-values" van de laag halen (geïdentificeerd door het sleutelachtervoegsel "_TypeSignal").

Bronnen

Bronnen opvragen

/documenten/(DocumentID)/bronnen

Ondersteunde methoden: "GET"
Retourneert een lijst met bronnen voor het document gespecificeerd door "(DocumentID)". Zie het gegevenstype "bronnenlaag" voor informatie over de objecten die worden geretourneerd.

/documenten/(DocumentID)/bronnen/(BronID)

Ondersteunde methoden: "GET", "PUT"
Retourneert een enkele bron gespecificeerd door "(SourceID)" in het document gespecificeerd door "(DocumentID)". In het inbegrepen gedeelte van het antwoord worden alle "filter"-objecten met betrekking tot deze bron ook geretourneerd (zijwaarts laden). Zie het gegevenstype "bronnen" voor meer informatie over de geretourneerde gegevens.

/documenten/(DocumentID)/bronnen/(SourceID)/voorvertoning

Ondersteunde methoden: "GET"
Geeft een grafisch voorbeeld van de bron gespecificeerd door de "(SourceID)" in het document gespecificeerd door "(DocumentID)". Het eindpunt ondersteunt de volgende parameters:

Parameter	Standaard	Beschrijving
formaat	png	Het formaat waarin het voorbeeld wordt geretourneerd. Toegestane waarden: png, jpeg, mjpeg, mpng
fps	10	De framerate voor voorvertoningen van bewegende beelden. Alleen van toepassing op mjpeg- en mpng-indelingen. Houd er rekening mee dat 1 fps ongeveer gelijk is aan 1% van CPU gebruik.
breedte	(documentbreedte)	De maximale breedte van het voorbeeld. De afbeelding wordt verkleind tot de opgegeven breedte.
hoogte	(documentbreedte)	De maximale hoogte van de preview. De afbeelding wordt verkleind tot de opgegeven hoogte.

/documenten/(DocumentID)/bronnen/(SourceID)/mediacontrol/(MediaControlCommand)

Ondersteunde methodes: "GET" "POST"
Controleert het afspelen voor bronnen die geschikt zijn voor media (bijv. Mediabestand/afspeellijst). Ondersteunde commando's zijn afhankelijk van het type bron. Zie /documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand) .

/documenten/(DocumentID)/bronnen/(SourceID)/openwebbrowser

Ondersteunde methoden: "GET"
In het geval dat de bron een Web Browser Capture bron is, zal deze actie het corresponderende web browser venster openen.

Een bron wijzigen

Om de naam van de bron of invoerwaarden in te stellen (alleen als de bron die heeft, bijvoorbeeld als het een Compositiebron is) voert u een "PUT" verzoek met een JSON gecodeerd object naar het bron eindpunt. Waarden die u niet wilt wijzigen, moeten eenvoudigweg worden uitgesloten van de JSON u "PUT". Voorbeeld:

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

Het "gain" attribuut is toegevoegd in mimoLive 5.6 en wordt genegeerd in eerdere versies of als de bron geen versterkingsregeling heeft. De waarde wordt geclipt naar (0, 2), waarbij 0 stil is, 1 standaard is en 2 het volume ongeveer verdubbelt.

Bron Acties

/documenten/(DocumentID)/bronnen/(SourceID)/signalen/(SignalID)

Ondersteunde methoden: "GET" "POST"
Triggert het signaal gespecificeerd door "(SignalID)" op de bron (alleen als de bron "invoerwaarden" heeft, bijvoorbeeld als het een samenstellingsbron is). U kunt het "(SignalID)" uit het "input-values" veld van de bron halen (geïdentificeerd door het sleutelachtervoegsel "_TypeSignal").

Filters

Filters opvragen

/documenten/(DocumentID)/bronnen/(SourceID)/filters

Ondersteunde methoden: "GET"
Retourneert een lijst met filters voor de bron opgegeven door "(SourceID)" en het document opgegeven door "(DocumentID)". Zie het gegevenstype "filters" voor informatie over de geretourneerde objecten.

/documenten/(DocumentID)/bronnen/(SourceID)/filters/(FilterID)

Ondersteunde methoden: "GET", "PUT"
Retourneert een enkel filter gespecificeerd door "(FilterID)" en "(SourceID)" in het document gespecificeerd door "(DocumentID)". Zie het gegevenstype "filters" voor meer informatie over de geretourneerde gegevens.

Een filter wijzigen

Voer een "PUT" verzoek met een JSON gecodeerd object naar het filtereindpunt. Waarden die u niet wilt wijzigen, moeten eenvoudig worden uitgesloten van het JSON u "PUT". Voorbeeld:

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

/documenten/(DocumentID)/bronnen/(SourceID)/filters/(FilterID)/signalen/(SignalID)

Ondersteunde methoden: "GET" "POST"
Triggert het signaal gespecificeerd door "(SignalID)" op het filter. Je kunt het "(SignalID)" uit het veld "input-values" van het filter halen (geïdentificeerd door het sleutelachtervoegsel "_TypeSignal").

Uitvoer Bestemmingen

Uitvoerbestemmingen opvragen

/documenten/(DocumentID)/uitvoer-bestemmingen

Ondersteunde methoden: "GET"
Toont alle uitvoerbestemmingen voor het opgegeven document.
Voor informatie over de geretourneerde objecten, zie het gegevenstype ""output-destinations"":{TOPIC-LINK+data-typesh1(}. section-output-bestemmingen).

/documenten/(DocumentID)/uitvoer-bestemmingen/(uitvoer-bestemmingID)

Ondersteunde methoden: "GET"
Geeft als resultaat de uitvoerbestemming opgegeven door "(OutputDestinationID)".
Voor informatie over de geretourneerde objecten, zie het gegevenstype ""output-destinations"":{TOPIC-LINK+data-typesh1(}. section-output-bestemmingen).

Een uitvoerbestemming wijzigen

/documenten/(DocumentID)/uitvoer-bestemmingen/(uitvoer-bestemmingID)

Ondersteunde methoden: "PUT", "PATCH"
Update geselecteerde eigenschappen van de uitvoerbestemming opgegeven door "(OutputDestinationID)".
Geeft de bijgewerkte uitvoerbestemming terug.

De volgende eigenschappen kunnen worden aangepast:

• "title"
• "begint-met-show"
• "stopt-met-show"
• Inhoud van het "settings" object (zie de instellingen beschrijving. section-individual-settings) voor meer informatie)

De updatebeschrijving moet worden gegeven in JSON:API updateformaat . crud-updating). Voorbeeld:

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

Uitvoer Bestemming Acties

/documenten/(DocumentID)/uitvoer-bestemmingen/(uitvoer-bestemmingID)/setLive

Ondersteunde methoden: "GET" "POST"
Zorgt ervoor dat de uitvoerbestemming gespecificeerd door "(OutputDestinationID)" live gaat, als het juist is geconfigureerd en het is toegestaan om live te gaan (bijv. gebaseerd op de mimoLive licentiestatus).
Als de uitvoerbestemming live kan gaan, wordt de uitvoerbestemming met zijn nieuwe "live-status" geretourneerd, anders wordt een "409 Conflict" fout geretourneerd.

Omdat een uitvoerbestemming mogelijk wat werk moet verrichten voordat deze live is (bijvoorbeeld contact opnemen met een externe service om een live stream te maken), kan het geretourneerde object van de uitvoerbestemming de status "opstarten" hebben in plaats van "live".

/documenten/(DocumentID)/uitvoer-bestemmingen/(uitvoer-bestemmingID)/setOff

Ondersteunde methoden: "GET" "POST"
Zorgt ervoor dat de uitvoerbestemming opgegeven door "(OutputDestinationID)" wordt gestopt.
Als de uitvoerbestemming mag stoppen, wordt de uitvoerbestemming geretourneerd, anders wordt een "409 Conflict" fout geretourneerd.

Omdat een uitvoerbestemming mogelijk wat werk moet verrichten voordat de bewerkingen worden gestopt, kan de geretourneerde uitvoerbestemming de status "shutdown" hebben in plaats van "preview" (wat de standaard zou zijn voor een goed geconfigureerde uitvoerbestemming).

Laag sets

Lagen sets werden geïntroduceerd in mimoLive 5.0 en maken het mogelijk om de live-status van meerdere lagen tegelijk in te stellen. scènes voor verschillende situaties in een show. Ze kunnen alleen in mimoLive aangemaakt en beheerd worden. API de toegang is beperkt tot het verkrijgen en terugroepen (activerende) lagenreeksen.

Laagsets opvragen

/documenten/(DocumentID)/lagen-sets

textileRef:9996801466400ba8908856:linkStartMarker:“Ondersteunde methoden: "GET"
Beschikbaar sinds: mimoLive 5.0
Toont alle sets lagen voor het opgegeven document.
Voor informatie over de objecten die worden geretourneerd, zie het gegevenstype ""layer-sets"":{TOPIC-LINK+data-typesh1(}. section-layer-sets).

/documenten/(DocumentID)/lagen-sets/(LayerSetID)

Ondersteunde methoden: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Retourneert de laagset gespecificeerd door "(LayerSetID)".
Voor informatie over de objecten die worden geretourneerd, zie het gegevenstype ""layer-sets"":{TOPIC-LINK+data-typesh1(}. section-layer-sets).

Acties laagset

/documenten/(DocumentID)/lagen-sets/(LayerSetID)/oproepen

Ondersteunde methoden: "GET" "POST"
Roept de door "(LayerSetID)" gespecificeerde lagenverzameling op (activeert), waardoor alle lagen de live-status aannemen die in de lagenverzameling is vastgelegd.
Geeft de ingestelde laag terug na het terugroepen, dus met "active == true".

Gegevensopslag

/documenten/(DocumentID)/datastores/(StoreID)

Ondersteunde methoden: "GET", "PUT", "DELETE"
mimoLive biedt de mogelijkheid om gegevens die je aanlevert op te slaan in het documentbestand, bijvoorbeeld om een toestand op een later tijdstip te herstellen. Je bent vrij om zelf een "StoreID" te kiezen, maar wees je ervan bewust dat er geen manier is om een lijst te maken van alle data stores die geassocieerd zijn met een document (je kunt echter wel een soort van index store die je andere, dynamisch benoemde stores bijhoudt).

Een gegevensopslag maken/bijwerken

Om een data store te maken of bij te werken stuur je een "PUT" verzoek naar een "StoreID" van uw keuze met de bijbehorende gegevens in de body van uw verzoek. Als de bewerking succesvol was, zal mimoLive reageren met een "200 OK"-status.

Inhoud van een gegevensopslag lezen

Om een eerder opgeslagen gegevensopslag te lezen, vraagt u deze eenvoudig op via "GET". De gegevens worden precies geretourneerd zoals je ze hebt opgegeven in de "PUT" verzoek om het op te slaan. Als er geen data store met die ID is gevonden voor dit document zal mimoLive een "404 Not Found" fout teruggeven.

Een bestaande gegevensopslag verwijderen

Om een gegevensopslag te verwijderen als je die niet langer nodig hebt, geef je gewoon een "DELETE" verzoek voor de "StoreID" die u wilt verwijderen. In het geval dat de data store er in eerste instantie niet was zal mimoLive reageren met een "404 Not Found" foutmelding.

Zoom vergaderingen

Deze eindpunten besturen de ingebouwde Zoom-clientintegratie van mimoLive.

/zoom/samenvoegen

Ondersteunde methodes:"GET" "POST"
Aanmelden bij een Zoom vergadering. Typische parameters (stuur als JSON body voor POST of ?param=waarde voor GET):

Parameter	Waardetype	Beschrijving
vergadernummer	String	Zoom vergadernummer
wachtwoordcode	String, optioneel	Wachtwoord vergadering
weergavenaam	String, optioneel	Naam die in de vergadering moet verschijnen
mute-audio	Bool, optioneel	Gedempt starten
mute-video	Bool, optioneel	Begin met video uit

Retourneert een statusobject dat de voortgang of het succes van de verbinding aangeeft.

/zoom/verlaten

Ondersteunde methoden:"GET" "POST"
Verlaat de huidige vergadering. Geeft een statusobject terug.

/zoom/einde

Ondersteunde methoden:"GET" "POST"
Probeert de huidige Zoom vergadering te beëindigen/beëindigen (alleen host actie). Geeft succes als de vergadering is beëindigd of een conflict als de client geen toestemming heeft.

/zoom/deelnemers

Ondersteunde methoden:"GET" "POST"
Retourneert de huidige deelnemerslijst voor de samengevoegde vergadering (namen, ID's en basisstatussen).

Waarde Sleutel	Waardetype	Beschrijving
naam	String	Naam van de Zoom-deelnemer
id	Geheel getal	Gebruikers-ID van de Zoom-deelnemer
userRole	String
isHost	Bool	true als de gebruiker gastheer van de vergadering is
isCoHost	Bool	true als de gebruiker mede-gastheer van de vergadering is
isVideoOn	Bool	true als de gebruiker video heeft ingeschakeld
isAudioOn	Bool	true als de gebruiker audio heeft ingeschakeld
isTalking	Bool	true als de gebruiker momenteel in gesprek is
isRaisingHand	Bool	true als de gebruiker op dit moment zijn hand omhoog houdt

/zoom/vergaderactie

Voert een vergadering-gedeelde actie uit. Geef actie en optionele argumenten op via JSON body of query string.

Parameter	Waardetype	Beschrijving
commando	String	Een opdracht uit de onderstaande lijst
userid	String, optioneel	Voor sommige opdrachten is een gebruikers-ID vereist
screentype	String, optioneel	Voor sommige opdrachten is een schermtype vereist

Commando	Beschrijving
requestRecordingPermission	Stuur een verzoek voor lokale toestemming voor opname.
muteVideo	De video van een gebruiker dempen. (parameter userid vereist)
unmuteVideo	De video van een gebruiker dempen. (parameter userid vereist)
muteAudio	Het geluid van een gebruiker uitschakelen. (parameter userid vereist)
unmuteAudio	De audio van een gebruiker dempen. (parameter userid vereist)
enableUnmuteBySelf	Schakel de functie in dat gebruikers zichzelf kunnen opheffen als ze gedempt zijn, alleen beschikbaar voor de host/co-host.
disableUnmuteBySelf	Schakel de functie uit dat gebruikers zichzelf niet kunnen opheffen als ze gedempt zijn, deze functie is alleen beschikbaar voor de host/co-host.
muteAll	Alle deelnemers aan de vergadering uitschakelen, alleen beschikbaar voor de host/co-host.
unmuteAlle	Alle deelnemers aan de vergadering op mute zetten, alleen beschikbaar voor de host/co-host.
lockMeeting	Vergrendel de vergadering, alleen beschikbaar voor de host/co-host. Eenmaal vergrendeld kunnen nieuwe deelnemers niet meer deelnemen.
unlockMeeting	Ontgrendel de vergadering, alleen beschikbaar voor de host/co-host.
lowerAllHands	Doe de handen van alle deelnemers omlaag, alleen beschikbaar voor de host/co-host.
shareFitWindowMode	Pas de schermgrootte aan het venster aan.
pauseShare	Delen onderbreken.
resumeShare	Delen van cv's.
joinVoip	Vergadering bijwonen via VoIP.
leaveVoip	Verbreek de verbinding tussen VoIP en de vergadering.
allowParticipantsToChat	Schakel de functie in waarmee gebruikers met elkaar kunnen chatten.
disallowParticipantsToChat	Schakel de functie uit waarmee gebruikers met elkaar kunnen chatten.
allowParticipantsToShare	Schakel de functie in waarmee gebruikers hun scherm kunnen delen.
disallowParticipantsToShare	Schakel de functie uit waarmee gebruikers hun scherm kunnen delen.
allowParticipantsToStartVideo	Schakel de functie in waarmee gebruikers hun video kunnen starten.
disallowParticipantsToStartVideo	Schakel de functie uit waarmee gebruikers hun video kunnen starten.
allowParticipantsToShareWhiteBoard	Schakel de functie in waarmee gebruikers een whiteboard kunnen delen.
disallowParticipantsToShareWhiteBoard	Schakel de functie uit waarmee gebruikers een whiteboard kunnen delen.
enableAutoAllowLocalRecordingRequest	Schakel de functie in dat opnameverzoeken van gebruikers automatisch worden geaccepteerd.
disableAutoAllowLocalRecordingRequest	Schakel de functie uit dat opnameverzoeken van gebruikers automatisch worden geaccepteerd.
allowParticipantsToRename	Schakel de functie in waarmee gebruikers zichzelf kunnen hernoemen.
disallowParticipantsToRename	Schakel de functie uit waarmee gebruikers zichzelf kunnen hernoemen.
showParticipantProfilePictures	Schakel de optie in om profielfoto's van deelnemers te tonen.
hideParticipantProfilePictures	Schakel de optie uit om profielfoto's van deelnemers te tonen.

Voorbeeldgebruik

Deze eindpunten van de mimoLive HTTP API kunnen op vele manieren gebruikt worden. Raadpleeg de Voorbeelden van API-gebruik sectie voor meer informatie.