Reading a RightsRX JSON Response

When utilizing the Audible Magic Toolkit and set up for RightsRx Identification Response, the following is what is included in the metadata response.

The RightsRx Identification Response details the default amount of information about a match that was found. This metadata response is utilized within Audible Magic's RightsRx product.

The RightsRx 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

Example
statusCode Integer An integer value that represents the outcome of the identification. 2006
statusDescription String A brief explanation of the status code. Status 2006 (2006) Match found
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. 297J93
unknownMediaFileDuration Number The duration of the media file in seconds that is attempting to be identified.  278.1
matches Array of match objects An array of match objects which depict what was matched in the media file. see Match Object

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 Example
ruleCode String What action to take (e.g. "Block", "Allow"). For identification responses, this can be ignored as it defaults to "notSubmitted". notSubmitted
matchType String What kind of reference fingerprint was matched (e.g. "audio", "video"). audio
amItemID String Audible Magic's internal content identifier for the matched reference. b3f66873c09b49bfaec9d69d21a76949_ZRCa00
matchTimeInUnknown Number The location in seconds of the start of the match in your media file. 0.500
matchDurationInUnknown Number The duration of the match in seconds. 33.000
matchTimeInReference Number The location of the start of the match in Audible Magic's reference media file. 0.600
metadata Object An object that depicts the metadata associated with the reference media file. see Metadata Object

Match Object Examples

"matches": [
{
"ruleCode": "notSubmitted",
"matchType": "audio",
"amItemID": "b3f66873c09b49bfaec9d69d21a76949_RGUa00",
"matchTimeInUnknown": 0.500,
"matchDurationInUnknown": 33.000,
"matchTimeInReference": 0.600,
"metadata": {
// omitted for brevity
}      
}
]

Metadata Object

Depending on the service that has been set up, either RightsRx or RightsRx+, the metadata object will show differing amounts of information.

RightsRx Metadata Object Definitions

Field Value Description Example
ContentCategory String The type of content that was matched. Music
Vendor String The supplier of the reference media file. Label Owner D

RightsRx Metadata Object Examples

"metadata": {
"ContentCategory": "Music",
"Vendor": "SONG VENDOR"
}

RightsRx+ Metadata Object Definitions

Field Value Description Example
ContentCategory String The type of content that was matched. Music
Title String The title of the reference given by the content supplier. Song Title A
Artist String The artist of the reference given by the content supplier. Artist Name B
ISRC String The International Standard Recording Code provided by the content supplier. XXXX00000000
Label String The label associated with the copyright holder. Label C
Vendor String The supplier of the reference media file. Label Owner D
AlbumReleaseDate String Then the album containing the reference material was released. 01-Jan-1990
AlbumUPC String The universal product code of the album that the reference material was released on.

1234567891011

SongLengthInSeconds String The length of the reference recording as submitted by the supplier. 299

RightsRx+ Metadata Object Examples

"metadata": {
   "ContentCategory": "Music",
   "Title": "Song Title A",
   "Artist": "Artist Name B",
   "ISRC": "XXXX00000000",
   "Label": "Label C",
   "Vendor": "Label Owner D",
   "AlbumReleaseDate": "01-Jan-1900",
   "AlbumUPC": "1234567891011",
   "SongLengthInSeconds": "299"
}

Full Examples

Below is an example of a RightsRx Identification Response of a single music match.

{
   "statusCode": 2006,
   "statusDescription": "Status 2006 (2006) Match found",
   "unknownAssetID": "297J93",
   "unknownMediaFileDuration": 278.1,
   "matches": [
       {
           "ruleCode": "notSubmitted",
           "matchType": "audio",
           "amItemID": "b3f66873c09b49bfaec9d69d21a76949_RGUa00",
           "matchTimeInUnknown": 0.500,
           "matchDurationInUnknown": 33.000,
           "matchTimeInReference": 0.600,
           "metadata": {
               "ContentCategory": "Music",
               "Vendor": "SONG VENDOR"
           }        
       }
   ]
}

Below is an example of a RightsRx+ Identification Response of a single music match.

{
   "statusCode": 2006,
   "statusDescription": "Status 2006 (2006) Match found",
   "unknownAssetID": "297J93",
   "unknownMediaFileDuration": 278.1,
   "matches": [
       {
           "ruleCode": "notSubmitted",
           "matchType": "audio",
           "amItemID": "b3f66873c09b49bfaec9d69d21a76949_RGUa00",
           "matchTimeInUnknown": 0.500,
           "matchDurationInUnknown": 33.000,
           "matchTimeInReference": 0.600,
           "metadata": {
               "ContentCategory": "Music",
               "Title": "Song Title A",
               "Artist": "Artist Name B",
               "ISRC": "XXXX00000000",
               "Label": "Label C",
               "Vendor": "Label Owner D",
               "AlbumReleaseDate": "01-Jan-1900",
               "AlbumUPC": "1234567891011",
               "SongLengthInSeconds": "299"
           }
       }
   ]
}

If you're interested in purchasing our Identification Solutions click here and select Content Identification under Products/Services.