Use the /sapi/audiotrack endpoint to manage audio tracks. Audio tracks can be used to enrich a mediaclip with additional (mostly language-specific) audio source tracks and cannot be used stand-alone.
Audio tracks may not be part of your Online Video Platform license. Contact support@bluebillywig.com for more details.
1.0 | Audio Track Object
1.1 | Example Audio Track Object
{
"id": "7",
"publicationid": "325",
"type": "AudioTrack",
"status": "published",
"createddate": "2016-01-07T15:58:16Z",
"updateddate": "2016-01-07T15:58:22Z",
"languageid": 669,
"mediaclipid": "2575390",
"src": "/media/2024/01/02/d1b8c2e6a6205d4af2e686a04496e540/visual-description.mp3",
"exactlength": "65123",
"isocode": "en",
"name": "English",
"IsDefaultLanguage": false
}1.2 | Attributes
| Parameter | Description |
|---|---|
| id | (string) Unique identifier of the audio track. Read-only. |
| publicationid | (string) Unique identifier of the publication. Read-only. |
| type | (string) Type of object: “AudioTrack”. Read-only. |
| status | (string) “draft” or “published”. If an audio track is published it will be publicly available. |
| createddate | (string) ISO 8601 date/time the audio track was created. Read-only. |
| updateddate | (string) ISO 8601 date/time the audio track was last updated. Read-only. |
| languageid | (integer) Unique identifier of the configured language in the publication. Read-only. |
| mediaclipid | (string) Identifier of the mediaclip this audio track is attached to. Read-only. |
| src | (string) Path of the audio track source file. Read-only. |
| exactlength | (string) Exact length of the audio track in milliseconds. Read-only. |
| isocode | (string) Two-letter ISO 639 language code. Read-only. |
| name | (string) Language name. Read-only. |
| IsDefaultLanguage | (boolean) true when the language is the publication’s default language. Read-only. |
| originalfilename | (string) Original filename of the uploaded file. |
| remotesrc | (string) Raw upload path of the source file on the server. Set automatically after upload. Read-only. |
| createdBy | (string) Email address of the user who created the audio track. Read-only. |
| updatedBy | (string) Email address of the user who last updated the audio track. Read-only. |
| label | (string) Display label for the audio track. Distinct from name, which is derived from the language entity. |
| subtype | (string) “audiotrack” or “audiodescription”. Use “audiodescription” for accessibility-oriented audio description tracks. Defaults to “audiotrack”. |
| uri | (string) Download URI for the audio track, generated server-side from remotesrc. Read-only. |
| publisheddate | (string) ISO 8601 date/time the audio track was published. Optional. |
2.0 | Create/Update
Example request payload:
{
"isocode": "en",
"languageid": "669",
"mediaclipid": "1082434",
"originalfilename": "1162240_uhq.mp4",
"status": "published",
"uploadIdentifier": "f1afb28a8b2c227e87dd983da91a4a1d"
}uploadIdentifier points to a completed AWS S3 upload (see /sapi/awsupload). The upload can be an audio file or a video file; if a video file is provided, the audio track will be extracted automatically. mediaclipid is the identifier of the mediaclip this audio track should be linked to.
Example response:
{
"IsDefaultLanguage": true,
"createdBy": "support@bluebillywig.com",
"createddate": "2023-08-10T08:57:17Z",
"exactlength": "45276",
"id": "186",
"isocode": "en",
"languageid": 1,
"mediaclipid": "1082434",
"name": "English",
"originalfilename": "1162240_uhq.mp4",
"publicationid": "1",
"remotesrc": "/upload/yourcompanyname/2023/08/10/f1afb28a8b2c227e87dd981a41d.mp4",
"status": "published",
"type": "AudioTrack",
"updatedBy": "support@bluebillywig.com",
"updateddate": "2023-08-10T08:57:17Z"
}After the PUT request, transcoding starts automatically. The newly created audio track will be available within minutes.
3.0 | Retrieve
Retrieves an audio track object.
4.0 | Delete
Deletes an audio track object. This permanently removes the audio track and its association with the mediaclip.