Class: GeneralPhoto

GeneralPhoto(data)

Class representing a photo taken as part of a General Recorder session. The GeneralRecording that the photo is attached to will have the GeneralPhoto's _id in its photos array. For convenience, the id of the CultureEvent that the GeneralRecording is associated with is included in the GeneralPhoto, so we don't have to trace back through the GeneralRecording to get to the CultureEvent.

Constructor

new GeneralPhoto(data)

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

Members

_id :string

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

cultureEvent :string

ID of the culture event that this photo is associated with, for convenience
Type:
  • string
Default Value:
  • ''
Source:

filename :string

Filename of photo (no path, but does include extension)
Type:
  • string
Default Value:
  • ''
Source:

startTime :number

Time (in seconds with decimals) from the beginning of the GeneralRecording, when this photo was taken
Type:
  • number
Default Value:
  • 0
Source:

Methods

set(data) → {GeneralPhoto}

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