3Play Media: Docs

Audio Description

Order and view audio descriptions for your videos at 3Play Media

Object Representation

Unless otherwise specified, all routes return the following data structure in the data key.

Name Type Description
id Integer ID of your audio description
media_file_id Integer ID of the 3Play Media file that your audio description belongs to
batch_id Integer ID of the batch the audio description belongs to
reference_id String Custom / Reference ID of the media_file the audio description belongs to
duration Float File duration, in seconds
status String Status of description
extended Boolean Extended description allows you to fit more descriptive content in a video that may not have sufficient audio gaps to fit the content
speaker_name String Which voice is used to synthesize the descriptive content
speaking_rate String Speed (words per minute) of the synthesized speec

Actions

  • List audio descriptions in your project

    GET https://api.3playmedia.com/v3/audio_descriptions/

    Parameter Type Description Required Default
    id Integer or Array<Integer> Filter audio descriptions by id(s) No no default
    media_file_id Integer or Array<Integer> Filter audio descriptions by media file id(s) No no default
    extended Boolean Filter audio descriptions by extended setting No no default
    status Boolean Filter audio descriptions by status No no default
    media_file_name String Filter by media file name No no default
    media_file_attribute1 String Filter by media file attribute1 No no default
    media_file_attribute2 String Filter by media file attribute2 No no default
    media_file_attribute3 String Filter by media file attribute3 No no default
    media_file_batch_id Integer Filter by media file batch_id No no default
    media_file_reference_id String Filter by media file reference_id No no default
    media_file_label String or Array<String> Filter by media file label(s) No no default
    media_file_created_before Datetime Filter by media file created_before No no default
    media_file_created_after Datetime Filter by media file created_after No no default
    media_file_archived Boolean Filter by media file archived No true
  • Show a specific audio description

    GET https://api.3playmedia.com/v3/audio_descriptions/:id

  • Order audio description

    POST https://api.3playmedia.com/v3/audio_descriptions/order

    Parameter Type Description Required Default
    media_file_id Integer ID of the media file for which you wish to order audio description Yes no default
    extended String Use extended audio description, in which more descriptive content may be added that pauses the source material. Values: ["true", "false", "auto"] No false
    turnaround_level_id Integer The id of the 3Play turnaround level you wish to order. No 7
    callback String Callback URL for status updates No no default
  • Upgrade an audio description's turnaround level

    POST https://api.3playmedia.com/v3/audio_descriptions/:id/upgrade_turnaround_level

    Parameter Type Description Required Default
    turnaround_level_id Integer The ID of the 3Play turnaround level you wish to upgrade to Yes no default
  • Send an immediate callback to any registered callback URLs (see Delivery Routes)

    POST https://api.3playmedia.com/v3/audio_descriptions/:id/callback

    • (Note: The callback payload sent to the URL will be the audio description object representation, in application/x-www-form-urlencoded format.)

  • Re-deliver audio description to pre-assigned endpoint (e.g. 3rd party integrations, FTP locations)

    POST https://api.3playmedia.com/v3/audio_descriptions/:id/redeliver

  • Cancel audio description

    POST https://api.3playmedia.com/v3/audio_descriptions/:id/cancel

  • Download audio description media (description and source mixed)

    GET https://api.3playmedia.com/v3/audio_descriptions/:id/mix

    Parameter Type Description Required Default
    format String File format. Values: ["yt-mkv", "mp4", "wav", "ogg", "mp3"] Yes no default

    • (Note: This request returns a payload with an expiring S3 link in the "data" field. Applications should then issue a GET on this URL to obtain the media file data.)

  • Download audio description audio only (no source audio or video)

    GET https://api.3playmedia.com/v3/audio_descriptions/:id/audio

    Parameter Type Description Required Default
    format String File format. Values: ["wav", "ogg", "mp3"] Yes no default

    • (Note: This request returns a payload with an expiring S3 link in the "data" field. Applications should then issue a GET on this URL to obtain the audio file data.)

  • Download audio description text

    GET https://api.3playmedia.com/v3/audio_descriptions/:id/text

    Parameter Type Description Required Default
    output_format_id Integer Audio description text format id Yes no default

    • (Note: This request returns a payload with the "data" field containing a string comprising the output text.)

  • Download audio description text format directly

    GET https://api.3playmedia.com/v3/audio_descriptions/:id/text_download

    Parameter Type Description Required Default
    output_format_id Integer Audio description download format id Yes no default

    • (Note: This endpoint does not wrap the response in a JSON structure; the response body is comprised entirely of the audio description data.)

  • List audio description text formats

    GET https://api.3playmedia.com/v3/audio_descriptions/text_formats

  • List audio description text download formats

    GET https://api.3playmedia.com/v3/audio_descriptions/text_download_formats

  • List audio description mix formats

    GET https://api.3playmedia.com/v3/audio_descriptions/mix_formats

  • List audio description audio formats

    GET https://api.3playmedia.com/v3/audio_descriptions/audio_formats