¶ Busby MAM Types and Interfaces
| Property |
Type |
Description |
Example |
Notes/More Information |
| mediaAssetManagementService |
string (optional) |
The name of the media asset management service to connect to. If not provided the script step will provide this for you. |
mamService |
Only use this if you know what you are doing, it may cause unexpected results. |
An item is the top level object of any asset or material in the Busby MAM system. It contains various properties as specified below.
| Property |
Type |
Description |
Example |
Notes/More Information |
| itemUuid |
string |
UUID of the item |
|
|
| itemType |
string |
Type of the item (as defined in the item types configuration) |
|
|
| ids |
IIds |
|
|
|
| id |
string |
Item ID |
|
|
| title |
string | null |
Item title |
|
|
| licensingMetadata |
ILicensingMetadata |
Licensing metadata |
|
|
| productionMetadata |
IProductionMetadata |
Item level production metadata |
|
|
| technicalMetadata |
ITechnicalMetadata |
Technical metadata |
|
|
| distributionMetadata |
IDistributionMetadata |
Distribution metadata |
|
|
| airedOnMetadata |
IAiredOnMetadata |
Aired on metadata |
|
|
| markerMetadata |
IMarkerMetadata |
Marker metadata |
|
|
| children |
IItem[] |
Array of children IItem |
|
|
| userMetadata |
IUserMetadata |
Item level user metadata |
|
|
| instances |
IInstance[] |
Array of instances associated with this item |
|
|
| parent |
{ itemUuid : string } | IItem |
Parent IItem or itemUuid |
|
|
| deleteMarker |
IDeleteMarker | null |
Delete marker, if set |
|
|
| tags |
ITag[] |
Array of tags |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| item |
IItem |
|
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| items |
IItem[] |
Array of items |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| item |
IItem |
|
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| items |
IItem[] |
Array of items |
|
|
Each item type can have multiple types of IDs, these are configured in the Busby Configuration Editor when configuring item types.
| Property |
Type |
Description |
Example |
Notes/More Information |
| [ key : string ] |
string |
The name of the ID, as configured for this item type |
|
|
Licensing metadata lists licensing deals associated with the item.
| Property |
Type |
Description |
Example |
Notes/More Information |
| deals |
IDeal[] |
Array of licensing deals |
|
|
A Deal specifies the properties below.
| Property |
Type |
Description |
Example |
Notes/More Information |
| name |
string |
Name of the deal |
|
|
| code |
string |
Code of the deal |
|
|
| type |
string |
Type of the deal |
|
|
| start |
BDateTimeJson |
When the deal starts |
|
|
| end |
BDateTimeJson |
When the deal ends |
|
|
| playCount |
number |
Play count |
|
|
Production metadata contains metadata about the production of the item
| Property |
Type |
Description |
Example |
Notes/More Information |
| production |
IProduction |
|
|
|
| inTimecode |
BDateTimeJson |
|
|
|
| duration |
BDurationJson |
Type of the deal |
|
|
| genre |
string |
Genre of the item |
|
|
| count |
ICount |
|
|
|
| titles |
ITitles |
|
|
|
| certifications |
ICertification[] |
|
|
|
| version |
string |
|
|
|
| graphics |
any |
|
|
|
| userMetadata |
any |
Production level user metadata |
|
Schema is validated against user metadata form as defined in the MAM service configuration |
Production contains details such as year and country of production.
| Property |
Type |
Description |
Example |
Notes/More Information |
| year |
string |
Year of production |
"2023" |
|
| company |
string |
Production company |
"SQP Studios" |
|
| country |
string |
Country of production |
"Deutschland" |
|
Count is used to specifiy data such as episode number in a series/season.
| Property |
Type |
Description |
Example |
Notes/More Information |
| [ itemType: string ] |
string |
Name of the item type |
episode |
|
| index |
number |
E.g. episode number |
1 |
|
Titles is used to specify titles for different item types.
| Property |
Type |
Description |
Example |
Notes/More Information |
| [ itemType: string ] |
string |
Key is the name of the itemType. Value is the title. |
|
|
Certification provides regulatory information.
| Property |
Type |
Description |
Example |
Notes/More Information |
| regulator |
string |
Regulator Name |
"Bayerische Landeszentrale für neue Medien (BLM)" |
|
| certification |
string |
Certification of the item |
"12A20" |
|
| compliance |
ICompliance[] |
Total number of items in the count, e.g. total number of episodes |
|
|
Compliance provides compliance information, such as information about swearing, nudity etc.
| Property |
Type |
Description |
Example |
Notes/More Information |
| name |
string |
The name of the compliance metadata |
Disturbing Material |
|
| type |
string |
The type of the compliance metadata |
warning |
|
| inTimecode |
BDateTimeJson |
Optional - where the compliance issue starts |
|
|
| duration |
BDurationJson |
Optional - how long the compliance issue lasts |
|
|
Technical metadata is technical metata at the item level
| Property |
Type |
Description |
Example |
Notes/More Information |
| frameRate |
Frtype |
The frame rate type |
|
|
| requiredTrackTypes |
ITrackType[] |
Optional list of required track types |
|
|
| userMetadata |
any |
Technical level user metadata |
|
Schema is validated against user metadata form as defined in the MAM service configuration |
Track Types are used to describe track position, languages etc
| Property |
Type |
Description |
Example |
Notes/More Information |
| tracktypeUuid |
string |
The UUID of the track type |
"8b9433f2-95e4-48a3-877d-dc974e9051ce" |
|
| trackType |
string |
The name of the track type |
"Audio English (Stereo)" |
|
| trackPosition |
number |
The position of the track |
2 |
|
| language |
string | null |
The language of the track |
"English" |
|
| madeFrom |
ITrackType[] |
|
|
|
Distribution metadata is used to provide information about the distribution of the item.
An object with user defined key names, each with the following properties
{
[territory: string]: {
[language: string]: {
[itemType: string]: {
titles: {
[type: string]: any
}
advisory: {
[type: string]: any
},
synopsis: {
[type: string]: any
},
count: {
index: number
total: number
}
}
}
}
}
For example:
{
"uk": {
"episode" : {
"titles": {
"short": "Short title",
"long": "This is my long title"
}
}
}
}
| Property |
Type |
Description |
Example |
Notes/More Information |
| dateTime |
BDateTimeJson |
The time the item was aired/scheduled on |
|
|
| channelName |
string |
The channel name the item was aired/scheduled on |
|
|
| metadata |
|
An object with user defined key names, containing any valid JSON |
{"myMetadata": {"hello":"world"}} |
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| markerSets |
IMarkerSet[] |
The time the item was aired/scheduled on |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| markerSetTypeUuid |
string |
UUID of the marker set type |
"b0e849ce-d367-40c1-99ee-6cdcaf8ad983" |
|
| name |
string |
Name of the marker set type |
"compliance" |
|
| type |
string |
Type of the marker set type as configured in the MAM Service config |
|
|
| markerTypes |
IMarkerType[] |
Array of marker types |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| markerUuid |
string |
UUID of the marker |
"b0e849ce-d367-40c1-99ee-6cdcaf8ad983" |
|
| duration |
BDurationJson |
The duration of the marker |
|
|
| inTimecode |
BDateTimeJson |
The in point of the marker |
|
|
| metadata |
any |
Any valid JSON to describe the marker |
|
|
| & IMarkerType |
IMarkerType |
Optionally include fields from IMarkerType |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| markerTypeUuid |
string |
UUID of the marke type |
"b0e849ce-d367-40c1-99ee-6cdcaf8ad983" |
|
| name |
string |
Name of the marker type |
"compliance" |
|
| mode |
"point" | "range" |
The mode of the marker type |
|
|
| colour |
string |
Colour for the markers to be displayed in the MAM UI |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| [id: string] |
any |
User metadata in format validated against the relavent user metadata form |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| instanceUuid |
string |
The UUID of the instance |
"da0c0d0d-1100-4de1-b7d2-27c4d373eeed" |
|
| filename |
string | null |
The file name of the instance |
"ABC1234.mxf" |
|
| technicalMetadata |
IInstanceTechnicalMetadata |
Technical metadata about the instance |
|
|
| fileMetadata |
IFileMetadata |
Metadata about the file |
|
|
| userMetadata |
IUserMetadata |
User metadata about the instance |
|
|
| trackTypes |
ITrackType[] |
Array of ITrackType |
|
|
| deleteMarker |
IDeleteMarker | null |
Delete marker |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| instance |
IInstance |
The instance that was added |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| duration |
BDurationJson |
The duration of the instance |
|
|
| inTimecode |
BDateTimeJson |
The in timecode of the instance |
"ABC1234.mxf" |
|
| selectorBrowse |
boolean |
Whether the instance can be browsed in Busby Selector |
|
|
| bitRateMbps |
number |
Bitrate of the instance in mbps |
|
|
| madeFrom |
ITrackType |
Optionally list the track types on this instance |
|
|
| resolution |
{ "width":number, "height":number } |
Width and height of the picture |
{"width":1920, "height":1080} |
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| location |
{"location":"string","filename":"string","path":"string"} |
The duration of the instance |
|
|
| checksums |
[type : string] : string |
A keyed object of checksums |
{"md5":"be2b602b04c47b2e656f50c1616e5571", "sme":"H6158.M6158.T6158"} |
|
| fileType |
string |
File type |
"mov" |
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| deleteAfter |
BDateTimeJson |
The time that the instance will be deleted after |
|
|
| Property |
Type |
Description |
Example |
Notes/More Information |
| tagUuid |
string |
UUID of the tag |
|
|
| id |
string |
ID of the tag |
|
|
| displayName |
string |
Display name of the tag |
|
|
| colour |
string |
Colour of the tag to be displayed in the MAM UI |
|
|
| parent |
{ tagUuid ?: string , tagId?: string } |
Optionally specify a parent tag by UUID or ID |
|
|