Weave Code
Code Weaver
Helps Laravel developers discover, compare, and choose open-source packages. See popularity, security, maintainers, and scores at a glance to make better decisions.
Feedback
Share your thoughts, report bugs, or suggest improvements.
Subject
Message
Log in Register
Home
Packages
Bigbluebutton Api Php
Release Notes

Bigbluebutton Api Php Laravel Package

littleredbutton/bigbluebutton-api-php

PHP client for the BigBlueButton API. Create and manage meetings, join URLs, recordings, and server calls from your Laravel or PHP app with a simple, typed wrapper around BBB endpoints and responses.

View on GitHub
Deep Wiki
Context7
6.2.2

Added

Depreacted

New Contributors

Full Changelog: https://github.com/littleredbutton/bigbluebutton-api-php/compare/6.2.1...6.2.2

6.2.1

Fixed

Full Changelog: https://github.com/littleredbutton/bigbluebutton-api-php/compare/6.2.0...6.2.1

6.2.0

Added

Full Changelog: https://github.com/littleredbutton/bigbluebutton-api-php/compare/6.1.0...6.2.0

6.1.0

Added

Changed

Full Changelog: https://github.com/littleredbutton/bigbluebutton-api-php/compare/6.0.0...6.1.0

6.0.0

Changed

Breaking

  • The methods setClientUrl()/getClientUrl() from BigBlueButton\Parameters\JoinMeetingParameters have been removed
  • All enum-styled classes with constants have been converted to native PHP enums
  • All enum were moved the BigBlueButton\Enum namespace
  • This library now requires at lease PHP 8.1
  • Support for using a user or moderator password on getting meeting information or joining a meeting has been removed since BigBlueButton itself deprecated it. Use roles instead.
  • Support for Symfony 3.x and 4.x dependencies have been dropped due to both versions being End of life. Symfony 7.x have been added.
  • Code have been refactored using rectorphp/rector. All properties and methods are now fully typed. This may breaks your code when you extended classes.
  • The code bases now uses declare(strict_types=1);, this may breaks, when you passed wrong types to previously not fully typed methods
  • Some method parameters does not accept string anymore, you must use the respective enum explicitly
  • The constructor parameter $hasingAlgorithm of BigBlueButton\BigBlueButton now takes a BigBlueButton\Enum\HashingAlgorithm enum instead of a string
  • The $hooksListParameters parameter to BigBlueButton\BigBlueButton::getHooksListUrl() and BigBlueButton\BigBlueButton::getHooksListUrl() is now mandatory, passing null is no longer supported
  • The BigBlueButton\Core\ApiMethod class has been removed, use the BigBlueButton\Enum\ApiMethod enum instead
  • The BigBlueButton\Core\GuestPolicy class has been removed, use the BigBlueButton\Enum\GuestPolicy enum instead
  • The BigBlueButton\Core\MeetingLayout class has been removed, use the BigBlueButton\Enum\MeetingLayout enum instead
  • The getPlayback*() methods from BigBlueButton\Core\Record has been removed since their only returned information of the first record. Pick the correct record from getPlaybackFormats() instead
  • The abstract class BigBlueButton\Enum\Enum has been removed
  • The setConfigToken() and getConfigToken() method from BigBlueButton\Parameters\JoinMeetingParameters have been removed
  • The BigBlueButton\Responses\DeleteRecordingsResponse::isInvalidId() method has been removed, use BigBlueButton\Responses\DeleteRecordingsResponse::isNotFound() instead

Deprecated

  • Configuring the BigBlueButton\BigBlueButton object using the BBB_SECURITY_SALT/BBB_SECRET and BBB_SERVER_BASE_URL has been deprecated for security and type-safety reasons and will be removed in 7.0. Configure the object using constructor parameters instead.

Full Changelog: https://github.com/littleredbutton/bigbluebutton-api-php/compare/5.4.0...6.0.0

5.4.0

This last release of the 5.x line includes many deprecations for the upcoming 6.0 release and a few new features. 6.0 will be released in the near future with same feature set as this release except for the deprecated features.

Added

  • hooksList() and getHooksListUrl() BigBlueButton\BigBlueButton
  • getParentMeetingID() in BigBlueButton\Core\Meeting (used for Breakout rooms)
  • setAllowPromoteGuestToModerator() and getAllowPromoteGuestToModerator() in BigBlueButton\Parameters\CreateMeetingParameters
  • isMissingHook() and isHookError() in BigBlueButton\Responses\HooksDestroyResponse
  • isNotFound() in BigBlueButton\Responses\PublishRecordingsResponse
  • isNoRecordings(), isInvalidLang() and isInvalidKind() in BigBlueButton\Responses\PutRecordingTextTrackResponse
  • isNotFound() in BigBlueButton\Responses\UpdateRecordingsResponse

Deprecated

  • Constructing BigBlueButton/BigBlueButton without host and secret as arguments (Using BBB_SECURITY_SALT or BBB_SECRET environment variables is deprecated for security reasons)
  • Namespace of ApiMethod (BigBlueButton\Core -> BigBlueButton\Enum)
  • Namespace of GuestPolicy (BigBlueButton\Core -> BigBlueButton\Enum)
  • Namespace of MeetingLayout (BigBlueButton\Core -> BigBlueButton\Enum)
  • BigBlueButton\Enum\Feature::IMPORT_PRESENTATION_WITHANNOTATIONS_FROM_BREAKOUTROOMS (use BigBlueButton\Enum\Feature::IMPORT_PRESENTATION_WITH_ANNOTATIONS_FROM_BREAKOUT_ROOMS instead)
  • BigBlueButton\Enum\Feature::IMPORT_SHARED_NOTES_FROM_BREAKOUTROOMS (use BigBlueButton\Enum\Feature::IMPORT_SHARED_NOTES_FROM_BREAKOUT_ROOMS instead)
  • getters and setters for lockSettingsDisableNote, learningDashboardEnabled, virtualBackgroundsDisabled and breakoutRoomsEnabled in BigBlueButton\Parameters\CreateMeetingParameters (use disabledFeatures instead)
  • Old flash client setting clientURL in BigBlueButton\Parameters\JoinMeetingParameters
  • BigBlueButton\Parameters\JoinMeetingParameters::MODERATOR (use BigBlueButton\Enum\Role::MODERATOR instead)
  • BigBlueButton\Parameters\JoinMeetingParameters::VIEWER (use BigBlueButton\Enum\Role::VIEWER instead)
  • BigBlueButton\Responses\DeleteRecordingsResponse::KEY_INVALID_ID (use BigBlueButton\Responses\DeleteRecordingsResponse::KEY_NOT_FOUND instead)
  • isInvalidId() in BigBlueButton\Responses\DeleteRecordingsResponse (use isNotFound() instead)

Full Changelog: https://github.com/littleredbutton/bigbluebutton-api-php/compare/5.3.0...5.4.0

5.3.0

This second 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: https://github.com/littleredbutton/bigbluebutton-api-php/compare/5.2.0...5.3.0

5.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: https://github.com/littleredbutton/bigbluebutton-api-php/compare/5.1.0...5.2.0

5.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.

5.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](https://github.com/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](https://github.com/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.
4.3.0

Added

  • add insertDocument endpoint

Fixed

  • sync upstream

Changed

  • deprecate joinViaHtml5
  • update php-cs-fixer, change to symfony rule set
4.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)
4.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
4.0.1

Fixed

  • JoinMeetingParameters: Fixed typo in magic method annotation
4.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()
3.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)
3.2.0

Added

  • add ALWAYS_ACCEPT_AUTH guest policy, see readme for more details

Fixed

  • send guest param only if true
  • fix deprecated expectedException in tests
3.1.0

Added

  • add isbreakout to meeting info ($meeting->isBreakout())
  • add option to return creation time also as unix timestamp in seconds ($createMeetingResponse->getCreationTime(true))
3.0.0

Added

  • add config to constructor
  • get participant count from record
  • test code style on Travis
  • add support for php 7.4
  • add connection check
  • add guestPolicy to control access to meeting
  • add guest parameter to join
  • get recording text tracks

Fixed

  • fix test setup
  • fix create hooks params
  • fix attendee without customdata
  • fix php doc

Changed

  • require base url
  • split tests into unit and integration tests
  • bump min php version to 7.2
  • include composer.lock
Weaver

How can I help you explore Laravel packages today?

Conversation history is not saved when not logged in.
Prompt
Add packages to context
No packages found.
besmartand-pro/php-quality-config
sentix/ai-chatbot
terminal42/code-quality-tools
codifyo/ts-generator-bundle
testo/fiber
mintobit/jobqueue
a4sex/maintenance-bundle
a4sex/entity-date-update
a4sex/client-identifier
a4sex/base-utilites
a4sex/key-value-storage
a4sex/micro-status
chilldev/dependency-injection-extra
datinglibre/datinglibre-app-api
biberltd/corebundle
bricre/symfony-bundle-test
biberltd/logbundle
dominium/http-adapter-bundle
dominium/google-analytics
a4sex/auto-clean-entity