- Add text track API.

- Delete Travis config.
- Code updates.

Author: GhaziTriki

.travis.yml

@@ -27,12 +27,14 @@
 use BigBlueButton\Parameters\EndMeetingParameters;
 use BigBlueButton\Parameters\GetMeetingInfoParameters;
 use BigBlueButton\Parameters\GetRecordingsParameters;
+use BigBlueButton\Parameters\GetRecordingTextTracksParameters;
 use BigBlueButton\Parameters\HooksCreateParameters;
 use BigBlueButton\Parameters\HooksDestroyParameters;
 use BigBlueButton\Parameters\InsertDocumentParameters;
 use BigBlueButton\Parameters\IsMeetingRunningParameters;
 use BigBlueButton\Parameters\JoinMeetingParameters;
 use BigBlueButton\Parameters\PublishRecordingsParameters;
+use BigBlueButton\Parameters\PutRecordingTextTrackParameters;
 use BigBlueButton\Parameters\UpdateRecordingsParameters;
 use BigBlueButton\Responses\ApiVersionResponse;
 use BigBlueButton\Responses\CreateMeetingResponse;
@@ -41,12 +43,15 @@
 use BigBlueButton\Responses\GetMeetingInfoResponse;
 use BigBlueButton\Responses\GetMeetingsResponse;
 use BigBlueButton\Responses\GetRecordingsResponse;
+use BigBlueButton\Responses\GetRecordingTextTracksResponseResponse;
 use BigBlueButton\Responses\HooksCreateResponse;
 use BigBlueButton\Responses\HooksDestroyResponse;
 use BigBlueButton\Responses\HooksListResponse;
+use BigBlueButton\Responses\InsertDocumentResponse;
 use BigBlueButton\Responses\IsMeetingRunningResponse;
 use BigBlueButton\Responses\JoinMeetingResponse;
 use BigBlueButton\Responses\PublishRecordingsResponse;
+use BigBlueButton\Responses\PutRecordingTextTrackResponse;
 use BigBlueButton\Responses\UpdateRecordingsResponse;
 use BigBlueButton\Util\UrlBuilder;
 
@@ -183,7 +188,7 @@ public function getInsertDocumentUrl($createMeetingParams)
     }
 
     /**
-     * @param InsertDocumentParameters $insertDocumentParams
+     * @param $insertDocumentParams InsertDocumentParameters
      *
      * @return InsertDocumentResponse
      *
@@ -260,8 +265,6 @@ public function getMeetingInfoUrl($meetingParams)
     /**
      * @param $meetingParams GetMeetingInfoParameters
      *
-     * @return GetMeetingInfoResponse
-     *
      * @throws \RuntimeException
      */
     public function getMeetingInfo($meetingParams)
@@ -291,8 +294,6 @@ public function getRecordingsUrl($recordingsParams)
     /**
      * @param mixed $recordingParams
      *
-     * @return GetRecordingsResponse
-     *
      * @throws \RuntimeException
      */
     public function getRecordings($recordingParams)
@@ -315,8 +316,6 @@ public function getPublishRecordingsUrl($recordingParams)
     /**
      * @param $recordingParams PublishRecordingsParameters
      *
-     * @return PublishRecordingsResponse
-     *
      * @throws \RuntimeException
      */
     public function publishRecordings($recordingParams)
@@ -363,8 +362,6 @@ public function getUpdateRecordingsUrl($recordingParams)
     /**
      * @param $recordingParams UpdateRecordingsParameters
      *
-     * @return UpdateRecordingsResponse
-     *
      * @throws \RuntimeException
      */
     public function updateRecordings($recordingParams)
@@ -374,6 +371,50 @@ public function updateRecordings($recordingParams)
         return new UpdateRecordingsResponse($xml);
     }
 
+    /**
+     * @param $getRecordingTextTracksParameters GetRecordingTextTracksParameters
+     *
+     * @return string
+     */
+    public function getRecordingTextTracksUrl($getRecordingTextTracksParameters)
+    {
+        return $this->urlBuilder->buildUrl(ApiMethod::GET_RECORDING_TEXT_TRACKS, $getRecordingTextTracksParameters->getHTTPQuery());
+    }
+
+    /**
+     * @param $getRecordingTextTracksParams GetRecordingTextTracksParameters
+     *
+     * @return GetRecordingTextTracksResponseResponse
+     */
+    public function getRecordingTextTracks($getRecordingTextTracksParams)
+    {
+        $json = $this->processJsonResponse($this->getRecordingTextTracksUrl($getRecordingTextTracksParams));
+
+        return new GetRecordingTextTracksResponseResponse($json);
+    }
+
+    /**
+     * @param $putRecordingTextTrackParams PutRecordingTextTrackParameters
+     *
+     * @return string
+     */
+    public function getPutRecordingTextTrackUrl(PutRecordingTextTrackParameters $putRecordingTextTrackParams)
+    {
+        return $this->urlBuilder->buildUrl(ApiMethod::PUT_RECORDING_TEXT_TRACK, $putRecordingTextTrackParams->getHTTPQuery());
+    }
+
+    /**
+     * @param $putRecordingTextTrackParams PutRecordingTextTrackParameters
+     *
+     * @return PutRecordingTextTrackResponse
+     */
+    public function putRecordingTextTrack($putRecordingTextTrackParams)
+    {
+        $json = $this->processJsonResponse($this->getPutRecordingTextTrackUrl($putRecordingTextTrackParams));
+
+        return new PutRecordingTextTrackResponse($json);
+    }
+
     // ____________________ WEB HOOKS METHODS ___________________
 
     /**
@@ -494,17 +535,17 @@ public function buildUrl($method = '', $params = '', $append = true)
     // ____________________ INTERNAL CLASS METHODS ___________________
 
     /**
-     * A private utility method used by other public methods to process XML responses.
+     * A private utility method used by other public methods to request HTTP responses.
      *
      * @param string $url
      * @param string $payload
      * @param string $contentType
      *
-     * @return \SimpleXMLElement
+     * @return string
      *
      * @throws \RuntimeException
      */
-    private function processXmlResponse($url, $payload = '', $contentType = 'application/xml')
+    private function sendRequest($url, $payload = '', $contentType = 'application/xml')
     {
         if (extension_loaded('curl')) {
             $ch = curl_init();
@@ -554,9 +595,31 @@ private function processXmlResponse($url, $payload = '', $contentType = 'applica
                 $this->setJSessionId($output_array['JSESSIONID']);
             }
 
-            return new \SimpleXMLElement($data);
+            return $data;
         }
 
         throw new \RuntimeException('Post XML data set but curl PHP module is not installed or not enabled.');
     }
+
+    /**
+     * A private utility method used by other public methods to process XML responses.
+     *
+     * @param string $url
+     * @param string $payload
+     * @param string $contentType
+     *
+     * @return \SimpleXMLElement
+     */
+    private function processXmlResponse($url, $payload = '', $contentType = 'application/xml')
+    {
+        return new \SimpleXMLElement($this->sendRequest($url, $payload, $contentType));
+    }
+
+    /**
+     * A private utility method used by other public methods to process json responses.
+     */
+    private function processJsonResponse(string $url, string $payload = '', string $contentType = 'application/json')
+    {
+        return $this->sendRequest($url, $payload, $contentType);
+    }
 }

src/BigBlueButton.php

@@ -20,22 +20,24 @@
 
 namespace BigBlueButton\Core;
 
-abstract class ApiMethod
+final class ApiMethod
 {
-    public const CREATE             = 'create';
-    public const JOIN               = 'join';
-    public const INSERT_DOCUMENT    = 'insertDocument';
-    public const ENTER              = 'enter';
-    public const END                = 'end';
-    public const IS_MEETING_RUNNING = 'isMeetingRunning';
-    public const GET_MEETING_INFO   = 'getMeetingInfo';
-    public const GET_MEETINGS       = 'getMeetings';
-    public const SIGN_OUT           = 'signOut';
-    public const GET_RECORDINGS     = 'getRecordings';
-    public const PUBLISH_RECORDINGS = 'publishRecordings';
-    public const DELETE_RECORDINGS  = 'deleteRecordings';
-    public const UPDATE_RECORDINGS  = 'updateRecordings';
-    public const HOOKS_CREATE       = 'hooks/create';
-    public const HOOKS_LIST         = 'hooks/list';
-    public const HOOKS_DESTROY      = 'hooks/destroy';
+    public const CREATE                    = 'create';
+    public const JOIN                      = 'join';
+    public const INSERT_DOCUMENT           = 'insertDocument';
+    public const ENTER                     = 'enter';
+    public const END                       = 'end';
+    public const IS_MEETING_RUNNING        = 'isMeetingRunning';
+    public const GET_MEETING_INFO          = 'getMeetingInfo';
+    public const GET_MEETINGS              = 'getMeetings';
+    public const SIGN_OUT                  = 'signOut';
+    public const GET_RECORDINGS            = 'getRecordings';
+    public const PUBLISH_RECORDINGS        = 'publishRecordings';
+    public const DELETE_RECORDINGS         = 'deleteRecordings';
+    public const UPDATE_RECORDINGS         = 'updateRecordings';
+    public const GET_RECORDING_TEXT_TRACKS = 'getRecordingTextTracks';
+    public const PUT_RECORDING_TEXT_TRACK  = 'putRecordingTextTrack';
+    public const HOOKS_CREATE              = 'hooks/create';
+    public const HOOKS_LIST                = 'hooks/list';
+    public const HOOKS_DESTROY             = 'hooks/destroy';
 }

src/Core/ApiMethod.php

@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2023 BigBlueButton Inc. and by respective authors (see below).
+ *
+ * This program is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation; either version 3.0 of the License, or (at your option) any later
+ * version.
+ *
+ * BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along
+ * with BigBlueButton; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace BigBlueButton\Core;
+
+/**
+ * Class Track.
+ */
+class Track
+{
+    /**
+     * @var string
+     */
+    private $href;
+
+    /**
+     * @var string
+     */
+    private $kind;
+
+    /**
+     * @var string
+     */
+    private $label;
+
+    /**
+     * @var string
+     */
+    private $lang;
+
+    /**
+     * @var string
+     */
+    private $source;
+
+    public function __construct($track)
+    {
+        $this->href   = $track->href;
+        $this->kind   = $track->kind;
+        $this->label  = $track->label;
+        $this->lang   = $track->lang;
+        $this->source = $track->source;
+    }
+
+    public function getHref()
+    {
+        return $this->href;
+    }
+
+    public function getKind()
+    {
+        return $this->kind;
+    }
+
+    public function getLabel()
+    {
+        return $this->label;
+    }
+
+    public function getLang()
+    {
+        return $this->lang;
+    }
+
+    public function getSource()
+    {
+        return $this->source;
+    }
+}

src/Core/Track.php

@@ -22,9 +22,11 @@
 
 use MabeEnum\Enum;
 
+// @ref : https://github.com/bigbluebutton/bigbluebutton/blob/5189abb225247290d1954e10827853d5fc022b66/bbb-common-web/src/main/java/org/bigbluebutton/api/domain/GuestPolicy.java
 class GuestPolicy extends Enum
 {
-    public const ALWAYS_ACCEPT = 'ALWAYS_ACCEPT';
-    public const ALWAYS_DENY   = 'ALWAYS_DENY';
-    public const ASK_MODERATOR = 'ASK_MODERATOR';
+    public const ALWAYS_ACCEPT      = 'ALWAYS_ACCEPT';
+    public const ALWAYS_DENY        = 'ALWAYS_DENY';
+    public const ASK_MODERATOR      = 'ASK_MODERATOR';
+    public const ALWAYS_ACCEPT_AUTH = 'ALWAYS_ACCEPT_AUTH';
 }