/sapi/audiotrack


The /sapi/audiotrack endpoint is used for managing Audiotracks. Audiotracks can be used to enrich a Media Clip with additional (mostly language-specific) audio source tracks. They can not be used stand-alone. Audio tracks may not be part of your Online Video Platform license. Contact support for more details.

1.0 | Object structure

{
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/2016/01/07/d1b8c2e6a6205d4af2e686a04496e540/alt-audio.mp3",
exactlength: "65123 ",
isocode: "en",
name: "English",
IsDefaultLanguage: false
}

In the example code, an Audiotrack JSON representation is shown. It refers a Language entity (id: 669, isocode en, name “English”) and contains an audio track URI (to an mp3 file). For more info on the Language entity see /sapi/language endpoint.

2.0 | Create/Update

PUT /sapi/audiotrack

Example payload:

{id:-1
isocode:"en"
languageid:1
mediaclipid:"1082434"
originalfilename:"1162240_uhq.mp4"
status:"published"
uploadIdentifier:"f1afb28a8b2c227e87dd983da91a4a1d"
}

Where uploadIdentifier points to a requested and executed AWS S3 upload (see /sapi/awsupload). The upload can be an audio file or a video file (the audio track will be extracted in that case). Mediaclipid is the id of the Media Clip this audio track should be related to.

Example response:

{
IsDefaultLanguage:true
createdBy:"support@bluebillywig.com"
createddate:"2018-08-10T08:57:17Z"
exactlength:"45276"
id:"186"
isocode:"en"
languageid:1
mediaclipid:"1082434"
name:"English"
originalfilename:"1162240_uhq.mp4"
publicationid:"1"
remotesrc:"eu-vms-dev-storage/upload/bb.dev/2018/08/10/f1afb28a8b2c227e87dd983da91a4a1d/f1afb28a8b2c227e87dd983da91a4a1d.mp4"
status:"published"
type:"AudioTrack"
updatedBy:"support@bluebillywig.com"
updateddate:"2018-08-10T08:57:17Z"
}

After the PUT request transcoding will automatically be started. The newly created Audiotrack will be available via the player within minutes.

3.0 | Retrieve

GET /sapi/audiotrack/ID

Retrieves an audio track JSON representation by ID.

4.0 | Delete

DELETE /sapi/audiotrack/ID

Remove an Audiotrack by ID.

This permanently removes an Audiotrack and its relation to the Media Clip.

Was this article helpful?

Related Articles

Contact Support
Can't find the answer you're looking for?
Contact Support