Difference between revisions of "BigBlueButton"
Laily Ajellu (talk | contribs) (→HTML5 Client and React) |
m (→CDOT BigBlueButton Contributors) |
||
(23 intermediate revisions by 3 users not shown) | |||
Line 9: | Line 9: | ||
===Who Develops BigBlueButton?=== | ===Who Develops BigBlueButton?=== | ||
− | BigBlueButton was started in 2007 by Richard Alam, who at the time was a Master's student at Carleton University. Since then, many other individuals and organizations have become involved. The core team of developers come from [http://blindsidenetworks.com/ Blindside Networks] | + | BigBlueButton was started in 2007 by Richard Alam, who at the time was a Master's student at Carleton University. Since then, many other individuals and organizations have become involved. The core team of developers come from [http://blindsidenetworks.com/ Blindside Networks] and [http://cdot.senecacollege.ca/ Seneca CDOT]. |
===What Features Does BigBlueButton Have?=== | ===What Features Does BigBlueButton Have?=== | ||
Line 43: | Line 43: | ||
===Server-side=== | ===Server-side=== | ||
− | See [ | + | See [http://docs.bigbluebutton.org/ this] for a recent overview of BigBlueButton's server-side architecture. Behind the scenes, the BigBlueButton server uses the following technologies: |
*[http://www.red5.org/ Red5]: a Flash Media Server, with "room management" (a Red5 room corresponds to a BigBlueButton meeting) allowing easy handling of message sending and streaming to only those users who connected to a specific room. Red5 holds the following BigBlueButton components: | *[http://www.red5.org/ Red5]: a Flash Media Server, with "room management" (a Red5 room corresponds to a BigBlueButton meeting) allowing easy handling of message sending and streaming to only those users who connected to a specific room. Red5 holds the following BigBlueButton components: | ||
Line 65: | Line 65: | ||
===For New Developers: Getting started on BBB=== | ===For New Developers: Getting started on BBB=== | ||
− | + | If you would like to start voluteering or working for CDOT, please read these step by step instructions for setting up your environment, as well as a tutorial for how to create a react component within BigBlueButton: [https://docs.google.com/document/d/1_ujOMX1AvODRsEkg54GFrknNKL4Ld78jCSpd9gUHImk/edit?usp=sharing Starting at BBB] | |
+ | |||
+ | To read the documentation about BigBlueButton written for Employees of Blindside Networks, visit this link: [http://docs.bigbluebutton.org/ BlindSide Networks BBB documentation] | ||
First, you will likely want to subscribe to the following BigBlueButton mailing-lists: | First, you will likely want to subscribe to the following BigBlueButton mailing-lists: | ||
Line 81: | Line 83: | ||
After that, the resources you will need will depend on which parts of BigBlueButton you want to develop. | After that, the resources you will need will depend on which parts of BigBlueButton you want to develop. | ||
− | For the steps on setting up a BigBlueButton version 0 | + | For the steps on setting up a BigBlueButton version 1.0 development environment for the server, and for the Flash client, see http://docs.bigbluebutton.org/install/setup.html. |
− | For the steps on setting up a development environment for the HTML5 client, see: | + | For the steps on setting up a development environment for the HTML5 client, see http://docs.bigbluebutton.org/html/html5-dev.html |
− | For the steps on setting up a development environment for the mobile client, see: | + | For the steps on setting up a development environment for the mobile client, see http://docs.bigbluebutton.org/dev/client-configuration.html#phone-module |
As of September 2014, the most important component of BigBlueButton that has yet to be implemented is the video module for the HTML5 client. This is because there is no suitable WebRTC live video streaming server that BigBlueButton can use. The way the Flash client does this, is by capturing webcam media, encoding it in H.264, and streaming it to BigBlueButton-Video using the RTMP protocol. BigBlueButton-video is Flash based, and can handle the re-streaming of this video stream to the other Flash clients. The HTML5 client does not use Flash, but instead uses WebRTC to capture and stream media. The philosophy of WebRTC is to use completely open and non-proprietary codecs and protocols, and both the RTMP protocol, and the H.264 video codec are proprietary. The most widely used WebRTC video codec is VP8. What BigBlueButton needs is something that can re-stream this video stream to all HTML5 clients, and something that can transcode between VP8 and H.264 so that the different clients (HTML5 and Flash based) can share video between them. | As of September 2014, the most important component of BigBlueButton that has yet to be implemented is the video module for the HTML5 client. This is because there is no suitable WebRTC live video streaming server that BigBlueButton can use. The way the Flash client does this, is by capturing webcam media, encoding it in H.264, and streaming it to BigBlueButton-Video using the RTMP protocol. BigBlueButton-video is Flash based, and can handle the re-streaming of this video stream to the other Flash clients. The HTML5 client does not use Flash, but instead uses WebRTC to capture and stream media. The philosophy of WebRTC is to use completely open and non-proprietary codecs and protocols, and both the RTMP protocol, and the H.264 video codec are proprietary. The most widely used WebRTC video codec is VP8. What BigBlueButton needs is something that can re-stream this video stream to all HTML5 clients, and something that can transcode between VP8 and H.264 so that the different clients (HTML5 and Flash based) can share video between them. | ||
Line 98: | Line 100: | ||
In the summer of 2016, Danny Perrone, Matthew Marangoni, Laily Ajellu, Oleksandr Zhurbenko, and Jaeeun Cho, students from Seneca, along with with Anton Georgiev, a co-op student from Carleton university working at Blindside Networks in Ottawa, rewrote the existing HTML5 client, moving it over to the [https://www.meteor.com/ Meteor.js] framework. | In the summer of 2016, Danny Perrone, Matthew Marangoni, Laily Ajellu, Oleksandr Zhurbenko, and Jaeeun Cho, students from Seneca, along with with Anton Georgiev, a co-op student from Carleton university working at Blindside Networks in Ottawa, rewrote the existing HTML5 client, moving it over to the [https://www.meteor.com/ Meteor.js] framework. | ||
− | |||
− | |||
− | |||
=====HTML5 Client and React===== | =====HTML5 Client and React===== | ||
Line 111: | Line 110: | ||
Find the official docs for React here: https://facebook.github.io/react/ | Find the official docs for React here: https://facebook.github.io/react/ | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===Completed/Inactive Projects=== | ===Completed/Inactive Projects=== | ||
Line 158: | Line 123: | ||
=====Accessibility===== | =====Accessibility===== | ||
− | '' <span | + | <span>One of the requirements of the BigBlueButton project is for it to be accessible to all users without limitation, which encompasses both direct access (native to the application) and indirect access (compatible with assistive technologies) methods. Accessibility has already been fully implemented in the Flash client and is in development in the HTML5 client. The main accessibility features that were implemented include screen reader support, keyboard navigation, and localization. Since a large portion of the users of this application are students, the content and interface of the application is required to be equally functional for individuals with physical impairments and disabilities. All accessibility features have been implemented in compliance with the [https://www.w3.org/TR/wai-aria-1.1/ ARIA (Accessible Rich Internet Applciations) standards] and [https://www.w3.org/TR/WCAG20/ WCAG (Web Content Accessibility Guidelines)]. |
+ | |||
+ | In regards to screen reader implementation, all text within the application and anything that the user can interact with (including buttons, menu's, and more) have a description which is interpreted by the screen reader and read out to the user to give meaning to the things they cannot see. Keyboard navigation and keyboard shortcuts have also been implemented to assist users with vision impairment so that they can still navigate through the entire application without having to see it on a screen. | ||
+ | |||
+ | For international students or users of the application whose first language is not english, localization has been implemented to support the user's native language, with a wide variety of languages to choose from. These language localizations are constantly being improved and updated by the community as the application develops further.</span> | ||
+ | |||
+ | =====Creating the Mobile Client===== | ||
+ | |||
+ | The BigBlueButton mobile client is a mobile application that allows users to participate in a BigBlueButton meeting from their smartphone or tablet. It was started in late 2013 by a team of software developers from [http://mconf.org/ Mconf]. Beginning in early 2014, the mobile project was taken over by a team of developers at Seneca CDOT. | ||
+ | |||
===CDOT BigBlueButton Contributors=== | ===CDOT BigBlueButton Contributors=== | ||
− | [[File: | + | [[File:Bbbteam2016Fall.jpg|thumb|right|400px|From left to right: Kert, Oleksandr, Fardad, Laily, Chad, Jaeeun, Danny, Matthew]] |
====Current==== | ====Current==== | ||
Line 170: | Line 144: | ||
*[http://zenit.senecac.on.ca/wiki/index.php/User:Danny_Perrone Danny Perrone] - Developer | *[http://zenit.senecac.on.ca/wiki/index.php/User:Danny_Perrone Danny Perrone] - Developer | ||
*[http://zenit.senecac.on.ca/wiki/index.php/User:Oleksandr_Zhurbenko Oleksandr Zhurbenko] - Developer | *[http://zenit.senecac.on.ca/wiki/index.php/User:Oleksandr_Zhurbenko Oleksandr Zhurbenko] - Developer | ||
− | *[http://zenit.senecac.on.ca/wiki/index.php/User: | + | *[http://zenit.senecac.on.ca/wiki/index.php/User:Laily_Ajellu Laily Ajellu] - Developer |
+ | *[https://wiki.cdot.senecacollege.ca/wiki/User:Mmarangoni Matthew Marangoni] - Developer | ||
+ | *[https://wiki.cdot.senecacollege.ca/wiki/User:Jaeeun.cho Jaeeun Cho] - Developer | ||
+ | *[http://zenit.senecac.on.ca/wiki/index.php/User:KBrowne Kert Browne] - Developer | ||
====Previous==== | ====Previous==== | ||
Line 182: | Line 159: | ||
*[http://zenit.senecac.on.ca/wiki/index.php/User:Dkarp Dale Karp] - Developer | *[http://zenit.senecac.on.ca/wiki/index.php/User:Dkarp Dale Karp] - Developer | ||
*[http://zenit.senecac.on.ca/wiki/index.php/User:Bo_Li Bo Li] - Developer | *[http://zenit.senecac.on.ca/wiki/index.php/User:Bo_Li Bo Li] - Developer | ||
+ | *[http://zenit.senecac.on.ca/wiki/index.php/User:Maxim_Khlobystov Maxim Khlobystov] - Developer | ||
==Resources== | ==Resources== | ||
+ | *[http://docs.bigbluebutton.org/ The Official BigBlueButton documentation] | ||
*[http://zenit.senecac.on.ca/wiki/index.php/BigBlueButtonOldLinks Old links] | *[http://zenit.senecac.on.ca/wiki/index.php/BigBlueButtonOldLinks Old links] | ||
− |
Latest revision as of 11:35, 2 November 2016
***Page is currently under construction***
Contents
BigBlueButton Overview
What is BigBlueButton?
BigBlueButton is a free and open source web conferencing system, primarily targeted towards online lecturing by providing a virtual classroom environment, and tools for small group collaboration. However, BigBlueButton is by no means limited to classroom settings and small groups; it just means that the core features and components of BigBlueButton were developed with this target demographic in mind. The BigBlueButton name comes from the notion that starting a web conference should be as simple as pressing a metaphorical big blue button.
Who Develops BigBlueButton?
BigBlueButton was started in 2007 by Richard Alam, who at the time was a Master's student at Carleton University. Since then, many other individuals and organizations have become involved. The core team of developers come from Blindside Networks and Seneca CDOT.
What Features Does BigBlueButton Have?
BigBlueButton contains a set of components, called "modules", each containing a bunch of features. Such modules and features include:
- The users module, that contains and displays the list of users in a meeting, along with their state (whether they are a presenter, moderator or normal viewer, whether they are sharing any media, whether their permissions are restricted in some way, etc..).
- The video module, where people in a meeting can share their webcam to be viewed by everyone else in the meeting.
- The audio module, that allows people in a meetings to share their microphone and speak to everyone else in the meeting.
- The desktop sharing module, that allows the presenter in a meeting to have other users in a meeting view what they are doing on their screen.
- The chat module, that allows users to broadcast chat messages to everybody in the meeting (public chat), or to send chat messages only to a specific user (private chat).
- The presentation module, that allows the presenter of a meeting to upload documents (a PowerPoint presentation or PDF, for example) to be viewed by everyone else in the meeting.
- The whiteboard module, that gives the presenter the ability to manipulate a canvass overlaid on top of the presentation window, allowing them to write, draw shapes, and insert text onto the virtual whiteboard.
- The polling module, which allows a presenter to query participants, letting them vote on questions asked, and to view the results.
- Lock Settings, which allow moderators of a meeting to restrict some users' access of the modules. For example, a moderator can disable webcam sharing, or chatting between participants.
Try out BigBlueButton for yourself at http://demo.bigbluebutton.org/! Just enter any user name in, and play around with it!
BigBlueButton Architecture
Background Information
BigBlueButton was initially a Flash application. The server, written in Java (now moving to Scala), sat on a Flash media server called Red5, and the main client was a Flash web application (the "Flash client") that was downloaded by the browser upon joining a BigBlueButton meeting. As a Flash application, this meant that users had to install a Flash Player into their web browser in order for them to use it (like old YouTube videos). Though the main BigBlueButton client is still Flash based, all of the new features that HTML5 requires browsers to be able to support natively (without having to install plug-ins) allowed developers to begin work on a second client for BigBlueButton, that used only the built-in capabilities of web browsers (the "HTML5 client"). Additionally, around late 2013, development began on a cross-platform mobile application for Android and iOS that allowed people to join a BigBlueButton meeting from mobile devices (the "mobile client"). Both the HTML5 client and the mobile client are still under development.
Server-side
See this for a recent overview of BigBlueButton's server-side architecture. Behind the scenes, the BigBlueButton server uses the following technologies:
- Red5: a Flash Media Server, with "room management" (a Red5 room corresponds to a BigBlueButton meeting) allowing easy handling of message sending and streaming to only those users who connected to a specific room. Red5 holds the following BigBlueButton components:
- BigBlueButton-Apps: this IS BigBlueButton :) It holds the master state of all meetings on that server
- BigBlueButton-Video: the video application, which sends webcam streams from one user to all the others connected to that meeting and using Flash video.
- BigBlueButton-Voice: the audio application, which sends audio streams from one user to all the others connected to that meeting and using Flash audio. In order to send the audio data to clients using WebRTC audio (the HTML5 client, and now Flash clients have the option of using WebRTC audio if their web browser supports it), BBB-Voice connects each Flash client using Flash audio to FreeSwitch (see below), and sends the audio data to FreeSwitch which transcodes the audio data to a format that clients using WebRTC can use.
- BigBlueButton-Desktop: the desktop sharing application.
- BigBlueButton-Web running on Grails and Tomcat: BigBlueButton's web API, allowing programmers to create meetings, join meetings, get configurations for a meeting, get information to set the state of the client when joining a meeting, to use the presentation services for uploading presentations, and to use the recording services to record meetings.
- Redis: a key-value store used by BigBlueButton to communicate between the different server-side components, and to record all of the events of a meeting. Redis provides a publish and subscribe ("pub-sub") messaging system, that allows applications to subscribe to channels, which means every message published to that channel will be received by all subscribers of that channel. Try this interactive Redis tutorial!
- FreeSwitch: used by BigBlueButton as a VOIP server to manage voice conference calls between WebRTC audio clients, connecting them and streaming their audio data to others in the same conference. Additionally, since Flash Audio and WebRTC audio use different audio codecs (Speex vs Opus), FreeSwitch is used to transcode between these two codecs, and send the audio data to BBB-Voice for repackaging and delivery to those Flash clients that are using Flash audio (Flash clients needn't use Flash audio, but can now use WebRTC audio).
- Meteor.js on Node.js: Node.js is JavaScript environment which is not a web browser. This is the server to which HTML5 clients connect. It communicates with Red5 through Redis.
- Nginx (pronounced "engine-x"): used as a reverse proxy, to forward HTTP requests to other applications on a BigBlueButton server, depending on the structure of the URL.
BigBlueButton Development
For New Developers: Getting started on BBB
If you would like to start voluteering or working for CDOT, please read these step by step instructions for setting up your environment, as well as a tutorial for how to create a react component within BigBlueButton: Starting at BBB
To read the documentation about BigBlueButton written for Employees of Blindside Networks, visit this link: BlindSide Networks BBB documentation
First, you will likely want to subscribe to the following BigBlueButton mailing-lists:
- http://groups.google.com/group/bigbluebutton-dev
- http://groups.google.com/group/bigbluebutton-setup
- http://groups.google.com/group/bigbluebutton-users
Next, since all of the source code for BigBlueButton is hosted on GitHub, you should try to gain a rudimentary understanding of how to use Git. Nothing too fancy, but at the very least, you should know how to clone repositories, create and navigate local branches, add files to the staging area, commit staged files, pull changes from remote repositories, push your changes to remote repositories, and submit pull requests. If you get stuck, or get some weird error message, usually you can Google the message and read forum posts or Stack Overflow answers, as other people have likely encountered the exact same issue before. Some good Git resources include:
- A free online book - The first three chapters should be sufficient
- A cute interactive tutorial
- A blog post from Chad Pilkey, on the usual git work flow used by BigBlueButton developers
After that, the resources you will need will depend on which parts of BigBlueButton you want to develop.
For the steps on setting up a BigBlueButton version 1.0 development environment for the server, and for the Flash client, see http://docs.bigbluebutton.org/install/setup.html.
For the steps on setting up a development environment for the HTML5 client, see http://docs.bigbluebutton.org/html/html5-dev.html
For the steps on setting up a development environment for the mobile client, see http://docs.bigbluebutton.org/dev/client-configuration.html#phone-module
As of September 2014, the most important component of BigBlueButton that has yet to be implemented is the video module for the HTML5 client. This is because there is no suitable WebRTC live video streaming server that BigBlueButton can use. The way the Flash client does this, is by capturing webcam media, encoding it in H.264, and streaming it to BigBlueButton-Video using the RTMP protocol. BigBlueButton-video is Flash based, and can handle the re-streaming of this video stream to the other Flash clients. The HTML5 client does not use Flash, but instead uses WebRTC to capture and stream media. The philosophy of WebRTC is to use completely open and non-proprietary codecs and protocols, and both the RTMP protocol, and the H.264 video codec are proprietary. The most widely used WebRTC video codec is VP8. What BigBlueButton needs is something that can re-stream this video stream to all HTML5 clients, and something that can transcode between VP8 and H.264 so that the different clients (HTML5 and Flash based) can share video between them.
BigBlueButton at Seneca CDOT
Current Projects
HTML5 Client
With mobile devices dropping Flash support, and HTML5 rising to replace Flash on the web, we are looking into adapting BigBlueButton to an HTML5 and JavaScript application. The first step in this is to develop an HTML5 client that can participate in an existing meeting (where the presenter is using the Flash client) at the most basic level. As of autumn 2014, the only core component missing is the video module. This is because, as of yet, there is no suitable WebRTC based video streaming media server (see above for more details).
In the summer of 2016, Danny Perrone, Matthew Marangoni, Laily Ajellu, Oleksandr Zhurbenko, and Jaeeun Cho, students from Seneca, along with with Anton Georgiev, a co-op student from Carleton university working at Blindside Networks in Ottawa, rewrote the existing HTML5 client, moving it over to the Meteor.js framework.
HTML5 Client and React
React is an MVC framework for Javacsript that seamlessly and quickly updates your web app as soon as a change is made to it.
How? It "diffs the return value from the previous call to render with the new one, and generates a minimal set of changes to be applied to the DOM".
Read here to find out more about React's features: https://facebook.github.io/react/blog/2013/06/05/why-react.html
Find the official docs for React here: https://facebook.github.io/react/
Completed/Inactive Projects
Polling Module
***WRITE STUFF HERE!!!***
Seneca's BigBlueButton Server
***WRITE STUFF HERE!!!***
Accessibility
One of the requirements of the BigBlueButton project is for it to be accessible to all users without limitation, which encompasses both direct access (native to the application) and indirect access (compatible with assistive technologies) methods. Accessibility has already been fully implemented in the Flash client and is in development in the HTML5 client. The main accessibility features that were implemented include screen reader support, keyboard navigation, and localization. Since a large portion of the users of this application are students, the content and interface of the application is required to be equally functional for individuals with physical impairments and disabilities. All accessibility features have been implemented in compliance with the ARIA (Accessible Rich Internet Applciations) standards and WCAG (Web Content Accessibility Guidelines).
In regards to screen reader implementation, all text within the application and anything that the user can interact with (including buttons, menu's, and more) have a description which is interpreted by the screen reader and read out to the user to give meaning to the things they cannot see. Keyboard navigation and keyboard shortcuts have also been implemented to assist users with vision impairment so that they can still navigate through the entire application without having to see it on a screen.
For international students or users of the application whose first language is not english, localization has been implemented to support the user's native language, with a wide variety of languages to choose from. These language localizations are constantly being improved and updated by the community as the application develops further.
Creating the Mobile Client
The BigBlueButton mobile client is a mobile application that allows users to participate in a BigBlueButton meeting from their smartphone or tablet. It was started in late 2013 by a team of software developers from Mconf. Beginning in early 2014, the mobile project was taken over by a team of developers at Seneca CDOT.
CDOT BigBlueButton Contributors
Current
- Fardad Soleimanloo - Project Supervisor
- Chad Pilkey - Developer
- Danny Perrone - Developer
- Oleksandr Zhurbenko - Developer
- Laily Ajellu - Developer
- Matthew Marangoni - Developer
- Jaeeun Cho - Developer
- Kert Browne - Developer
Previous
- Gary (Xinggui) Deng - Developer
- Stanislav Yeshchenko - Developer
- Adam Sharpe - Developer
- Anatoly Spektor - Developer
- Justin Robinson - Developer
- Robert Stanica - Developer
- Ystallonne Alves - Developer
- Dale Karp - Developer
- Bo Li - Developer
- Maxim Khlobystov - Developer