Recording classes via the API

This describes how LearnCube records classes for customers using the LearnCube Virtual Classroom API.

Alexander Asher avatar
Written by Alexander Asher
Updated over a week ago

LearnCube's recording via API feature allows you to record a class automatically (for safeguarding purposes).

You will need to contact LearnCube Customer Support to enable the recording feature for your API account. You can find the recording documentation for our embeddable widget (recommended) here.

User Experience | Recording a Class

Automatic recording

The recording can be enabled programmatically by your company's developer by setting the "record_class" parameter to "true" when creating a class via the Classroom API. This way all of the classes will be automatically recorded.

Important: LearnCube will start recording the class whenever the teacher enters the class for the first time, even if it's happening before the class start time.

Manual recording

If the classes have not been flagged for automatic recording, teachers can still manually start recording for the class they are giving - after entering the classroom and clicking on the round red dot on the top-right of the classroom screen.

If the teacher turns on recording during the class, it will require a change to the class and a popup will open asking you to click on Continue. The student will get a similar notice.

The video boxes in the class will reload and the recording will start.

While recording, teachers and students will see a pulsing red dot on the top-left, in the video panel. To switch off the recording, the teacher will click on the round red dot described up above again.

To complete the recording the teacher has to press the "End class" button.

Please let teachers know the importance of ending the class. Firstly, it will trigger the recording to start processing and leaving the class open and recording, even accidentally, could result in unnecessary costs for the organisation.

Classes are recorded to the cloud storage.

Accessing Video Recordings via API

API customers will be able to access recordings via a unique URL. Videos are stored for a maximum of 30 days.

When the recording page is opened, the viewer can click on the play button in the video-playing toolbar that appears at the bottom of the page. Once the user clicks on the play button, video compiling will start.

Note: LearnCube will take time to compile the recording and make it available to view. Often it takes the same time to process as the duration of the class, i.e. if the class is 30 minutes long, it can take 30 minutes after the class is ended in order to process and save the recording to the cloud.

Did this answer your question?