Kapitel 12 GET POST

publishRecordings – Udgiv/afpublicer

publishRecordings-endpointet skifter synligheden for en eller flere optagelser. Du kan publicere optagelser for at gøre dem tilgængelige via deres afspilnings-URL eller afpublicere dem for at skjule dem for seere, mens filerne beholdes på serveren.

Endepunkt

GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings?<parameter>&checksum=replace-with-checksum

Både GET- og POST-metoder understøttes. Ved brug af POST skal parametre sendes som application/x-www-form-urlencoded i request body.

Parametre

Parameter Type Beskrivelse
recordID String Påkrævet. En kommasepareret liste over optagelses-ID'er, der skal publiceres eller afpubliceres. Du kan angive ét eller flere ID'er i en enkelt forespørgsel.
publish Boolean Påkrævet. Sæt til true for at publicere optagelserne (gøre dem tilgængelige), eller false for at afpublicere dem (skjule dem for seere).

Eksempel på anmodning

Publicer en enkelt optagelse

GET https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings
    ?recordID=replace-with-recording-id
  &publish=true
    &checksum=replace-with-checksum

Afpublicer flere optagelser

GET https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings
    ?recordID=replace-with-recording-id-1,replace-with-recording-id-2
  &publish=false
    &checksum=replace-with-checksum

POST-request med cURL

curl --request POST \
    --url "https://api-guide.bbbserver.com/bigbluebutton/api/publishRecordings" \
  --header "Content-Type: application/x-www-form-urlencoded" \
    --data "recordID=replace-with-recording-id&publish=true&checksum=replace-with-checksum"

Eksempelsvar

Succes

<response>
  <returncode>SUCCESS</returncode>
  <published>true</published>
</response>

Fejl — Optagelse ikke fundet

<response>
  <returncode>FAILED</returncode>
  <messageKey>notFound</messageKey>
  <message>We could not find recordings.</message>
</response>

Fejlsvar

messageKey Beskrivelse
checksumError checksum er ugyldig. Kontrollér, at du bruger den korrekte shared secret, og at checksum-algoritmen matcher serverkonfigurationen.
missingParamRecordID Den påkrævede parameter recordID blev ikke angivet.
missingParamPublish Den påkrævede parameter publish blev ikke angivet.
notFound Der blev ikke fundet nogen optagelse, der matchede nogen af de angivne optagelses-ID'er.

Tips

Brug endpointet getRecordings til at hente den aktuelle publiceringstilstand for dine optagelser, før du ændrer deres synlighed. Feltet published i svaret angiver, om hver optagelse er synlig i øjeblikket.

  • En publiceret optagelse er tilgængelig via dens afspilnings-URL. En afpubliceret optagelse forbliver på serveren, men kan ikke tilgås af seere.
  • Denne handling er fuldt reversibel — optagelser kan publiceres og afpubliceres et ubegrænset antal gange.
  • Du kan batchbehandle flere optagelser ved at sende en kommasepareret liste over optagelses-ID'er i én enkelt forespørgsel.
  • Hvis du vil fjerne en optagelse permanent i stedet for blot at skjule den, skal du bruge endpointet deleteRecordings.

Når du sender flere optagelses-ID'er, og mindst ét af dem er gyldigt, vil kaldet returnere SUCCESS. Kun hvis ingen af de angivne ID'er matcher en eksisterende optagelse, vil serveren returnere FAILED med fejlen notFound.

Ofte stillede spørgsmål

At afpublicere en optagelse skjuler den for seere, men bevarer optagelsesfilerne på serveren. Du kan publicere den igen når som helst. Sletning af en optagelse fjerner filerne permanent fra serveren og kan ikke fortrydes.

Ja. Send en kommasepareret liste over optagelses-ID'er i parameteren recordID. Alle angivne optagelser sættes til samme publiceringstilstand i én enkelt request.

Hvis mindst ét af de angivne optagelses-ID'er er gyldigt, returnerer kaldet SUCCESS og anvender ændringen på alle gyldige optagelser. Serveren returnerer kun FAILED med notFound, hvis ingen af ID'erne matcher en eksisterende optagelse.

Brug endpointet getRecordings og inspicér feltet published i XML-svaret. Det sættes til true for publicerede optagelser og false for ikke-publicerede.

Afpublicering af en optagelse gør dens afspilnings-URL utilgængelig. Brugere, der i øjeblikket ser optagelsen, kan opleve en afbrydelse afhængigt af, hvordan afspilningsklienten håndterer ændringen.