Chapter (v2)

Warning

This is not the latest version. The latest version is v6.

Description

Example case for when we do not want to use Segment with a specific segmentType or if we want to introduce special properties.

Properties

Synopsis

Properties marked with * are required.

Property

Type

Origin

title

string

native

frameType

string

TimeFrame (v2)

end

integer

Interval (v1)

start

integer

Interval (v1)

targets

array of string

Interval (v1)

timeUnit

string

Region (v1)

document

string

Annotation (v2)

id *

string

Thing (v1)

Native

title

  • type: string

  • required: no

Title of the chapter

Inherited from TimeFrame (v2)

frameType

  • type: string

  • required: no

The type of TimeFrame. Possible values include, but are not limited to, bars, tones, bars-and-tones, speech, noise, music, slate, chyron, lower-third, credits, and other.

Inherited from Interval (v1)

end

  • type: integer

  • required: no

The ending offset in the primary data. This point is exclusive. For time intervals, the unit is determined by the timeUnit metadata key. For text intervals, the unit is Unicode code point.

start

  • type: integer

  • required: no

The starting offset in the primary data. This point is inclusive. For time intervals, the unit is determined by the timeUnit metadata key. For text intervals, the unit is Unicode code point.

targets

  • type: array of string

  • required: no

IDs of a sequence of annotations covering the region of primary data referred to by this annotation. Used as an alternative to start and end to point to component annotations (for example a token sequence) rather than directly into primary data, or to link two or more annotations (for example in a coreference annotation).

Inherited from Region (v1)

timeUnit

  • type: string

  • required: no

Specifies which unit of time the measurement is based. Can be seconds or milliseconds, or in case of annotations on a VideoDocument, frames.

Inherited from Annotation (v2)

document

  • type: string

  • required: no

The identifier of the document that the annotation is over.

Inherited from Thing (v1)

id

  • type: string

  • required: yes

A unique identifier for the annotation or document. Uniqueness is relative to the view the annotation is in or the list of documents at the top level of a MMIF file.

JSON Schema

{
  "additionalProperties": true,
  "properties": {
    "id": {
      "description": "A unique identifier for the annotation or document. Uniqueness is relative to the view the annotation is in or the list of documents at the top level of a MMIF file.",
      "type": "string"
    },
    "document": {
      "type": "string",
      "description": "The identifier of the document that the annotation is over."
    },
    "timeUnit": {
      "type": "string",
      "description": "Specifies which unit of time the measurement is based. Can be *seconds* or *milliseconds*, or in case of annotations on a VideoDocument, *frames*."
    },
    "start": {
      "type": "integer",
      "description": "The starting offset in the primary data. This point is inclusive. For time intervals, the unit is determined by the *timeUnit* metadata key. For text intervals, the unit is Unicode code point."
    },
    "end": {
      "type": "integer",
      "description": "The ending offset in the primary data. This point is exclusive. For time intervals, the unit is determined by the *timeUnit* metadata key. For text intervals, the unit is Unicode code point."
    },
    "targets": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "description": "IDs of a sequence of annotations covering the region of primary data referred to by this annotation. Used as an alternative to *start* and *end* to point to component annotations (for example a token sequence) rather than directly into primary data, or to link two or more annotations (for example in a coreference annotation)."
    },
    "frameType": {
      "type": "string",
      "description": "The type of TimeFrame. Possible values include, but are not limited to, bars, tones, bars-and-tones, speech, noise, music, slate, chyron, lower-third, credits, and other."
    },
    "title": {
      "type": "string",
      "description": "Title of the chapter"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}