Resource aa:time-based

Overview

The aa:time-based resource represents the time-based annotation of an asset.

Properties

The aa:time-based resource has the following properties:

videoStartTC

The timecode the segments of this resource (see segments) are relative too. A segment with a start value of 0 has this time code.

Please note: The property videoStartTC of an aa:time-based resource is independent of the common.startTC property of the underlying aa:asset resource!

editRate

The edit rate of the asset. The frame numbers in the segments relate to this edit rate. The value is a rational number. Typical values:

  • 25/1: 25 fps

  • 30000/1001: 29,97 fps

  • 24000/1001: 23,976 fps

  • 60000/1001: 59,94 fps

dropFrame

true if the videoStartTC (and timecodes calculated for the segments) uses a drop-frame timecode format, false otherwise or if this property is not present.

layers

Array with one item for each layers of time-based annotation. In MediaCentral Asset Management, there’s one layer per stratum. In MediaCentral Production Management there is one layer of restrictions and one layer per track of markers.

Each layer item has the following properties:

name

The name of the layer. In MediaCentral Asset Management, this is the name of the stratum. In MediaCentral Production Management, this is marker or restriction.

segments

An array with one item for each segment in this layer. In MediaCentral Production Management, this is marker or restriction.

Each segment item has the following properties:

id

Identifier of the segment. The value is unique within a layer for an asset. It is not unique across layers or across assets.

start

Start of the segment. The value is a frame number relative to the start of the video.

duration

The duration of the segment. The value is a number of frames.

attributes

An array of attribute items for the segment.

userName

The name of the user in MediaCentral Production Management for markers.

Each segment attribute has the following properties:

name

The name of the attribute

value

The value of the attribute

type

Type of the attribute. If not present, the attribute is a string attribute. See aa:attributes for details.

aa:update-time-based

Modify a layer of the time-based annotation.

aa:delete-time-based

Delete parts of the time-based annotation.

aa:asset

Link to the asset that contains the time-based annotation.

Description

The aa:time-based resource represents the time-based annotation of an asset.

The data model of the layers, the available segment attributes and GUI layout information are described in the datamodel:asset-model resource.

The following additional links in the MediaCentral Production Management Connector are deprecated and should not be used anymore:

  • aa:assets

  • aa:asset-by-id

  • aa:time-based-by-layer

  • aa:time-based-by-layer-by-segment-id

  • aa:create-update-time-based

  • aa:create-update-time-based-by-layer

  • aa:create-update-time-based-by-layer

  • aa:create-update-time-based-by-layer-by-segment

Examples

Example of a time-based annotation of a MediaCentral | Asset Management asset, including three layers:
 
{
  "editRate": "25/1",
  "dropFrame": false,
  "videoStartTC": "00:00:00:00",
  "_links": {
    "curies": [
      {
        "href": "http://services.avid.com/apis/assets/{rel}",
        "name": "aa",
        "templated": true
      }
    ],
    "self": {
      "href": "https://host/…​"
    },
    "aa:asset": {
      "href": "https://host/…​"
    }
  },
  "layers": [
    {
      "name": "LOCATION",
      "segments": [
        {
          "id": "0",
          "start": 2,
          "duration": 4,
          "attributes": [
            {
              "name": "SEGMENT_LOCATION_ACTIONNAME",
              "value": "My action"
            }
          ]
        }
      ]
    },
    {
      "name": "SUBTITLES",
      "segments": []
    },
    {
      "name": "DEFAULT",
      "segments": [
        {
          "id": "0",
          "start": 0,
          "duration": 375
        },
        {
          "id": "1",
          "start": 375,
          "duration": 11
        },
        {
          "id": "2",
          "start": 386,
          "duration": 74
        }
      ]
    }
  ]
}
 

Example of a aa:time-based resource of a MediaCentral Production Management asset including three markers on two tracks:
 
{
    "editRate": "25.00",
    "dropFrame": false,
    "videoStartTC": "01:00:00:00",
    "layers": [
        {
            "name": "A1",
            "segments": [
                {
                    "id": "060a2b340101010101010f0013-000000-509c2d9367f60722-060e2b347f7f-2a80",
                    "start": 10,
                    "duration": 1,
                    "userName": "Thomas",
                    "attributes": [
                        {
                            "name": "color",
                            "value": "Yellow"
                        },
                        {
                            "name": "text",
                            "value": "Yet another marker!"
                        }
                    ]
                }
            ]
        },
        {
            "name": "V1",
            "segments": [
                {
                    "id": "060a2b340101010101010f0013-000000-509c2d9361f60722-060e2b347f7f-2a80",
                    "start": 10,
                    "duration": 1,
                    "userName": "Thomas",
                    "attributes": [
                        {
                            "name": "color",
                            "value": "Blue"
                        },
                        {
                            "name": "text",
                            "value": "Testing SCIT"
                        }
                    ]
                },
                {
                    "id": "060a2b340101010101010f0013-000000-509c2e9361f60722-060e2b347f7f-2a80",
                    "start": 15,
                    "duration": 1,
                    "userName": "thomasR",
                    "attributes": [
                        {
                            "name": "color",
                            "value": "Red"
                        },
                        {
                            "name": "text",
                            "value": "Create with Postman!"
                        }
                    ]
                }
            ]
        }
    ],
    "_links": {
        "curies": {
            "name": "aa",
            "href": "http://services.avid.com/apis/assets/{rel}",
            "templated": true
        },
        "self": {
            "href": "https://host/…​"
        },
        "aa:assets": {
            "href": "https://host/…​"
        },
        "aa:asset-by-id": {
            "href": "https://host/…​"
        },
        "aa:delete-time-based": {
            "href": "https://host/…​",
            "templated": true
        },
        "aa:update-time-based": {
            "href": "https://host/…​"
        }
    }
}