Constructor
new (require("tiny_recordrtc/base_recorder"))(editor, modal)
Constructor for the RecordRTC class
Parameters:
| Name | Type | Description |
|---|---|---|
editor |
TinyMCE | The Editor to which the content will be inserted |
modal |
Modal | The Moodle Modal that contains the interface used for recording |
Methods
(static) checkSecure() → {boolean}
- Source:
- See:
Check whether the hostname is either hosted over SSL, or from a valid localhost hostname.
The UserMedia API can only be used in secure contexts as noted.
Returns:
Whether the plugin can be loaded.
- Type
- boolean
(static) getModalClass() → {Modal}
Fetch the Class of the Modal to be displayed.
Returns:
- Type
- Modal
(static) hasUserMedia() → {boolean}
Check whether the browser supports WebRTC.
Returns:
- Type
- boolean
(static) isBrowserCompatible() → {boolean}
Check whether the browser is compatible with capturing media.
Returns:
- Type
- boolean
(async) captureUserMedia()
Start capturing the User Media and handle success or failure of the capture.
checkAndWarnAboutBrowserCompatibility() → {boolean}
Check whether the browser is compatible with capturing media, and display a warning if not.
Returns:
- Type
- boolean
cleanupStream()
Clean up the stream.
This involves stopping any track which is still active.
clearButtonTimer()
Clear the timer for the stop recording button.
close()
Close the modal and stop recording.
configurePlayer() → {HTMLElement}
Get the Player element for this type.
Returns:
The player element, typically an audio or video tag.
- Type
- HTMLElement
getButtonContainer(purpose) → {HTMLElement}
Helper to get the container that a button is in.
Parameters:
| Name | Type | Description |
|---|---|---|
purpose |
string | The button purpose |
Returns:
- Type
- HTMLElement
getEmbedTemplateContext(templateContext) → {Object}
Add or modify the template parameters for the specified type.
Parameters:
| Name | Type | Description |
|---|---|---|
templateContext |
Object | The Tempalte context to use |
Returns:
The finalised template context
- Type
- Object
getEmbedTemplateName() → {string}
Get the name of the template used when embedding the URL in the editor content.
Returns:
- Type
- string
getFileName(prefix) → {string}
Get a filename for the generated file.
Typically this function will take a prefix and add a type-specific suffix such as the extension to it.
Parameters:
| Name | Type | Description |
|---|---|---|
prefix |
string | The prefix for the filename generated by the recorder. |
Returns:
- Type
- string
getMaxUploadSize() → {number}
Get the maximum file size that can be uploaded.
Returns:
The max byte size
- Type
- number
getMediaConstraints() → {Object}
- Source:
- See:
Get a list of constraints as required by the getUserMedia() function.
Returns:
- Type
- Object
getParsedRecordingOptions() → {object}
Get the options for the MediaRecorder.
Returns:
The options for the MediaRecorder instance.
- Type
- object
getRecordingOptions() → {Object}
- Source:
- See:
Get any recording options passed into the MediaRecorder. Please note that the mimeType will be fetched from getSupportedTypes().
Returns:
- Type
- Object
getSupportedTypes() → {Array.<string>}
- Source:
- See:
Get the list of supported mimetypes for this recorder.
Returns:
The list of supported mimetypes.
- Type
- Array.<string>
getTimeLimit() → {number}
Get the time limit for this recording type.
Returns:
The time limit in seconds.
- Type
- number
getTimeRemaining() → {Object}
Get the time remaining for the recording.
Returns:
The minutes and seconds remaining.
- Type
- Object
handleCaptureFailure(error)
Handle failure to capture the User Media.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
Error |
handleCaptureSuccess(stream)
Handle successful capture of the User Media.
Parameters:
| Name | Type | Description |
|---|---|---|
stream |
MediaStream | The stream as captured by the User Media. |
handleDataAvailable(event)
Handle the mediaRecorder dataavailable event.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event |
handleModalClick(event)
Handle a click within the Modal.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
MouseEvent | The click event |
handleRecordingStartStopRequested()
Handle the click event for the recording start/stop button.
handleStarted()
Handle the mediaRecorder start event.
This event is called when the recording starts.
handleStopped()
Handle the mediaRecorder stop event.
hasData() → {boolean}
Whether any data has been recorded.
Returns:
- Type
- boolean
(async) insertMedia(source)
Insert the HTML to embed the recording into the editor content.
Parameters:
| Name | Type | Description |
|---|---|---|
source |
string | The URL to view the media. |
isReady() → {boolean}
Check whether the browser is compatible.
Returns:
- Type
- boolean
isRecording() → {boolean}
Check whether the recording is in progress.
Returns:
- Type
- boolean
(async) onMediaStopped()
Handle the media stream after it has finished.
(async) outsideClickHandler(event)
Prevent the Modal from closing when recording is on process.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
MouseEvent | The click event |
playOnCapture() → {boolean}
Whether to start playing the recording as it is captured.
Returns:
Whether to start playing the recording as it is captured.
- Type
- boolean
prefetchContent()
Prefetch some of the content that will be used in the UI.
Note: not all of the strings used are pre-fetched. Some of the strings will be fetched because their template is used.
(async) recordAgainConfirmation() → {Promise.<boolean>}
Confirm whether the user wants to reset the existing recoring.
Returns:
Whether the user confirmed the reset.
- Type
- Promise.<boolean>
requestRecordingStop()
Stop the recording. Please note that this should only stop the recording. Anything related to processing the recording should be handled by the mediaRecorder's stopped event handler which is processed after it has stopped.
setRecordButtonState(enabled)
Enable the record button.
Parameters:
| Name | Type | Description |
|---|---|---|
enabled |
boolean | null | Set the button state |
(async) setRecordButtonTextFromString(string)
Set the text of the record button using a language string.
Parameters:
| Name | Type | Description |
|---|---|---|
string |
string | The string identifier |
setRecordButtonVisibility(visible)
Configure button visibility for the record button.
Parameters:
| Name | Type | Description |
|---|---|---|
visible |
boolean | Set the visibility of the button. |
(async) setStopRecordingButton()
Update the content of the stop recording button timer.
setUploadButtonState(enabled)
Enable the upload button.
Parameters:
| Name | Type | Description |
|---|---|---|
enabled |
boolean | null | Set the button state |
(async) setUploadButtonTextProgress(progress)
Set the upload button text progress.
Parameters:
| Name | Type | Description |
|---|---|---|
progress |
number | The progress |
setUploadButtonVisibility(visible)
Configure button visibility for the upload button.
Parameters:
| Name | Type | Description |
|---|---|---|
visible |
boolean | Set the visibility of the button. |
setupPlayerSource()
Setup the player to use the stream as a source.
(async) startRecording()
Start the recording
updateRecordButtonTime()
Update the time on the stop recording button.
(async) uploadRecording()
Upload the recording and insert it into the editor content.