Class: Transcription

Transcription(data)

Class representing the transcription of a section of a CultureEvent. A single Transcription may cross GeneralRecording boundaries. Translation and metadata can be associated with the transcription.

Constructor

new Transcription(data)

Constructs a Transcription object
Parameters:
Name Type Description
data Transcription | Object
Source:

Members

_id :string

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

cultureEvent :string

_id of the CultureEvent this Transcription is a part of
Type:
  • string
Source:

gridItems :Array.<string>

Array of gridItem keys from CultureGrid on Desktop, in the form or row key, hyphen, column key. Example: causeEffect–kinship
Type:
  • Array.<string>
Source:

idx :number

The order of this Transcription in relation to all other Transcriptions for this CultureEvent
Type:
  • number
Source:

note :string

Any note the user wants to make about this Transcription
Type:
  • string
Source:

searchWords :Array.<string>

Array of SearchWord._id's
Type:
  • Array.<string>
Source:

tags :Array.<string>

Array of strings from Tag.tagText
Type:
  • Array.<string>
Source:

text :string

The transcribed text. This is expected to be in the orthography of the target language.
Type:
  • string
Source:

title :string

Optional title the user may give to this Transcription
Type:
  • string
Source:

transcriptionEndTime :number

see gh216 in desktop. Per Bill, we don't need this, but since we were already calculating it, I'm leaving it in just in case we want to use it later. Ending time of the transcription, in seconds (with decimals), from the beginning of the CultureEvent. Currently, this is the ending time of the last loop used when creating/editing the text of transcription.
Type:
  • number
Source:

transcriptionStartTime :number

Starting time of the transcription, in seconds (with decimals), from the beginning of the CultureEvent. If there are multiple GeneralRecordings in the CultureEvent, this is the time from the beginning of the first GeneralRecording.
Type:
  • number
Source:

translation :string

A translation of Transcription.text into the user's language
Type:
  • string
Source:

Methods

set(data) → {Transcription}

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