Data Models
Recorder
RecorderConfig Class
| Property | Type | Optional | Description |
|---|---|---|---|
type | { audio?: boolean, video?: boolean, screen?: boolean } | No | Types of media to be recorded |
recorderOptions | MediaRecorderOptions | Yes | Options for the media recorder |
RecordedData Class
| Property | Type | Optional | Description |
|---|---|---|---|
id | string | No | Annotation ID of recorder annotation. |
tag | string | No | Recorder player tag containing recorder annotation id which can be added anywhere on the DOM. |
type | string | No | Type of recorded data. Possible values are ‘audio’, ‘video’, and ‘screen’. |
thumbnailUrl | string | Yes | URL of the thumbnail image for the recorded data. |
thumbnailWithPlayIconUrl | string | Yes | URL of the thumbnail image with a play icon overlay. |
videoUrl | string | Yes | URL of the recorded video. |
audioUrl | string | Yes | URL of the recorded audio. |
videoPlayerUrl | string | Yes | URL of the hosted website to open video in a new tab. |
getThumbnailTag | function | No | A method that returns an HTML string for displaying the thumbnail with a link to the video player. |
getThumbnailTag Method
The getThumbnailTag method takes an optional url parameter and returns an HTML string. It creates an anchor tag linking to the videoPlayerUrl and embeds an image tag using either the provided url, thumbnailWithPlayIconUrl, or thumbnailUrl (in that order of preference).
Was this page helpful?