Learn more about what is included in the metadata response when you are utilizing the Audible Magic Toolkit and are set up for Compliance Identification Response.
The Compliance Identification Response details information about a match that was found along with the business rules associated with the matched content. This metadata response is utilized within Audible Magic's compliance products.
The Compliance Identification Response can be broken down into 3 different sections/objects:
- Header Object
- Match Object
- Metadata Object
Header Object
Header Object Definitions
| Field | Value |
Description |
| statusCode | Integer | An integer value that represents the outcome of the identification. |
| statusDescription | String | A brief explanation of the status code. |
| unknownAssetID | String | A customer-determined string that uniquely and fully identifies the media file in the customer's systems. This is echoed in the identification response. |
| unknownMediaFileDuration | Number | The duration of the media file in seconds that is attempting to be identified. |
| matches | Array of match objects | An array of match objects which depict what was matched in the media file. |
Header Object Example
{
"statusCode": 2006,
"statusDescription": "Status 2006 (2006) Match found",
"unknownAssetID": "297J93",
"unknownMediaFileDuration": 278.1,
"matches": [
//omitted for brevity
]
}
Match Object
Match Object Definitions
| Field | Value | Description |
| ruleCode | String | What action to take (e.g. "block", "allow"). |
| matchType | String | What kind of reference fingerprint was matched (e.g. "audio", "video"). |
| amItemID | String | Audible Magic's internal content identifier for the matched reference. |
| matchTimeInUnknown | Number | The location in seconds of the start of the match in your media file. |
| matchDurationInUnknown | Number | The duration of the match in seconds. |
| matchTimeInReference | Number | The location of the start of the match in Audible Magic's reference media file. |
| metadata | Object | An object that depicts the metadata associated with the reference media file. |
Match Object Examples
"matches": [
{
"ruleCode": "block",
"matchType": "audio",
"amItemID": "b3f66873c09b49bfaec9d69d21a76949_RGUa00",
"matchTimeInUnknown": 0.500,
"matchDurationInUnknown": 33.000,
"matchTimeInReference": 0.600,
"metadata": {
// omitted for brevity
}
}
]
Metadata Object
Music Metadata Object Definitions
| Field | Value | Description |
| ContentCategory | String | The type of content that was matched. |
| Title | String | The title of the reference given by the content supplier. |
| Artist | String | The artist of the reference given by the content supplier. |
| ISRC | String | The International Standard Recording Code provided by the content supplier. |
| Label | String | The label associated with the copyright holder. |
| Vendor | String | The supplier of the reference media. file |
| AlbumReleaseDate | String | When the album containing the reference material was released. |
| AlbumUPC | String | The universal product code of the album that the reference material was released on. |
| SongLengthInSeconds | String | The length of the reference recording as submitted by the supplier. |
Music Metadata Object Examples
"metadata": {
"ContentCategory": "Music",
"Title": "SONG TITLE",
"Artist": "SONG ARTIST",
"ISRC": "XXXX00000000",
"Label": "SONG LABEL",
"Vendor": "SONG VENDOR",
"AlbumReleaseDate": "01-Jan-1900",
"AlbumUPC": "0000000000000",
"SongLengthInSeconds": "299"
}
TV/Film Metadata Object Definitions
| Field | Value | Description |
| ContentCategory | String | The type of content that was matched. |
| Title | String | The title of the reference material given by the content supplier. |
| Studio | String | The film studio associated with the reference material. |
| Vendor | String | The supplier of the reference material. |
TV/Film Metadata Object Examples
"metadata": {
"ContentCategory": "Soundtrack",
"Title": "VIDEO TITLE",
"Studio": "VIDEO STUDIO",
"Vendor": "VIDEO VENDOR"
}
Full Examples
Below is an example of a Compliance Identification Response of a single music match.
{
"statusCode": 2006,
"statusDescription": "Status 2006 (2006) Match found",
"unknownAssetID": "297J93",
"unknownMediaFileDuration": 278.1,
"matches": [
{
"ruleCode": "block",
"matchType": "audio",
"amItemID": "b3f66873c09b49bfaec9d69d21a76949_RGUa00",
"matchTimeInUnknown": 0.500,
"matchDurationInUnknown": 33.000,
"matchTimeInReference": 0.600,
"metadata": {
"ContentCategory": "Music",
"Title": "SONG TITLE",
"Artist": "SONG ARTIST",
"ISRC": "XXXX00000000",
"Label": "SONG LABEL",
"Vendor": "SONG VENDOR",
"AlbumReleaseDate": "01-Jan-1900",
"AlbumUPC": "0000000000000",
"SongLengthInSeconds": "299"
}
}
]
}
Below is an example of a Compliance Identification Response of a single tv/film match.
{
"statusCode": 2006,
"statusDescription": "Status 2006 (2006) Match found",
"unknownAssetID": "297J93",
"unknownMediaFileDuration": 278.1,
"matches": [
{
"ruleCode": "block",
"matchType": "audio",
"amItemID": "b3f66873c09b49bfaec9d69d21a76949_ZRCa00",
"matchTimeInUnknown": 0.500,
"matchDurationInUnknown": 33.000,
"matchTimeInReference": 0.600,
"metadata": {
"ContentCategory": "Soundtrack",
"Title": "VIDEO TITLE",
"Studio": "VIDEO STUDIO",
"Vendor": "VIDEO VENDOR"
}
}
]
}
Both types of matches (music and tv/film) could be included in a single Compliance Identification Response such as below.
{
"statusCode": 2006,
"statusDescription": "Status 2006 (2006) Match found",
"unknownAssetID": "MyMovie",
"unknownMediaFileDuration": 7805.3,
"matches": [
{
"ruleCode": "block",
"matchType": "audio",
"amItemID": "03cd6d988a344f588468924c757e0f0d_RGUa00",
"matchTimeInUnknown": 7439.000,
"matchDurationInUnknown": 197.000,
"matchTimeInReference": 8.300,
"metadata": {
"ContentCategory": "Music",
"Title": "SONG TITLE",
"Artist": "SONG ARTIST",
"ISRC": "XXXX00000000",
"Vendor": "SONG VENDOR",
"AlbumReleaseDate": "01-Jan-1900",
"AlbumUPC": "0000000000000",
"SongLengthInSeconds": "213"
}
},
{
"ruleCode": "block",
"matchType": "audio",
"amItemID": "36494ee0a4a44374b8f665b93fa5ca33_GFGa00",
"matchTimeInUnknown": 1717.000,
"matchDurationInUnknown": 20.000,
"matchTimeInReference": 699.083,
"metadata": {
"ContentCategory": "Soundtrack",
"Title": "VIDEO TITLE",
"Studio": "VIDEO STUDIO",
"Vendor": "VIDEO VENDOR"
}
}
]
}