Skip to main content

Add a HotMark

A HotMark is a metadata "bookmark" that you can add to annotate an active recording.

HotMarks can also be added to completed recordings using the HMP Web Interface. Viewers can then select the HotMarks to jump directly to specific points of interest in the recording.

This command adds a HotMark to an active recording now (i.e., at the recording’s current timestamp). 

Note

HMP rounds the "now" timestamp down to the nearest second.

Authorizations: All

Request

addHotmark recordingId title

Parameters

NameDescription

recordingId

The ID of a HMP recording.

title

The title to assign to HotMark.

Result

Success

OK

Error

ErrorDescription
ERROR|010003|Expected 2 parameters.
Got Y parameter(s)

 Calling addHotmark requires 2 parameters.

ERROR|010001|'Y' is not a UUID

 The recordingId provided must be a UUID.

ERROR|040002|Recording not found

A recording with UUID 'recordingId' was not found.

ERROR|060004|Hotmark already exists at this time

A HotMark at the specified timestamp already exists.

ERROR|010004|'Y' is not an active recording

Returned if the recording is no longer active. Y is the recordingId.

ERROR|070011|Could not locate recording

 An internal error occurred while adding HotMark. Please see calypso.log for details.

Example

addHotmark f678f415-0665-48cd-b141-1e95283469f1 PhaseI
OK

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.