Download the PHP package akibtanjim/virtual-classroom without Composer
On this page you can find all versions of the php package akibtanjim/virtual-classroom. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download akibtanjim/virtual-classroom
More information about akibtanjim/virtual-classroom
Files in akibtanjim/virtual-classroom
Package virtual-classroom
Short Description Laravel Virtual Classroom using Braincert Virtual Classroom API.
License MIT
Informations about the package virtual-classroom
Laravel Virtual Classroom API
This package is built for laravel with a view to provide virtual class room api for any website integration. This package uses BrainCert Virtual Classroom API. For more information please visit here.
Installation
Install using composer:
In Laravel 5.5 or higher, this package will be automatically discovered and you can safely skip the following two steps.
If using Laravel 5.4 or lower, after updating composer, add the ServiceProvider to the providers array in
In the providers section add the below line:
add the Alias to aliases section of config/app.php:
Usage
In order to facilitate virtual classroom features you need to have a BrainCert account. You can sign up from here.
This package need API KEY of BrainCert account. You can find your API KEY from here. Please put your domain name there. You can also add custom redirect url, your custom logo,favicon,host name etc from BrainCert Portal
After you get your API KEY open your file and paste the follwing code:
Available Methods
- Schedule A Class
- Launch A Class
- List Of Classes
- Remove A Class
- Cancel A Class
- Add Pricing Scheme
- List Of Pricing Scheme
- Remove Pricing Scheme
- Scheme Payment
- Add Discount
- List Of Discounts
- Remove Discount
- Apply Discount Coupon
- List Of Recordings
- Get Recording
- Remove Recording
- Change Recording Status
- Get Class Usage Report
- Get Available Attendees
Schedule A Class
This method allows to schedule a class.
ClassRoom::schedule($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | title | Yes | String | Class title | Demo Class | | timezone | Yes | Integer | Class timezone | 12
See Timezone List section for more information | | start_time | Yes | String | Start time of class | 09:30AM | | end_time | Yes | String | End time of class | 10:30AM | | date | Yes | Date | Date of class | 2020-08-15 | | currency | No | String | Currency of class | USD
See the Supported Currency List section for all available currencies | | is_paid | No | Boolean | For class is free or paid | 0 for free, 1 for paid | | is_recurring | No | Boolean | Class recurring | 0 for No and 1 for Yes | | repeat | No | Integer | When class repeats | Value between 1 to 6
See the Repeat List section for more details | | weekdays | No | Integer | Number for weekdays | Comma separated values between 1 to 7
See Weekdays List section for more details | | end_classes_count | No | Integer | Number of classes for recurring classes | 10 | | seat_attendees | No | Integer | Number of allowed attendees in a live class | 25 | | record | No | Integer | Record this class | 0 disable recording
1 enable recording. Instructor has to manually start/stop recording button.
2 start recording automatically when class starts.
3 start recording automatically when class starts and disable instructor from managing the recording button.
Recording will be produced at the end of class time. | | is_recording_layout | No | Integer | Recording Layout | 0 to use 'Standard layout' for recorded videos that captures minimalistic details
such as whiteboard, videos, and chat.
(API will assume '0' as default option if you don't pass this parameter).
1 to use 'Enhanced layout' for recorded videos that captures the entire browser tab including all virtual classroom icons and user interface. | | is_video | No | Integer | Video output | 0 Produces multiple recorded video files every time instructor clicks the stop recording button or refresh the browser when session is in progress (API will assume '0' as default option if you don't pass this parameter).
1 Concatenates all the recorded video files into a single video file at the end of the session. | | is_board | No | Integer | Allow loading only whiteboard or entire app with audio/video, and group chat. | 0 for whiteboard + audio/video + attendee list + chat (API will assume '0' as default option if you don't pass this parameter).
1 for whiteboard + attendee list.
2 for whiteboard + attendee list + chat. | | is_lang | No | Integer | Force Interface Language | 0 to allow changing interface language by attendees
- Value between 1 to 50
See Interface Language List Section for more details | | is_region | No | Integer | Datacenter region selection | See Data Center Region List section for more details | | is_corporate | No | Integer | Enable webcam and microphone upon entry | 0 to disable webcam and microphone upon entry. Classroom is moderated and instructor has to pass microphone and webcam controls to attendees (API will assume '0' as default option if you don't pass this parameter)
1 to allow attendees to enable their microphone and webcam without permission from instructor | | is_private_chat | No | Integer | Private chat | 0 to allow students to private chat with each other.
1 to enable only instructor to private chat with students and students cannot private chat with each other. | | | | | | | | | | | | | ### Sample Request ### Sample Response ### Error Response
Launch A Class
This method allows to launch a class which provides a launch url for the class.
ClassRoom::launchClass($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | class id | 10 | | user_id | Yes | Integer | User Id | 1 | | user_name | Yes | String | User Name | Jhon Doe | | is_teacher | Yes | Integer | Marks a user as a teacher or student | 0 for Student
1 for teacher | | lesson_name | Yes | String | Name of the lesson | Lesson-01 | | course_name | Yes | String | Name of the course | Class-01 | | is_extend | No | Integer | Allow teacher to extend the class timing | 0 for you can extend class.
1 for you cannot extend class timer and time is fixed. | ### Sample Request ### Sample Response ### Error Response
List Of Classes
This method allows to fetch all the classes.
ClassRoom::classList($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | published | No | Integer | List published classes only | 1 for list published classes
0 default to list all classes | | start | No | Integer | Start limit of list class | default value is 0 | | limit | No | Integer | Limit of list class | default value is 10 | | search | No | String | Class title | Demo | ### Sample Request ### Sample Response ### Error Response
Remove A Class
This method allows to remove a class.
ClassRoom::removeClass($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | class id | 10 ### Sample Request ### Sample Response ### Error Response
Cancel A Class
This method allows to cancel or activate class/recurring class.
ClassRoom::cancelClass($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | class id | 10 | | is_cancel | Yes | Integer | Allows to cancel current/recurring classes or activate a class | 0 Activate canceled class.
1 Cancel one-time or current class in the recurring schedule.
2 Cancel all classes in the recurring schedule. | ### Sample Request ### Sample Response ### Error Response
Add Pricing Scheme
This method allows to add a pricing scheme to a class.
ClassRoom::addScheme($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | class id | 10 | | price | Yes | Numeric | Price of class | 10 | | no_of_day | Yes | Integer | Days to give access for | 30 | | access_type | Yes | Integer | Access type for limit | 0 for unlimited
1 for limited | | no_of_max_use | No | Integer | Number of Times price used in class | 12 | ### Sample Request ### Sample Response ### Error Response
List Of Pricing Scheme
This method allows to fetch all the pricing scheme of a class.
ClassRoom::schemeList($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | class id | 10 | ### Sample Request ### Sample Response ### Error Response
Remove Pricing Scheme
This method allows to remove pricing scheme of a class.
ClassRoom::removeScheme($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | price_id | Yes | Integer | Price Id | 10 | ### Sample Request ### Sample Response ### Error Response
Scheme Payment
This method allows to make payment of a class scheme.
ClassRoom::payment($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | Class id | 10 | | price_id | Yes | Integer | Price id | 10 | | card_number | Yes | String | Card number | 4242 4242 4242 4242 | | card_exp_month | Yes | String | Card expire month | 01 | | card_exp_year | Yes | String | Card expire year | 2017 | | card_cvc | Yes | String | Card cvc | 141 | | student_email | Yes | Email | Student Email address | [email protected] | | cancel_url | Yes | Base64 | Please enter base64 encode url | base64_encode('YOUR_CANCEL_URL') | | return_url | Yes | Base64 | Please enter base64 encode url | base64_encode('YOUR_RETURN_URL') | | coupon_code | No | String | Please enter class coupon code | abcd | ### Sample Request ### Sample Response ### Error Response
Add Discount
This method allows to add discount to a class.
ClassRoom::addDiscount($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | Class id | 10 | | discount | Yes | Integer | Discount of class | 10 | | start_date | Yes | Date | To Give Access for days of class | 2020-06-15 | | end_date | No | Date | Discount expires | 2020-07-15 | | discount_type | Yes | Integer | Discount type in class | 0 for fixed_amount
1 for percentage | | discount_code | No | String | Discount coupon code | abcd | | discount_limit | No | Integer | How many times can this discount be used? | 10 | ### Sample Request ### Sample Response ### Error Response
List Of Discounts
This method allows to fetch discounts of a class.
ClassRoom::discountList($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | Class id | 10 | | search | No | String | Class title | Demo | | ### Sample Request ### Sample Response ### Error Response
Remove Discount
This method allows to remove discount from a class.
ClassRoom::removeDiscount($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | discount_id | Yes | Integer | Discount id | 10 | | ### Sample Request ### Sample Response ### Error Response
Apply Discount Coupon
This method allows to apply discount to a class.
ClassRoom::applyCoupon($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | Class id | 10 | | discount_code | Yes | String | Class discount code | abcd | | ### Sample Request ### Sample Response ### Error Response
List Of Recordings
This method allows to fetch all the recordings of a class.
ClassRoom::recordingList($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | Class id | 10 | | search | No | String | Class title | demo | | ### Sample Request ### Sample Response ### Error Response
Get Recording
This method allows to fetch a specific recording of a class.
ClassRoom::getRecording($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | record_id | Yes | Integer | Record id | 10 | ### Sample Request ### Sample Response ### Error Response
Remove Recording
This method allows to romove a specific recording of a class.
ClassRoom::removeRecording($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | record_id | Yes | Integer | Record id | 10 | ### Sample Request ### Sample Response ### Error Response
Change Recording Status
This method allows to change status of a recording of a class.
ClassRoom::changeRecordingStatus($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | record_id | Yes | Integer | Record id | 10 | ### Sample Request ### Sample Response ### Error Response
Get Class Usage Report
This method is used to get the total duration and total productivity percentage of attendees. If you pass a specific userId, it will return user specific data
ClassRoom::changeRecordingStatus($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | class id | 10 | | user_id | No | Integer | User Id | 1 | | is_teacher | No | Integer | Marks a user as a teacher or student | 0 for Student
1 for teacher | ### Sample Request ### Sample Response ### Error Response
Get Available Attendees
This method is used to display the list of available seats when a live class is launched. This is very useful to assign new attendees to a live class by querying the attendee count.
ClassRoom::getAttendees($request)
| Parameter | Required | Data Type | Description | Example | |- |- |- |- |- | | class_id | Yes | Integer | class id | 10 | ### Sample Request ### Sample Response ### Error Response
Timezone List
See Full List
Supported Currency List
See Full List
Repeat List
See Full List
Weekdays List
See Full List
Interface Language List
See Full List
Data Center Region List
See Full List
Authors
- Akib Tanjim - akibtanjim
- Alveee - Alveee
- Lutfullahil Kabir Ashik - LutfullahilKabirAshik