Configure your transcript, audio description, and other settings at 3Play Media
Configurations can be applied at the project, batch, or media file
Configurations are returned as an array of objects with the following attributes:
| Name | Type | Description |
|---|---|---|
name |
String | Configuration name |
category |
String | Configuration category |
value |
* | Configuration value |
resource |
String | Which resource is assigned to this configuration. Configurations are inherited from their parent resources (e.g. Project) unless set at a more specific level. "Default" means no value is set and your project is using the default value for this configuration. |
You may view or set confiurations by issuing a GET or POST request, respectively, to the path /configuration nested under the desired resource. For example, to set the speaker label setting a batch with id 1234 to the value "Entertainment and Media", you would issue:
POST https://api.3playmedia.com/v3/batches/1234/configuration?speaker_identification=Entertainment+and+Media
The following additional configurations are supported, and multiple configurations can be set in a single call. Note that values must be URI-encoded (e.g. Clean%20Read or Clean+Read) and are case sensitive.
| Parameter | Type | Description | Required | Default |
|---|---|---|---|---|
flag_settings |
String | "Standard" to allow flags & uncertain terms to be marked with [? ?] or "Clean" to resolve all flags | No | no default |
transcript_style |
String | "Clean Read", "Verbatim", or "Verbatim Light" | No | no default |
speaker_identification |
String | Speaker identification setting | No | no default |
transcription_category |
String | "Default", "Math", "Financial", or "Entertainment and Media" | No | no default |
audio_description_speaker |
Speaker | Speaker name for Audio Description voice synthesis | No | no default |
audio_description_speaking_rate |
Integer | Speaking rate, in words per minute, for Audio Description voice synthesis | No | no default |
starting_timecode |
String | hh:mm:ss:ms | No | no default |
dropframe |
Boolean | Are captions encoded with dropframe timing? | No | no default |
frame_rate_from_header |
Boolean | Should the frame rate be inferred from the source file header? | No | no default |
fps |
Float | Manually set the frame rate for your source file | No | no default |
alignment_review_mode |
String | (Alignment service only) "Thresholded", "Off", or "On" to determine how to handle possibly suspect automated alignment | No | no default |
encoded_captions_single_line |
Boolean | (Caption encoding only) Should encoded captions be displayed on a single line only? | No | no default |
encoded_captions_font_size |
Integer | (Caption encoding: open captions only) Font size for encoded captions | No | no default |