BigBlueButton API for PHP v5.3.0

This last release of the 5.x line just including some cleanup in preparation for 6.0. 6.0 will be released in the near future with same feature set as this release except for the deprecated features.

Deprecated

• Deprecate password in CreateMeetingResponse

Full Changelog: 5.2.0...5.3.0

BigBlueButton API for PHP v5.2.0

Added

• CreateMeetingParameters
  • preUploadedPresentation and preUploadedPresentationName
• Feature Enum (used in CreateMeetingParameters)
  • CAMERA_AS_CONTENT
  • SNAPSHOT_OF_CURRENT_SLIDE
  • DOWNLOAD_PRESENTATION_ORIGINAL_FILE
  • DOWNLOAD_PRESENTATION_CONVERTED_TO_PDF
  • TIMER

Changed

• Feature Enum (used in CreateMeetingParameters)
  • Renamed IMPORT_PRESENTATION_WITHANNOTATIONS_FROM_BREAKOUTROOMS to IMPORT_PRESENTATION_WITH_ANNOTATIONS_FROM_BREAKOUT_ROOMS (old const deprecated)
• Renamed IMPORT_SHARED_NOTES_FROM_BREAKOUTROOMS to IMPORT_SHARED_NOTES_FROM_BREAKOUT_ROOMS (old const deprecated)
• Removed marc-mabe/php-enum

Fixed

• Path error in pslam-clear composer script
• Missing docs in CreateMeetingParameters
  • isNotifyRecordingIsOn and setNotifyRecordingIsOn
  • isRemindRecordingIsOn and setRemindRecordingIsOn
  • isRecordFullDurationMedia and setRecordFullDurationMedia
  • isLockSettingsHideViewersCursor and setLockSettingsHideViewersCursor
  • getMeetingExpireIfNoUserJoinedInMinutes and setMeetingExpireIfNoUserJoinedInMinutes
  • getMeetingExpireWhenLastUserLeftInMinutes and setMeetingExpireWhenLastUserLeftInMinutes
  • getMeetingCameraCap and setMeetingCameraCap
  • isPreUploadedPresentationOverrideDefault and setPreUploadedPresentationOverrideDefault
  • getPresentationUploadExternalUrl and setPresentationUploadExternalUrl
  • getPresentationUploadExternalDescription and setPresentationUploadExternalDescription

Deprecated

• Feature Enum (used in CreateMeetingParameters)

  • IMPORT_PRESENTATION_WITHANNOTATIONS_FROM_BREAKOUTROOMS (use IMPORT_PRESENTATION_WITH_ANNOTATIONS_FROM_BREAKOUT_ROOMS instead)
  • IMPORT_SHARED_NOTES_FROM_BREAKOUTROOMS (use IMPORT_SHARED_NOTES_FROM_BREAKOUT_ROOMS instead)

Full Changelog: 5.1.0...5.2.0

BigBlueButton API for PHP v5.1.0

Added

• Set checksum algorithm via the forth constructor parameter (default SHA-1)
• CreateMeetingParameters
  • BreakoutRoomsGroups
  • disabledFeatures and disabledFeaturesExclude
  • lockSettingsHideViewersCursor
  • meetingCameraCap
  • meetingExpireIfNoUserJoinedInMinutes
  • meetingExpireWhenLastUserLeftInMinutes
  • preUploadedPresentationOverrideDefault
  • notifyRecordingIsOn
  • remindRecordingIsOn
  • recordFullDurationMedia
  • presentationUploadExternalUrl
  • presentationUploadExternalDescription
• JoinMeetingParameters
  • errorRedirectUrl

Changed

• CreateMeetingParameters
  • Renamed setLockSettingsDisableNote to setLockSettingsDisableNotes (setLockSettingsDisableNote deprecated)
• JoinMeetingParameters
  • Pass role instead of password in constructor
• Updated PHPUnit to version 9

Fixed

• Fix functional tests
• Fix CI not running for experimental versions

Deprecated

• CreateMeetingParameters
  • configToken (old flash client parameter)
  • setLockSettingsDisableNote (use setLockSettingsDisableNotes instead)
  • getAttendeePW / setAttendeePW and getModeratorPW / setModeratorPW (use roles instead)
  • setLockSettingsDisableNote and isLockSettingsDisableNote (use disabledFeatures instead)
  • setLearningDashboardEnabled and isLearningDashboardEnabled (use disabledFeatures instead)
  • setVirtualBackgroundsDisabled and isVirtualBackgroundsDisabled (use disabledFeatures instead)
  • setBreakoutRoomsEnabled and isBreakoutRoomsEnabled (use disabledFeatures instead)
• JoinMeetingParameters
  • Password parameter in constructor (use roles instead)
• EndMeetingParameters
  • Password parameter in constructor (not needed anymore)
• Meeting
  • getAttendeePassword and getModeratorPassword (use roles instead)

Special thanks to @SamuelWei, who contributed the major portion to this release.

BigBlueButton API for PHP v5.0.0

Added

• Added native PHP return types for all methods in the codebase. Please adjust your own code when extending classes from the library.

Changed

• Minimum required PHP version is now 7.4.
• Classes marked as @final in previous versions are now final, except for BigBlueButton\BigBlueButton. You can no longer extend them.

Deprecated

• Please stop extending BigBlueButton\BigBlueButton in your own code, it might become final in version 6.0.

Removed

• The getPlaybackType(), getPlaybackUrl() and getPlaybackLength() methods of BigBlueButton\Core\Record have been removed, please use getPlaybackFormats() instead.
• The old getters and setters from BigBlueButton\Parameters\* classes have been removed, please use the new magic getters and setters instead. You can find the name of the replacing method in the @deprecated annotation in the source code of version 4.3 before the upgrade.
• The isJoinViaHtml5() and setJoinViaHtml5() methods from BigBlueButton\Parameters\JoinMeetingParameters have been removed without replacement, because the parameter has been removed from the BigBlueButton API and has no effect anymore.

BigBlueButton API for PHP v4.3.0

Added

• add insertDocument endpoint

Fixed

• sync upstream

Changed

• deprecate joinViaHtml5
• update php-cs-fixer, change to symfony rule set

BigBlueButton API for PHP v4.2.0

Added

• Support for new parameters introduced in BBB 2.4.3:
  • CreateMeeting: AllowRequestsWithoutSession and VirtualBackgroundsDisabled
• Support for parameters introduced a long time ago, but were missing:
  • CreateMeeting: BreakoutRoomsEnabled, BreakoutRoomsPrivateChatEnabled and BreakoutRoomsRecord
• Getter for ApiVersion and BbbVersion to ApiVersionResponse class

Fixed

• Expose all playback formats of a record (getPlaybackFormats()) instead of only the first one

Changed

• Transport Interface can now be overwritten for extending the BigBlueButton class (private -> protected)

BigBlueButton API for PHP v4.1.0

Added

• add parameter typing
• add support for new parameters introduced in BBB 2.4
  • CreateMeeting: meetingLayout, learningDashboardEnabled, learningDashboardCleanupDelayInMinutes, allowModsToEjectCameras
  • JoinMeeting: role, excludeFromDashboard

Changed

• remove deprecated support for config XML

BigBlueButton API for PHP v4.0.1

Fixed

• JoinMeetingParameters: Fixed typo in magic method annotation

BigBlueButton API for PHP v4.0.0

Added

• add support for putRecordingTextTrackAnchor
• add composer scripts for cs-fixer
• add new breakout parameters for create meetings call
• add meetingKeepEvents, endWhenNoModerator and endWhenNoModeratorDelayInMinutes parameters to create meetings call
• we use psalm to fix code errors now
• add helper functions and constants for message keys. For example CreateMeetingResponse::KEY_DUPLICATE_WARNING and $createMeetingResponse->isDuplicate()
• add CURLOPT_TIMEOUT to prevent processes being stuck after connecting to server
• support for multiple transports (curl, psr, symfony, custom)

Changed

• BREAKING only options which are set are used. In the versions below every parameter had a default value.
• move to Github actions
• GetMeetingInfoParameters does not need moderator pw in constructor

Fixed

• license in composer file
• authentication of config XML
• getMeetings scalelite error
• remove getMessageKey check

Deprecated

• Getting and setting XML configuration was only supported by the flash client which was removed in BBB 2.2. Therefore this API endpoint was removed completely from BBB 2.3.
• we adapted parameter naming to the official API. Therefore the following methods are deprecated and will be removed in one of the next releases:

CreateMeetingParameter:
getMeetingName() --> getName()
setMeetingName() --> setName()
getMeetingId() --> getMeetingID()
setMeetingId() --> setMeetingID()
getAttendeePassword() --> getAttendeePW()
setAttendeePassword() --> setAttendeePW()
getModeratorPassword() --> getModeratorPW()
setModeratorPassword() --> setModeratorPW()
getWelcomeMessage() --> getWelcome()
setWelcomeMessage() --> setWelcome()
getLogoutUrl() --> getLogoutURL()
setLogoutUrl() --> setLogoutURL()
isRecorded() --> isRecord()
getParentMeetingId() --> getParentMeetingID()
setParentMeetingId() --> setParentMeetingID()

DeleteRecordingsParameters:
getRecordingId() --> getRecordID()
setRecordingId() --> setRecordID()

EndMeetingParameters:
getMeetingId() --> getMeetingID()
setMeetingId() --> setMeetingID()

GetMeetingInfoParameters:
getMeetingId() --> getMeetingID()
setMeetingId() --> setMeetingID()

GetRecordingsParameters:
getMeetingId() --> getMeetingID()
setMeetingId() --> setMeetingID()
getRecordId() --> getRecordID()
setRecordId() --> setRecordID()

GetRecordingTextTracksParameters:
getRecordId() --> getRecordID()
setRecordId() --> setRecordID()

HooksCreateParameters:
getCallbackUrl() --> getCallbackURL()
setCallbackUrl() --> setCallbackURL()
getMeetingId() --> getMeetingID()
setMeetingId() --> setMeetingID()
getRaw() --> isGetRaw()

HooksDestroyParameters:
getHookId() --> getHookID()
setHookId() --> setHookID()

IsMeetingRunningParameters:
getMeetingId() --> getMeetingID()
setMeetingId() --> setMeetingID()

JoinMeetingParameters:
getMeetingId() --> getMeetingID()
setMeetingId() --> setMeetingID()
getCreationTime() --> getCreateTime()
setCreationTime() --> setCreateTime()
getUsername() --> getFullName()
setUsername() --> setFullName()
getUserId() --> getUserID()
setUserId() --> setUserID()

PublishRecordingsParameters:
getRecordId() --> getRecordID()
setRecordId() --> setRecordID()

SetConfigXMLParameters:
getMeetingId() --> getMeetingID()
setMeetingId() --> setMeetingID()

UpdateRecordingsParameters:
getRecordId() --> getRecordID()
setRecordId() --> setRecordID()

BigBlueButton API for PHP v3.3.0

Added

• add banner options (text and color) to create meeting parameters
• throw custom exceptions (network, parsing, runtime, config) to distinguish errors easier
• throw network exception if response is unsuccessful (status code != 2xx)