Basic Usage¶

Core Functionality¶

Authenticate¶

The first step is to initialize the SDK client with the credentials that have been provided to you:

Info

Note: If you are both a Search: Vobile Music Registry and Search: Custom Database customer, each product will require a separate set of credentials.

PythonGoPHPNode.js

# AUTHENTICATE CLIENT
client = pex.PexSearchClient("CLIENT_ID", "CLIENT_SECRET")

// AUTHENTICATE CLIENT
client, err := pex.NewPexSearchClient("clientID", "clientSecret")
if err != nil {
    panic(err)
}
defer client.Close()

// AUTHENTICATE CLIENT
$client = new Pex\PexSearchClient(CLIENT_ID, CLIENT_SECRET);

// AUTHENTICATE CLIENT
let client = new pex.PexSearchClient(CLIENT_ID, CLIENT_SECRET)
await client.connect()

Info

Note: There might be a slight delay the first time you authenticate as the SDK downloads and installs necessary updates

Generate Fingerprint¶

Before performing any searches you need to generate a fingerprint from a media file:

PythonGoPHPNode.js

# CREATE AN AUDIO FINGERPRINT FROM MEDIA FILE
ft = client.fingerprint_file(
    "/path/to/file.mp3",
    pex.FingerprintType.AUDIO
)

# CREATE A MELODY + PHONETIC FINGERPRINT FROM MEDIA FILE
ft = client.fingerprint_file(
    "/path/to/file.mp3",
    pex.FingerprintType.MELODY | pex.FingerprintType.PHONETIC
)

# CREATE A CLASSIFICATION FINGERPRINT FROM MEDIA FILE
ft = client.fingerprint_file(
    "/path/to/file.mp3",
    pex.FingerprintType.CLASSIFICATION
)

// CREATE AN AUDIO FINGERPRINT FROM MEDIA FILE
ft, err := client.FingerprintFile(
    inputFile,
    pex.FingerprintTypeAudio,
)

// CREATE A MELODY + PHONETIC FINGERPRINT FROM MEDIA FILE
ft, err := client.FingerprintFile(
    inputFile,
    pex.FingerprintTypeMelody|pex.FingerprintTypePhonetic,
)

// CREATE A CLASSIFICATION FINGERPRINT FROM MEDIA FILE
ft, err := client.FingerprintFile(
    inputFile,
    pex.FingerprintTypeClassification,
)

// CREATE AN AUDIO FINGERPRINT FROM MEDIA FILE
$ft = $client->fingerprintFile(
    INPUT_FILE,
    [Pex\FingerprintType::Audio]
);

// CREATE A MELODY + PHONETIC FINGERPRINT FROM MEDIA FILE
$ft = $client->fingerprintFile(
    INPUT_FILE,
    [Pex\FingerprintType::Melody, Pex\FingerprintType::Phonetic]
);

// CREATE A CLASSIFICATION FINGERPRINT FROM MEDIA FILE
$ft = $client->fingerprintFile(
    INPUT_FILE,
    [Pex\FingerprintType::Classification]
);

// CREATE AN AUDIO FINGERPRINT FROM MEDIA FILE
let ft = await client.fingerprintFile(
  "video.mp4",
  [pex.AUDIO]
);

// CREATE A MELODY + PHONETIC FINGERPRINT FROM MEDIA FILE
let ft = await client.fingerprintFile(
  "video.mp4",
  [pex.MELODY, pex.PHONETIC]
);

// CREATE A CLASSIFICATION FINGERPRINT FROM MEDIA FILE
let ft = await client.fingerprintFile(
  "video.mp4",
  [pex.CLASSIFICATION]
);

Alternatively, a fingeprint can be created from a byte buffer holding a media file

PythonGoPHPNode.js

# CREATE AN AUDIO FINGERPRINT FROM BYTE BUFFER HOLDING A MEDIA FILE
ft = client.fingerprint_buffer([]byte, pex.FingerprintType.AUDIO)

// CREATE AUDIO FINGERPRINT FROM BYTE BUFFER HOLDING A MEDIA FILE
buf := []byte{ /* media bytes */ }
ft, err = client.FingerprintBuffer(buf, pex.FingerprintTypeAudio)
if err != nil {
    panic(err)
}

// CREATE AUDIO FINGERPRINT FROM BYTE BUFFER HOLDING A MEDIA FILE
$buffer = /* binary audio data */;
$ft = $client->fingerprintBuffer(
    $buffer,
    [Pex\FingerprintType::Audio]
);

// CREATE AUDIO FINGERPRINT FROM BYTE BUFFER HOLDING A MEDIA FILE
const buffer = Buffer.from(/* binary data here */);
let ft = await client.fingerprintBuffer(
  buffer,
  [pex.AUDIO]
);

Info

Note: When creating audio fingerprints, the SDK uses a single CPU. For melody fingerprints, the SDK uses two CPUs, if available.

If you need to process larger volumes of files, running computations in parallel is recommended. This can significantly improve processing capacity.

Search Functionality¶

Initiate Search (With Fingerprint)¶

Once the fingerprint has been generated, you are ready to initiate a search:

PythonGoPHPNode.js

# BUILD REQUEST FOR "IDENTIFY MUSIC" SEARCH TYPE
req = pex.PexSearchRequest(fingerprint=ft, type=pex.PexSearchType.IDENTIFY_MUSIC)

# BUILD REQUEST FOR "FIND MATCHES" SEARCH TYPE
req = pex.PexSearchRequest(fingerprint=ft, type=pex.PexSearchType.FIND_MATCHES)

# START SEARCH
future = client.start_search(req)

// BUILD REQUEST FOR "IDENTIFY MUSIC" SEARCH TYPE
req := &pex.PexSearchRequest{
    Fingerprint: ft,
    Type:        pex.IdentifyMusic,
}

// BUILD REQUEST FOR "FIND MATCHES" SEARCH TYPE
req := &pex.PexSearchRequest{
    Fingerprint: ft,
    Type:        pex.FindMatches,
}

// START SEARCH
fut, err := client.StartSearch(req)
if err != nil {
    panic(err)
}

// BUILD REQUEST FOR "IDENTIFY MUSIC" SEARCH TYPE
$req = new Pex\PexSearchRequest($ft, Pex\PexSearchType::IdentifyMusic);

// BUILD REQUEST FOR "FIND MATCHES" SEARCH TYPE
$req = new Pex\PexSearchRequest($ft, Pex\PexSearchType::FindMatches);

// START SEARCH
$fut = $client->startSearch($req);

// START SEARCH FOR "IDENTIFY MUSIC" SEARCH TYPE
let result = await client.startSearch({
  "fingerprint": ft,
  "type": pex.IDENTIFY_MUSIC,
})

// START SEARCH FOR "FIND MATCHES" SEARCH TYPE
let result = await client.startSearch({
  "fingerprint": ft,
  "type": pex.FIND_MATCHES,
})

Info

A search combines a fingerprint type (how your file is analyzed) with a search type (what kind of lookup is performed). The combination you choose determines the results you’ll see. Refer to Search Types & Use Cases for examples of common use cases and suggested combinations.

Initiate Search (With ISRC)¶

If you know the ISRC of the query file you would like to search with, you can prepare a search with the ISRC instead of a fingerprint. If a corresponding asset is found associated with the ISRC, the search will initiate as usual.

PythonGoPHPNode.js

# BUILD THE ISRC SEARCH REQUEST
req = pex.ISRCSearchRequest(
    isrc="12345",
    ft_types=
        pex.FingerprintType.AUDIO,
    type=pex.PexSearchType.FIND_MATCHES,
)

# START SEARCH
future = client.start_isrc_search(req)

// BUILD THE ISRC SEARCH REQUEST
req := &pex.ISRCSearchRequest{
    ISRC: "12345",
    FingerprintTypes: []pex.FingerprintType{
        pex.FingerprintTypeAudio,
    },
    Type: pex.FindMatches,
}

// START SEARCH
fut, err := client.StartISRCSearch(req)
if err != nil {
    panic(err)
}

// BUILD THE ISRC SEARCH REQUEST
$req = new Pex\ISRCSearchRequest(
    "12345",
    [
        Pex\FingerprintType::Audio,
    ],
    Pex\PexSearchType::FindMatches
);

// START SEARCH
$fut = $client->startISRCSearch($req);

// START SEARCH
let result = await client.startISRCSearch({
  isrc: "12345",
  fingerprintTypes: [
    pex.AUDIO,
  ],
  type: pex.FIND_MATCHES,
});

Info

If a corresponding asset cannot be resolved with the provided ISRC, the SDK returns a NOT_FOUND error (for example: NOT_FOUND: isrc not found). In this case, the request is rejected and no search is started. Your application should catch/handle this error and decide whether to prompt for a different ISRC, skip the lookup request, or log/report the failure

Retrieve Search Results¶

Once a search is complete, you can retrieve the results of the search:

PythonGoPHPNode.js

# RETRIEVE SEARCH RESULTS
result = future.get()

// RETRIEVE SEARCH RESULTS
res, err := fut.Get()
if err != nil {
    panic(err)
}

// RETRIEVE SEARCH RESULTS
$res = $fut->get();

// THE STARTSEARCH FUNCTION DESCRIBED IN THE PREVIOUS SECTION WILL AUTOMATICALLY RETRIEVE THE RESULTS WHEN THE SEARCH IS COMPLETED

Interpret Search Results¶

To view details on what's contained in a search response, please see the following section: Search Response