Rozdział 12 GET POST

publishRecordings – Publikuj/Ukryj publikację

Punkt końcowy publishRecordings przełącza widoczność jednego lub większej liczby nagrań. Możesz opublikować nagrania, aby były dostępne przez ich URL odtwarzania, lub cofnąć publikację, aby ukryć je przed widzami, zachowując pliki na serwerze.

Punkt końcowy

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

Obsługiwane są zarówno metody GET, jak i POST. W przypadku użycia POST należy wysłać parametry jako application/x-www-form-urlencoded w treści żądania.

Parametry

Parametr Typ Opis
recordID String Wymagane. Lista identyfikatorów nagrań oddzielonych przecinkami do opublikowania lub wycofania publikacji. W jednym żądaniu możesz podać jeden lub więcej identyfikatorów.
publish Boolean Wymagane. Ustaw na true, aby opublikować nagrania (udostępnić je), lub na false, aby cofnąć ich publikację (ukryć je przed widzami).

Przykładowe żądanie

Opublikuj pojedyncze nagranie

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

Cofnij publikację wielu nagrań

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

Żądanie POST z użyciem 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"

Przykładowa odpowiedź

Sukces

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

Błąd — nie znaleziono nagrania

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

Odpowiedzi błędów

messageKey Opis
checksumError Parametr checksum jest nieprawidłowy. Sprawdź, czy używasz poprawnego współdzielonego sekretu oraz czy algorytm checksum odpowiada konfiguracji serwera.
missingParamRecordID Nie podano wymaganego parametru recordID.
missingParamPublish Nie podano wymaganego parametru publish.
notFound Nie znaleziono żadnego nagrania odpowiadającego któremukolwiek z podanych identyfikatorów nagrań.

Wskazówki

Użyj punktu końcowego getRecordings, aby sprawdzić bieżący stan publikacji swoich nagrań przed przełączeniem ich widoczności. Pole published w odpowiedzi wskazuje, czy każde nagranie jest obecnie widoczne.

  • Opublikowane nagranie jest dostępne pod adresem URL odtwarzania. Nieopublikowane nagranie pozostaje na serwerze.
  • To działanie jest w pełni odwracalne — nagrania można publikować i cofać ich publikację dowolną liczbę razy.
  • Możesz przetwarzać wiele nagrań wsadowo, przekazując w jednym żądaniu listę identyfikatorów nagrań oddzielonych przecinkami.
  • Jeśli chcesz trwale usunąć nagranie zamiast tylko je ukryć, użyj punktu końcowego deleteRecordings.

Różnica między BigBlueButton a bbbserver.de
Jeśli cofniesz publikację nagrania w bbbserver Integration-API, będzie ono oznaczone w API jako unpublished, a usługi zewnętrzne będą je odpowiednio przetwarzać. Samo nagranie nadal jednak można otworzyć, jeśli zna się link do jego odtwarzania.

Jeśli przekażesz wiele identyfikatorów nagrań i co najmniej jeden z nich jest prawidłowy, wywołanie zwróci SUCCESS. Tylko wtedy, gdy żaden z podanych identyfikatorów nie odpowiada istniejącemu nagraniu, serwer zwróci FAILED z błędem notFound.

Najczęściej zadawane pytania

Cofnięcie publikacji nagrania ukrywa je przed widzami, ale zachowuje pliki nagrania na serwerze. Możesz opublikować je ponownie w dowolnym momencie. Usunięcie nagrania trwale usuwa pliki z serwera i nie można tego cofnąć.

Tak. Przekaż rozdzieloną przecinkami listę identyfikatorów nagrań w parametrze recordID. Wszystkie wskazane nagrania zostaną ustawione na ten sam stan publikacji w jednym żądaniu.

Jeśli co najmniej jeden z podanych identyfikatorów nagrania jest prawidłowy, wywołanie zwraca SUCCESS i stosuje zmianę do wszystkich prawidłowych nagrań. Serwer zwraca FAILED z notFound tylko wtedy, gdy żaden z identyfikatorów nie odpowiada istniejącemu nagraniu.

Użyj punktu końcowego getRecordings i sprawdź pole published w odpowiedzi XML. Dla opublikowanych nagrań będzie ono ustawione na true, a dla nieopublikowanych na false.