Annotations

​

Introduction

Annotations are a powerful concept in the Motto platform. In fact, we believe it is this concept that makes Motto shine when it comes to live sports OTT platforms.

Annotations are representations of points in time in a video, and can be used to mark key moments in a match, like goals, fouls, or substitutions. These moments can be tagged through our visual Studio interface without any technical knowledge.

By themselves, annotations are just empty containers; they do not “do” anything as such. However, they lay the fundament for two important concepts in Motto: actions and frontend plugins. In a nutshell, actions are automations that are triggered when an annotation is created, and frontend plugins are components that can be dropped into your OTT platform to enhance the user experience.

For more information, please read our sections about actions and frontend plugins.

​

Get Started

Before you can get started with creating annotations, you must first create a few supporting objects. These are described below.

​

Annotation sets

An annotation set is a collection of the kinds of annotation types that you would like to create. Typically, you would create an annotation set for each sport that you are covering. For example, you might have an annotation set for football, and another for basketball. To create your annotation set, follow these steps:

curl --request POST \
  --url https://api.mottostreaming.com/annotations/sets/v1 \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project_id": "<your_project_id>",
  "name": "Football"
}'

curl --request POST \
  --url 'https://api.mottostreaming.com/annotations/sets/v1/<your_annotation_set>/attach?project_id=<your_project_id>&content_base_type=event&content_type_id=<your_event_type>' \
  --header 'Authorization: Bearer <your_token>'

​

Annotation types

Once you have created an annotation set, you must create some annotation types within that set. Annotation types are the different kinds of annotations that you can create. For example, you might have an annotation type for goals, chances, corner kicks, red cards, kickoff, full-time, etc. To create your annotation types, follow these steps:

curl --request POST \
  --url https://api.mottostreaming.com/annotations/types/v1 \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project_id": "<your_project_id>",
  "set_id": "<your_set_id>",
  "name": "Goal",
  "priority": "1000",
  "group_name": "In-Game Moments",
}'

​

Annotations

Now that you have created your annotation set and annotation types, you can start creating annotations for your video content! To create an annotation, follow these steps:

Via the Studio

Navigate to the Video Manager in the Studio, and select the event and video you would like to annotate. Click on the “Video tagging” tab. If you have created an annotation set and associated annotation types, you should see something similar to this:

If you do not see the “Video tagging” tab in the Studio interface, this may mean that you have not attached your annotation set to your event type yet. Please refer to the annotation set section above.

When you click on one of the available annotation types, an annotation will be created at the current time in the video player on that page.

Via the API

Call the Create Annotation endpoint. In it’s simplest form, this call could look like:

curl --request POST \
  --url https://api.mottostreaming.com/annotations/annotations/v1 \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "project_id": "<your_project_id>",
  "type_id": "<your_type_id>",
  "video_id": "<your_video_id>",
  "offset": "60000"
}'

This call will create an annotation of type “Goal” that you just created, in the video of your choice. The offset field is the time in milliseconds where the annotation should be placed. In the example above, this would be at 60 seconds into the video.

The video_id field represents a single video, and is not the same as the event_id or live_stream_id.

​

Next Steps

Now that you know how to create annotations, you may want to learn more about actions, which allows you to automate your workflows during a live-stream or VOD!