VideoData

What's the VideoData?

The VideoData is an object that provides essential information about a video stored in DIVA BO, including metadata, playback settings, and additional configurations.

All VideoData fields

Property	Type	Default	Description	Example
videoId	string	""	Unique identifier for the video	"video123"
title	string	""	Title of the video	"Sample Video"
description	string	""	Description of the video	"This is a sample video."
image	string	""	URL of the video thumbnail	"https://example.com/image.jpg"
event	EventBo		Event associated with the video
kind	string	""	Type of the video	"live"
preroll	string	""	URL of the preroll ad
programDateTime	number	0	Program date and time in milliseconds	1680000000000
trimIn	number	0	Client-side trimming start in milliseconds	0
trimOut	number	0	Client-side trimming end in milliseconds	60000
expectedDuration	number	0	Expected duration of the video in milliseconds	60000
assetState	string	""	State of the video asset	"available"
isMultistream	boolean	false	Indicates if the video has multiple streams	false
is360	boolean	false	Indicates if the video is a 360-degree video	false
mode360	Mode360	""	Mode of the 360-degree video	"monoscopic360"
isPrivate	boolean	false	Indicates if the video is private	false
thirdPartyContentProvider	any		Third-party content provider information
audioTracks	array of AudioTrackBo	[]	List of audio tracks
categories	Record<string, unknown>		Categories associated with the video
customAttributes	CustomAttributesBo		Custom attributes for the video
capabilities	CapabilitiesBo		Capabilities of the video
livelike	LivelikeBo		Livelike configuration
sources	array of SourceBo	[]	List of video sources
tags	Tag		Tags associated with the video

Types

AudioTrackBo

Property	Type	Description	Example
id	string	Unique identifier for the audio track	"audio1"
displayName	string	Display name of the audio track	"English"

EventBo

Property	Type	Description	Example
id	string	Unique identifier for the event	"event123"

Tag

Property	Type	Description	Example
externalSource	string	External source of the tag	"source1"
externalId	string	External identifier of the tag	"tag123"

Mode360

Value	Description
monoscopic360	Monoscopic 360-degree video
updown360	Up-down 360-degree video

LivelikeBo

Property	Type	Description	Example
programId	any	Program ID for Livelike	"program123"

CapabilitiesBo

Property	Type	Description	Example
score	boolean	Indicates if scoring is enabled	true
alternateCommentary	boolean	Indicates if alternate commentary is available	false
commentary	boolean	Indicates if commentary is available	true
chapters	boolean	Indicates if chapters are available	true
timeline	boolean	Indicates if timeline is available	true
multicam	boolean	Indicates if multicam is supported	false
multicam360	boolean	Indicates if 360-degree multicam is supported	false
dataPanels	boolean	Indicates if data panels are available	true
cc	boolean	Indicates if closed captions are available	true
xRay	boolean	Indicates if x-ray functionality is available	false
relevantCommentary	boolean	Indicates if relevant commentary is available	true
snapStats	boolean	Indicates if snap stats are available	true
title	boolean	Indicates if title functionality is available	true
userAudioSelection	boolean	Indicates if user audio selection is available	true
videoQuality	boolean	Indicates if video quality selection is available	true
vr	boolean	Indicates if VR functionality is available	false
wallclock	boolean	Indicates if wallclock functionality is available	true

CustomAttributesBo

Property	Type	Description	Example
v_video_provider	string	Video provider	"provider1"
v_available_display_start_date	string	Available display start date	"2025-01-01"
v_available_display_end_date	string	Available display end date	"2025-12-31"
...	string	Additional custom attributes

SourceBo

Property	Type	Description	Example
uri	string	URI of the video source	"https://example.com/video.m3u8"
format	string	Format of the video source (e.g., HLS, DASH)	"HLS"
name	string	Name of the video source	"Main Source"
origin	string	Origin of the video source	"origin1"
drm	DrmBo	DRM configuration for the video source
daiType	string	DAI type for the video source	"googleLive"
hdrType	string	HDR type for the video source	"HDR10"
dvrType	string	DVR type for the video source	"full"
offset	number	Offset for the video source in milliseconds	0
timeMap	array of TimeMapBo	Time map for the video source

DrmBo

Property	Type	Description	Example
[drmType]	DrmDataBo	DRM data for the specified DRM type

DrmDataBo

Property	Type	Description	Example
enabled	boolean	Indicates if DRM is enabled	true
authType	string	Authentication type for DRM	"token"
contentKeyData	string	Content key data for DRM	"key123"
licenseUrl	string	License URL for DRM	"https://example.com/license"
provider	string	DRM provider	"provider1"
token	string	DRM token	"token123"

TimeMapBo

Property	Type	Description	Example
start	number	Start time of the time map in milliseconds	0
end	number	End time of the time map in milliseconds	60000
offset	number	Offset for the time map in milliseconds	0

Sample

Here is an example of a VideoData object:

{
  "videoId": "video123",
  "title": "Sample Video",
  "description": "This is a sample video.",
  "image": "https://example.com/image.jpg",
  "event": {
    "id": "event123"
  },
  "kind": "live",
  "preroll": "https://example.com/preroll.mp4",
  "programDateTime": 1680000000000,
  "trimIn": 0,
  "trimOut": 60000,
  "expectedDuration": 60000,
  "assetState": "available",
  "isMultistream": false,
  "is360": false,
  "mode360": "monoscopic360",
  "isPrivate": false,
  "thirdPartyContentProvider": null,
  "audioTracks": [
    {
      "id": "audio1",
      "displayName": "English"
    }
  ],
  "categories": {
    "genre": "sports"
  },
  "customAttributes": {
    "v_video_provider": "provider1",
    "v_available_display_start_date": "2025-01-01",
    "v_available_display_end_date": "2025-12-31"
  },
  "capabilities": {
    "score": true,
    "alternateCommentary": false,
    "commentary": true
  },
  "livelike": {
    "programId": "program123"
  },
  "sources": [
    {
      "uri": "https://example.com/video.m3u8",
      "format": "HLS",
      "name": "Main Source",
      "origin": "origin1",
      "drm": {
        "widevine": {
          "enabled": true,
          "licenseUrl": "https://example.com/license"
        }
      }
    }
  ],
  "tags": {
    "externalSource": "source1",
    "externalId": "tag123"
  }
}