TimePoint (v1)

Warning

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

Description

A time point in an audio or video stream.

Properties

Synopsis

Properties marked with * are required.

Property

Type

Origin

timePoint *

integer

native

timeUnit

string

Region (v1)

document

string

Annotation (v2)

id *

string

Thing (v1)

Native

timePoint

  • type: integer

  • required: yes

The starting offset in the stream.

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*."
    },
    "timePoint": {
      "description": "The starting offset in the stream.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "timePoint"
  ],
  "type": "object"
}