Skip to content

Latest commit

 

History

History
86 lines (50 loc) · 3.38 KB

JobOptions.md

File metadata and controls

86 lines (50 loc) · 3.38 KB

JobOptions

Properties

Name Type Description Notes
customerApprovalSteps List<CustomerApprovalStepsEnum> Requires your approval of a job at specified points in the workflow. When the job is ready for approval you will be emailed a link that will take you to a web based tool you can use to view, edit and approve the job. You may request approval at two points in the workflow: before translation and before the job is returned. [optional]
customerApprovalTool CustomerApprovalToolEnum Determines which web based tool to use for viewing, editing and approving jobs. [optional]
customMetadata Object A JSON dictionary of key value pairs. These will be used as substitution strings when building the callback URL and custom DFXP caption header. [optional]
notes Object Allows you to provide text that will be displayed to the transcriber when the job is processed. An HTML included will be escaped. [optional]
returnIwp List<IWPEnum> Allows you to receive additional callbacks when interim versions of the job are completed. If you specified a callback_url, then a callback will sent for FINAL regardless of the value of this option. [optional]
generateMediaIntelligenceIwp List<IWPEnum> Requests that media intelligence be generated for the specified interim/final versions of the transcript. Media intelligence data is added to the ElementList and can be retrieve using the get_elementlist API call. See ElementList for details. [optional]
speakerId SpeakerIdEnum Requests that speaker names be identified. [optional]
audioDescription AudioDescriptionEnum Requests that all noises and sounds be identified. [optional]
onScreenText OnScreenTextEnum Requests that any text that appears in the media be added to the transcription. [optional]
musicLyrics MusicLyricsEnum Requests that lyrics to songs be transcribed instead of labeled [MUSIC]. [optional]
customSpecialHandling CustomSpecialHandlingEnum Requests that transcribers follow submitted instruction set. [optional]

Enum: List<CustomerApprovalStepsEnum>

Name Value
TRANSLATION "TRANSLATION"
RETURN "RETURN"

Enum: CustomerApprovalToolEnum

Name Value
AMARA "AMARA"
CIELO24 "CIELO24"

Enum: SpeakerIdEnum

Name Value
TRUE "true"
FALSE "false"

Enum: AudioDescriptionEnum

Name Value
TRUE "true"
FALSE "false"

Enum: OnScreenTextEnum

Name Value
TRUE "true"
FALSE "false"

Enum: MusicLyricsEnum

Name Value
TRUE "true"
FALSE "false"

Enum: CustomSpecialHandlingEnum

Name Value
TRUE "true"
FALSE "false"