Media File

Validate against: http://json-schema.org/schema#

Description

An object containing information about a media file. The file itself should be stored at the URL indicated in the mediaURL field. Media files generally contain primary data. Examples might include audio/video recordings, scans of archival materials, photos taken during fieldwork, or scans of field notes.

Type: object

Required Properties

  • filename

Additional properties: true

Properties

  • Type: "type"

    Description

    The type of object. Must be set to Media.

    Type: string

  • ID: "id"

    Description

    A unique database identifier for this Media Item

  • Abbreviation: "abbreviation"

    Description

    An abbreviation for referring to this file

    Must be an instance of the Abbreviation schema.

  • Access Rights: "access"

    Description

    Access rights for this media file

    Must be an instance of the Access schema.

  • Content: "content"

    Description

    A description of the content of this file, optionally in multiple languages

    Must be an instance of the MultiLangString schema.

  • MIME Content Type: "contentType"

    Description

    The media type of the file. Must be a valid MIME type. Examples: audio/wav, application/pdf, video/mpeg

    Type: string

  • Creator (Person - Database Reference): "creator"

    Description

    A database reference to the person who created this specific file

    Must be an instance of the DatabaseReference schema.

  • Date Created: "dateCreated"

    Description

    The date and optionally time that this metadata object was originally created. Not the date the media file was created. For that, see the dateRecorded property.

    Type: string

    Validates Against (oneOf)

    This schema must validate against one and only one of the following schemas:

    • Format: date

    • Format: date-time

  • Date Modified: "dateModified"

    Description

    The date and optionally time that this metadata was last modified. Not the date that the media file was modified.

    Type: string

    Validates Against (oneOf)

    This schema must validate against one and only one of the following schemas:

    • Format: date

    • Format: date-time

  • Date Recorded: "dateRecorded"

    Description

    The date and optionally time that this media file was recorded or photographed. Or, if the file is a scan of field notes, the date that the scan was made. Not the date that this metadata object was created. For that, see the dateCreated property.

    Type: string

    Validates Against (oneOf)

    This schema must validate against one and only one of the following schemas:

    • Format: date

    • Format: date-time

  • End Time: "endTime"

    Description

    Within an audiovisual file, the time at which the relevant linguistic data ends. Programs may use this field in different ways. For example, if the camera recorded for five minutes after the speaker finished talking, the End Time would be the time 5 minutes before the end of the file. The time stamp should be in seconds and milliseconds, separated by a period, e.g. 12.573, or 1.234, or 167.780, etc.

    Type: number

    Minimum: 0.001

  • Filename: "filename"

    Description

    The filename for this media item without spaces, but including the extension

    Type: string

    Regular expression pattern: ^[^ ]+\.[^ ]+

  • Format (File Extension): "format"

    Description

    The format (file extension) of the media file, without a period. Examples: wav, mp4, pdf

    Type: string

  • Languages: "languages"

    Description

    An array of the languages that are used in this media file

    Type: array

    Unique items: true

    Items

    Language (Database Reference)

    Description

    A database reference to this language

    Must be an instance of the DatabaseReference schema.

  • Length (in Time / Pages): "length"

    Description

    The length of the file, in seconds and milliseconds if an audio/video file (in SS.MMM format), or pages if a document

    Type: number

    Minimum: 0.001

  • Link: "link"

    Description

    A URL where a presentational format for this resource may be viewed

    Type: string

    Format: uri

  • Location (Database Reference): "location"

    Description

    A database reference to the location where the content in this media file was recorded or produced

    Must be an instance of the DatabaseReference schema.

  • Media URL: "mediaURL"

    Description

    The URL where the media file can be found.

    Type: string

    Format: uri

  • Notes: "notes"

    Description

    A collection of notes about this media item.

    Type: array

    Unique items: true

    Items

    Note

    Must be an instance of the Note schema.

  • Original Media Item: "original"

    Description

    The URL of the Media object (not the URL to the media file itself) that this file is derived from

    Type: string

    Format: uri

  • Persons in File: "people"

    Description

    A list of all the people who appear in this file. Often a list of speakers.

    Type: array

    Unique items: true

    Items

    Person (Database Reference)

    Description

    A database reference to a person who appears in this file

    Must be an instance of the DatabaseReference schema.

  • File Size: "size"

    Description

    The size of the file, in bytes.

    Type: integer

    Minimum: 1

  • Start Time: "startTime"

    Description

    Within an audiovisual file, the time at which the relevant linguistic data starts, or the time at which an offset should be calibrated from. This may also be used to synchronize the starting point of multiple media files associated with a single Text. For example, if the camera started recording five minutes before the speaker began speaking, the Start Time might be 5 minutes from the start of the file (so 300.00 seconds). The time stamp should be in seconds and milliseconds, separated by a period, e.g. 12.573, or 1.2, or 167.78012, etc.

    Type: number

  • Tags: "tags"

    Description

    A set of tags for this media item

    Must be an instance of the Tags schema.

  • URL: "url"

    Description

    The URL where this media data can be retrieved. NOT the URL of the media file itself (for that, see the mediaURL attribute).

    Type: string

    Format: uri