Overview

VIDIZMO allows you to attach timed data files with your media content to enhance its accessibility. These timed data can include:

  • Closed Captions: Closed captions are transcriptions of the words spoken in a video/audio. Closed captions can be used to add clarity to video and audio files. Moreover, it increases the searching ability and also assists those with hearing disabilities, an accessibility requirement for 508 Compliance. VIDIZMO supports Closed Captions (CC) for audio and video files. These can be added from the Media Settings either accessed from Media Manager or while uploading media. 
  • Drone Data: Data collected from drones, which can be added for geo-spatial data analysis. 
  • Annotations: Annotations are small notes, tags, or comments in a video intended to achieve a lot within a limited canvas of a video frame. It helps redirect the user/viewer's attention to a particular still of a video and to focus on an object/facet which would have otherwise gone unnoticed.
  • Quiz: VIDIZMO allows you to create multiple-page Quiz for your audience to evaluate how well do they grasp the gist of the media they have interacted with/watched, and better engage them with your content.
  • Survey: VIDIZMO provides you the functionality of creating a single or multiple-page Survey for lead capturing or to keep track of customers’ satisfaction. Which can be displayed to the viewers at any predefined time in a video. 
  • Handouts: Handouts are files of any size and type (yes, you heard that right) that you can attach to any certain point within your videos, right through built-in VIDIZMO Studio without any integration with third-party tools. 


Here we shall be looking at TimedDataInfo Object in detail to understand the various properties it contains in VIDIZMO REST API Reference.


TimedDataInfo Object


{
    "culture": <string>,
    "startTime": <number>,
    "endTime": <number>,
    "text": <string>,
    "data": [
      //This is passed in case timed-data-type is Annotation
      {
        "x": <string>,
        "y": <string>,
        "width": <string>,
        "height": <string>,
        "name": <string>,
        "addedDate": <utcDateAndTime>,
        "fillColor": <string>
      },
      //This is passed in case timed-data-type is Survey
      {
        "guid": <string>,
        "objectId": <string>,
        "objectTitle": <string>,
        "playerState": [
          "Pause",
          "Disable"
        ],
        "canSkip": <boolean>,
        "continuationCriteria": <string>,
        "isHidden": <boolean>
      },
      //This is passed in case timed-data-type is Handout
      {
        "guid": <string>,
        "objectId": "[{\"fileName\":\"Digital Advertising Approach Presentation.pdf\",\"contentId\":62481,\"fileUrl\":\"https://yourPortalURL.com/cdn/5975/f1/f1a61adcba95b3f5a856b32fbeb.pdf\"}]",
        "playerState": [
          "Playing"
        ],
        "continuationCriteria": <string>,
        "isHidden": <boolean>
      },
      //This is passed in case timed-data-type is Handout
      {
        "guid": <string>,
        "objectId": "{\"portalId\":\"6244349\",\"formId\":\"c828e9c-43a6-4431-a3a9-84d6589c89bf\"}",
        "pluginName": "hubspot",
        "playerState": [
          "Pause",
          "Disable"
        ],
        "canSkip": <boolean>,
        "continuationCriteria": <string>,
        "isHidden": <boolean>
      },
      //This is passed in case timed-data-type is Quiz
      {
        "guid": <string>,
        "objectId": <string>,
        "objectTitle": <string>,
        "playerState": [
          "Pause",
          "Disable"
        ],
        "canSkip": <boolean>,
        "continuationCriteria": <string>,
        "isHidden": <boolean>
      },
      //This is passed in case timed-data-type is faces
      {
        "videoId": <string>,
        "confidence": <number>,
        "description": <string>,
        "title": <string>,
        "thumbnailId": <string>,
        "seenDuration": <number>,
        "seenDurationRatio": <number>,
        "id": <number>,
        "name": <string>,
        "appearances": [
          {
            "startTime": <string>,
            "endTime": <string>,
            "startSeconds": <number>,
            "endSeconds": <number>
          }
        ],
        "imageUrl": <string>,
        "thumbnails": [
          {
            "id": <string>,
            "fileName": <string>,
            "instances": [
              {
                "adjustedStart": <string>,
                "adjustedEnd": <string>,
                "start": <string>,
                "end": <string>,
                "thumbnailsIds": [
                  <string>
                ],
                "thumbnailId": <string>,
                "confidence": <number>,
                "brandType": <string>
              }
            ]
          }
        ],
        "instances": [ 
          {
            "adjustedStart": <string>,
            "adjustedEnd": <string>,
            "start": <string>,
            "end": <string>,
            "thumbnailsIds": [
              <string>
            ],
            "thumbnailId": <string>,
            "confidence": <number>,
            "brandType": <string>
          }
        ]
      },
      //This is passed in case timed-data-type is keywords
      {
        "isTranscript": <boolean>,
        "id": <number>,
        "name": <string>,
        "appearances": [
          {
            "startTime": <string>,
            "endTime": <string>,
            "startSeconds": <number>,
            "endSeconds": <number>
          }
        ],
        "text": <string>,
        "confidence": <number>,
        "language": <string>,
        "instances": [
          {
            "adjustedStart": <string>,
            "adjustedEnd": <string>,
            "start": <string>,
            "end": <string>,
            "thumbnailsIds": [
              <string>
            ],
            "thumbnailId": <string>,
            "confidence": <number>,
            "brandType": <string>
          }
        ]
      },
      // This is passed in case timed-data-type is sentiments
      {
        "sentimentKey": <string>,
        "seenDurationRatio": <number>,
        "appearances": [
          {
            "startTime": <string>,
            "endTime": <string>,
            "startSeconds": <number>,
            "endSeconds": <number>
          }
        ],
        "id": <number>,
        "averageScore": <number>,
        "sentimentType": <string>,
        "instances": [
          {
            "adjustedStart": <string>,
            "adjustedEnd": <string>,
            "start": <string>,
            "end": <string>,
            "thumbnailsIds": [
              <string>
            ],
            "thumbnailId": <string>,
            "confidence": <number>,
            "brandType": <string>
          }
        ]
      },
      //This is passed in case timed-data-type is emotions
      {
        "type": <string>,
        "seenDurationRatio": <number>,
        "appearances": [
          {
            "startTime": <string>,
            "endTime": <string>,
            "startSeconds": <number>,
            "endSeconds": <number>
          }
        ],
        "id": <number>,
        "instances": [
          {
            "adjustedStart": <string>,
            "adjustedEnd": <string>,
            "start": <string>,
            "end": <string>,
            "thumbnailsIds": [
              <string>
            ],
            "thumbnailId": <string>,
            "confidence": <number>,
            "brandType": <string>
          }
        ]
      },
      //This is passed in case timed-data-type is audio-effects
      {
        "audioEffectKey": <string>,
        "seenDurationRatio": <number>,
        "seenDuration": <number>,
        "appearances": [
          {
            "startTime": <string>,
            "endTime": <string>,
            "startSeconds": <number>,
            "endSeconds": <number>
          }
        ]
      },
      //This is passed in case timed-data-type is labels
      {
        "id": <number>,
        "name": <string>,
        "appearances": [
          {
            "startTime": <string>,
            "endTime": <string>,
            "startSeconds": <number>,
            "endSeconds": <number>
          }
        ],
        "referenceId": <string>,
        "language": <string>,
        "instances": [
          {
            "adjustedStart": <string>,
            "adjustedEnd": <string>,
            "start": <string>,
            "end": <string>,
            "thumbnailsIds": [
              <string>
            ],
            "thumbnailId": <string>,
            "confidence": <number>,
            "brandType": <string>
          }
        ]
      },
      //This is passed in case timed-data-type is brands
      {
        "referenceId": <string>,
        "referenceUrl": <string>,
        "confidence": <number>,
        "description": <string>,
        "seenDuration": <number>,
        "id": <number>,
        "name": <string>,
        "appearances": [
          {
            "startTime": <string>,
            "endTime": <string>,
            "startSeconds": <number>,
            "endSeconds": <number>
          }
        ],
        "referenceType": <string>,
        "tags": [
          <string>
        ],
        "isCustom": <boolean>,
        "instances": [
          {
            "adjustedStart": <string>,
            "adjustedEnd": <string>,
            "start": <string>,
            "end": <string>,
            "thumbnailsIds": [
              <string>
            ],
            "thumbnailId": <string>,
            "confidence": <number>,
            "brandType": <string>
          }
        ]
      },
      //This is passed in case timed-data-type is statistics
      {
        "correspondenceCount": <number>,
        "speakerTalkToListenRatio": {
          "__invalid_name__1": <number>,
          "__invalid_name__3": <number>
        },
        "speakerLongestMonolog": {
          "__invalid_name__1": <number>,
          "__invalid_name__3": <number>
        },
        "speakerNumberOfFragments": {
          "__invalid_name__1": <number>,
          "__invalid_name__3": <number>
        },
        "speakerWordCount": {
          "__invalid_name__1": <number>,
          "__invalid_name__3": <number>
        }
      },
      //This is passed in case timed-data-type is topics
      {
        "referenceUrl": <string>,
        "iptcName": <string>,
        "iabName": <string>,
        "confidence": <number>,
        "id": <number>,
        "name": <string>,
        "referenceId": <string>,
        "referenceType": <string>,
        "language": <string>,
        "appearances": [
          {
            "startTime": <string>,
            "endTime": <string>,
            "startSeconds": <number>,
            "endSeconds": <number>
          }
        ],
        "instances": [
          {
            "adjustedStart": <string>,
            "adjustedEnd": <string>,
            "start": <string>,
            "end": <string>,
            "thumbnailsIds": [
              <string>
            ],
            "thumbnailId": <string>,
            "confidence": <number>,
            "brandType": <string>
          }
        ]
      }
    ],
    "dataType": <string>, 
    "userProfileId": <number>,
    "geography": {
      "latitude": <number>,
      "longitude": <number>
    }
  }
JavaScript


Read Next