Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 403]
(no description)
| File Size: | 380 lines (13 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
recording_proxy:: (15 methods):
invalidate_cache_for_recording()
delete_recording()
publish_recording()
protect_recording()
update_recording()
fetch_recording()
purge_protected_recording()
fetch_recordings()
fetch_recording_by_meeting_id()
do_fetch_recordings()
fetch_recordings_page()
sort_recordings()
parse_recording()
parse_recording_meta()
parse_preview_images()
Class: recording_proxy - X-Ref
The recording proxy.This class acts as a proxy between Moodle and the BigBlueButton API server,
and deals with all requests relating to recordings.
| invalidate_cache_for_recording(string $recordid) X-Ref |
| Invalidate the MUC cache for the specified recording. param: string $recordid |
| delete_recording(string $recordid) X-Ref |
| Perform deleteRecordings on BBB. param: string $recordid a recording id return: bool |
| publish_recording(string $recordid, string $publish = 'true') X-Ref |
| Perform publishRecordings on BBB. param: string $recordid param: string $publish return: bool |
| protect_recording(string $recordid, string $protected = 'true') X-Ref |
| Perform publishRecordings on BBB. param: string $recordid param: string $protected return: bool |
| update_recording(string $recordid, array $params) X-Ref |
| Perform updateRecordings on BBB. param: string $recordid a single record identifier param: array $params ['key'=>param_key, 'value'] |
| fetch_recording(string $recordingid) X-Ref |
| Helper function to fetch a single recording from a BigBlueButton server. param: string $recordingid return: null|array |
| purge_protected_recording(string $recordingid) X-Ref |
| Check whether the current recording is a protected recording and purge the cache if necessary. param: string $recordingid |
| fetch_recordings(array $keyids = []) X-Ref |
| Helper function to fetch recordings from a BigBlueButton server. We use a cache to store recording indexed by keyids/recordingID. param: array $keyids list of recordingids return: array (associative) with recordings indexed by recordID, each recording is a non sequential array |
| fetch_recording_by_meeting_id(array $keyids = []) X-Ref |
| Helper function to fetch recordings from a BigBlueButton server. param: array $keyids list of meetingids return: array (associative) with recordings indexed by recordID, each recording is a non sequential array |
| do_fetch_recordings(array $keyids = [], string $key = 'recordID') X-Ref |
| Helper function to fetch recordings from a BigBlueButton server. param: array $keyids list of meetingids or recordingids param: string $key the param name used for the BBB request (<recordID>|meetingID) return: array (associative) with recordings indexed by recordID, each recording is a non sequential array. |
| fetch_recordings_page(array $ids, $key = 'recordID') X-Ref |
| Helper function to fetch a page of recordings from the remote server. param: array $ids param: string $key return: array |
| sort_recordings(array $recordings) X-Ref |
| Helper function to sort an array of recordings. It compares the startTime in two recording objects. param: array $recordings return: array |
| parse_recording(SimpleXMLElement $recording) X-Ref |
| Helper function to parse an xml recording object and produce an array in the format used by the plugin. param: SimpleXMLElement $recording return: array |
| parse_recording_meta(array $metadata) X-Ref |
| Helper function to convert an xml recording metadata object to an array in the format used by the plugin. param: array $metadata return: array |
| parse_preview_images(SimpleXMLElement $preview) X-Ref |
| Helper function to convert an xml recording preview images to an array in the format used by the plugin. param: SimpleXMLElement $preview return: array |
