Reach integration docs

Adding audio flavors for dubbing and standard audio descriptions

Last Modified on 09/16/2024 11:59 am IDT

In this article we provide examples of calls and responses relative to Dubbing and Standard Audio Descriptions in Reach integration flows.

Retrieving a dubbing task

Example of a response after requesting a task with the REACH profile information for a dubbing task using entryVendorTask.get - Kaltura VPaaS API Documentation: 

{  "id": "362793222",  "partnerId": 5486112,  "vendorPartnerId": 5484572,  "createdAt": 1692356225,  "entryId": "1_eyl6k4e0",  "status": 1,  "reachProfileId": 251412,  "catalogItemId": 20642,  "accessKey": "djJ8NTQ4NjExMnxQPdYOSoukgEKllfQbTEJ0BAoOX2YXFxqI3PZuDNeUjb9wNmfipxuZ7nc_WelCQnFDj2HLffcoQJoLOyIKpEfAB7RBVoIBDUl5DppUBMDzka195vFxhWFwTzzuG8WBWdQXjLejhHUgSEXTdYThkwMAQA3g4L-oPmJ_75pxj3q9CX5rCgAuwcnUmeCOWEOjPTytaYl5QpK8q_EFciffq04c-67IBD05ve2GxDwsjBTNWQ==",  "version": 11,  "relatedObjects": {
    "reach_vendor_catalog_item": {
      "objects": [
        {
          "flavorParamsId": 0,
          "clearAudioFlavorParamsId": 0,
          "targetLanguage": "French",
          "serviceType": 1,
          "serviceFeature": 7,
          "turnAroundTime": -1,
          "engineType": "OpenCalaisReachVendor.OPEN_CALAIS",
          "sourceLanguage": "English",
          "allowResubmission": false,
          "objectType": "KalturaVendorDubbingCatalogItem"
        }
      ],
      "totalCount": 1,
      "objectType": "KalturaVendorCatalogItemListResponse"
    },
    "reach_vendor_profile": {
      "objects": [
        {
          "name": "Reach test",
          "defaultOutputFormat": 1,
          "enableMetadataExtraction": true,
          "enableSpeakerChangeIndication": false,
          "enableAudioTags": false,
          "enableProfanityRemoval": true,
          "maxCharactersPerCaptionLine": 26,
          "labelAdditionForMachineServiceType": "",
          "labelAdditionForHumanServiceType": "",
          "contentDeletionPolicy": 2,
          "flavorParamsIds": "",
          "vendorTaskProcessingRegion": 1,
          "objectType": "KalturaReachProfile"
        }
      ],
      "totalCount": 1,
      "objectType": "KalturaReachProfileListResponse"
    }  },  "objectType": "KalturaEntryVendorTask"
}


Retrieving a standard audio description task

Example of a response after requesting a task with the REACH profile information for a standard audio description task using entryVendorTask.get - Kaltura VPaaS API Documentation: 

{
  "relatedObjects": {
    "reach_vendor_catalog_item": {
      "totalCount": 1,
      "objects": [
        {
          "serviceType": 1,
          "serviceFeature": 4,
          "turnAroundTime": -1,
          "engineType": "OpenCalaisReachVendor.OPEN_CALAIS",
          "sourceLanguage": "English",
          "allowResubmission": false,
          "stage": 2,
          "lastBulkUpdateId": 28823492582,
          "flavorParamsId": 200,
          "clearAudioFlavorParamsId": 2916682,
          "objectType": "KalturaVendorAudioDescriptionCatalogItem"
        }
      ],
      "objectType": "KalturaVendorCatalogItemListResponse"
    },
    "reach_vendor_profile": {
      "totalCount": 1,
      "objects": [
        {
          "name": "Test REACH profile - EU Region",
          "defaultOutputFormat": 1,
          "enableMetadataExtraction": true,
          "enableSpeakerChangeIndication": true,
          "enableAudioTags": true,
          "enableProfanityRemoval": true,
          "maxCharactersPerCaptionLine": 26,
          "labelAdditionForMachineServiceType": "",
          "labelAdditionForHumanServiceType": "",
          "contentDeletionPolicy": 2,
          "flavorParamsIds": "",
          "vendorTaskProcessingRegion": 2,
          "objectType": "KalturaReachProfile"
        }
      ],
      "objectType": "KalturaReachProfileListResponse"
    }
  },
  "id": "459969843",
  "partnerId": 5112737,
  "vendorPartnerId": 3112202,
  "createdAt": 1726242819,
  "entryId": "1_r96yytud",
  "status": 1,
  "reachProfileId": 212362,
  "catalogItemId": 14212,
  "accessKey": "djJ3NTE2MnczMnynFqjGj1qSPXtEERbhrDe1obrEp-DbWljOT__142FXbcXeKecc2eYj8q4kY9rd3wlhqibeEnfWMmaitmD_W3U6E3YGjTaIp4EzaFmCGyIDEDrl6l3oRAno_KLtcCfCdYJ-mgOWaFQAD2A52pK32h1nex4ZTgaTXk5wEvVtVwewRtskHnX10Tgfp2MD-yLFPue21pnrMiV8XFdYOoEqtMYYHaJZXNZ4M4Y_maFpTPKBoA==",
  "version": 11,
  "objectType": "KalturaEntryVendorTask"
}


Retrieving catalog item details for a dubbing task

Example of a response after requesting catalog item details for a dubbing task using vendorCatalogItem.get - Kaltura VPaaS API Documentation:

{
  "flavorParamsId": 0,
  "clearAudioFlavorParamsId": 0,
  "targetLanguage": "French",
  "id": 20642,
  "vendorPartnerId": 5484572,
  "name": "Dubbing test",
  "systemName": "Dubbing test",
  "createdAt": 1692356002,
  "updatedAt": 1692356002,
  "status": 2,
  "serviceType": 1,
  "serviceFeature": 7,
  "turnAroundTime": -1,
  "pricing": {
    "pricePerUnit": 0,
    "priceFunction": "kReachUtils::calcPricePerMinute",
    "objectType": "KalturaVendorCatalogItemPricing"
  },
  "engineType": "OpenCalaisReachVendor.OPEN_CALAIS",
  "sourceLanguage": "English",
  "allowResubmission": false,
  "objectType": "KalturaVendorDubbingCatalogItem"
}


Delivering a new audio track - Creating a new flavorAsset

Example of an API call to create a flavorAsset using flavorAsset.add - Kaltura VPaaS API Documentation:

curl -X POST https://www.kaltura.com/api_v3/service/flavorasset/action/add \
    -d "ks=$KALTURA_SESSION" \
    -d "entryId=1_eyl6k4e0" \
    -d "flavorAsset[objectType]=KalturaFlavorAsset" \
    -d "flavorAsset[flavorParamsId]=0" \
    -d "flavorAsset[isDefault]=0" \
    -d "flavorAsset[language]=English" \
    -d "flavorAsset[isOriginal]=false"


 

Upload the audio track

Example of an API call to transfer the flavor asset file to Kaltura using flavorAsset.setContent - Kaltura VPaaS API Documentation:

curl -X POST https://www.kaltura.com/api_v3/service/flavorasset/action/setContent \
    -d "ks=$KALTURA_SESSION" \
    -d "id=1_eyl6k4e0" \
    -d "contentResource[objectType]=KalturaUrlResource" \
    -d "contentResource[forceAsyncDownload]=false" \
    -d "contentResource[url]=https%3A%2F%2Fwww.vendor.com%2Fdeliverable_to_upload.mp4"


What a Standard Audio description flavor looks like

Example of a Standard Audio description flavor asset after it is added to Kaltura:

{
  "id": "1_op9kqn3n",
  "entryId": "1_szti2yam",
  "partnerId": 3162135,
  "version": "1",
  "size": 927,
  "tags": "mobile,web,mbr,iphone,audio_only,alt_audio,audio_description",
  "fileExt": "mp4",
  "createdAt": 1726250503,
  "updatedAt": 1726250519,
  "description": "",
  "sizeInBytes": "949424",
  "flavorParamsId": 200,
  "width": 0,
  "height": 0,
  "bitrate": 126,
  "frameRate": 0,
  "isOriginal": false,
  "isWeb": true,
  "containerFormat": "isom",
  "status": 2,
  "language": "English",
  "label": "English - Audio Description",
  "isDefault": false,
  "objectType": "KalturaFlavorAsset"
}


Related Articles
Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted.

In This Article
Back to top

Never miss a thing!

Subscribe to our customer newsletter and our release notes updates, so you always get the best out of Kaltura.
Newsletter