Class: Marker

Marker(data)

Class representing a point in time in a GeneralRecording, with metadata that applies to the audio/video beginning at that point. The code is commented out for full Marker support, but we can add it in again whenever we want. The current use is just to mark the beginning of a GeneralRecording. Markers are displayed visually, and clicking one jumps to that point in the recording.

Constructor

new Marker(data)

Creates a Marker object
Parameters:
Name Type Description
data Marker | Object
Source:

Members

_id :string

Unique ID for the marker
Type:
  • string
Default Value:
  • ''
Source:

cultureEvent :string

ID of the CultureEvent that the GeneralRecording belongs to, that this Marker is in (see GeneralRecording.markers)
Type:
  • string
Default Value:
  • ''
Source:

note :string

Note that pertains to the part of the audio/video in the GeneralRecording that begins at startTime
Type:
  • string
Default Value:
  • ''
Source:

searchWords :Array.<string>

Array of IDs of search words that pertain to the part of the audio/video in the GeneralRecording that begins at startTime
Type:
  • Array.<string>
Default Value:
  • []
Source:

startTime :number

The time (in seconds with decimals) from the beginning of the GeneralRecording, where the marker is
Type:
  • number
Default Value:
  • 0
Source:

Methods

set(data) → {Marker}

Creates an updated Marker object
Parameters:
Name Type Description
data Marker | Object
Source:
Returns:
Type
Marker