abiodunjames / bigbluebutton
Bigbluebutton wrapper for laravel 5
Installs: 119
Dependents: 0
Suggesters: 0
Security: 0
Stars: 17
Watchers: 5
Forks: 15
Open Issues: 2
Requires
- php: >=5.6.4
- bigbluebutton/bigbluebutton-api-php: dev-master
- laravel/framework: 5.3.*
README
This is a laravel wrapper for BigBlueButton API
Requirements
- Laravel 5.3 or above.
Installation
Require package in your composer.json and update composer. This downloads the package and the official bigbluebutton php library.
composer require abiodunjames/bigbluebutton
After updating composer, add the ServiceProvider to the providers array in config/app.php
Abiodunjames\Bigbluebutton\BigbluebuttonProviderService::class,
You can optionally use the facade for shorter code. Add this to your facades:
'Meeting' => Abiodunjames\Bigbluebutton\BigbluebuttonMeeting::class,
Usage
You can define Big blue button secret key and server url in two ways.
- Define in .env file
BBB_SECURITY_SALT =bbb_secret_key
BBB_SERVER_BASE_URL=https://example.com/bigbluebutton/
- Define in config/bigbluebutton.php
'BBB_SECURITY_SALT' => 'bbb_secret_key',
'BBB_SERVER_BASE_URL' => 'https://example.com/bigbluebutton/',
Via Dependency Injection in Controller
List all meetings
namespace App\Http\Controllers; class MeetingController extends Controller { /** * @var \Abiodunjames\Bigbluebutton\Contracts\Meeting */ protected $meeting; public function __construct(Meeting $meeting) { $this->meeting = $meeting; } /** * Returns a list of meetings */ public function all() { $meetings = $this->meeting->all(); if ($meetings) { // do something with meetings } }
Create meeting
use Abiodunjames\Bigbluebutton\Contracts\Meeting; use BigBlueButton\Parameters\CreateMeetingParameters; use Illuminate\Http\Request; class MeetingController extends Controller { /** * @var \Abiodunjames\Bigbluebutton\Contracts\Meeting */ protected $meeting; public function __construct(Meeting $meeting) { $this->meeting = $meeting; } /** * Create a bigbluebutton meeting * * @param \Illuminate\Http\Request $request * @return void */ public function create(Request $request) { $meetingParams = new CreateMeetingParameters($request->meetingId, $request->meetingName); $meetingParams->setDuration(40); $meetingParams->setModeratorPassword('supersecretpwd'); if ($this->meeting->create($meetingParams)) { // Meeting was created } }
Join a meeting
use Abiodunjames\Bigbluebutton\Contracts\Meeting; use BigBlueButton\Parameters\JoinMeetingParameters; use Illuminate\Http\Request; class MeetingController extends Controller { /** * @var \Abiodunjames\Bigbluebutton\Contracts\Meeting */ protected $meeting; public function __construct(Meeting $meeting) { $this->meeting = $meeting; } /** * Join a bigbluebutton meeting * * @param \Illuminate\Http\Request $request * @return void */ public function join(Request $request) { $meetingParams = new JoinMeetingParameters($request->meetingID, $request->meetingName, 'MyMeetingPassword'); $meetingParams->setRedirect(true); $meetingUrl = $this->meeting->join($meetingParams); redirect()->setTargetUrl($meetingUrl); } }
Close meeting
use Abiodunjames\Bigbluebutton\Contracts\Meeting; use BigBlueButton\Parameters\EndMeetingParameters; use Illuminate\Http\Request; class MeetingController extends Controller { /** * @var \Abiodunjames\Bigbluebutton\Contracts\Meeting */ protected $meeting; public function __construct(Meeting $meeting) { $this->meeting = $meeting; } /** * End a bigbuebutton meeting * * @param \Illuminate\Http\Request $request * @return void */ public function close(Request $request) { $meetingParams = new EndMeetingParameters($request->meetingID, $request->moderator_password); $this->meeting->close($meetingParams); } }
Via Laravel Facade
You can also manage meetings using the facade
Meeting::all(); //get a list of all meetings