Order Live Professional Captioning

post

https://api.3playmedia.com/v3/live_professional_captions/order

Order new live professional captioning

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

media_file_id

integer

required

ID of the media file on which to order live professional captioning

start_time

string

required

Time at which the live event begins

estimated_duration

integer

required

Estimated duration of the live event in milliseconds. Must be greater than 0 seconds.

captioner_join_time

string

required

Time at which the captioner will access the event audio

event_wait_time

integer

required

Amount of time (in minutes) after start_time our system waits before failing the event if no audio is detected

event_max_time

integer

required

Maximum time (in minutes) of captioning event, including breaks and delays. Event is auto-finished at this time if not finished sooner.

has_live_stream

boolean

required

Defaults to true

Whether the event has an automatically accessible source stream.

Note: If 'has_live_stream' is false, a 3Play professional captioner must have direct access to your event (e.g. from a meeting platform URL provided in the 'additional_instructions' field). Events that do not have a source stream can only be captioned professionally; automated captioning fallback is unavailable

static_embed_key_code

string

A static, alphanumeric embed key so multiple events utilize the same Caption URL webpage

stream_url

string

Stream URL the live stream consumes. Must begin with 'rtmp'.

Note: Some RTMP streams require a 'stream key'. This should be included in the stream_url. For example: 'rtmp://foo.bar.com/fgHJKlmn', where 'fgHJKlmn' is the key.

Note: If the media_file is configured to use a reserved transcoder, it will overwrite the value passed for stream_url.

Note: If the media_file is not configured to use a reserved transcoder and a stream_url is not passed, threeplay will provision a transcoder for you.

transcoder_id

integer

ID of the reserved transcoder / stream_target to use. Note: transcoder_id will take precendence over default configured reserved transcoders.

latency

integer

Target delay (in milliseconds) before the live captions are available. More delay generally allows increased accuracy.

offensive_words_sensitivity

integer

enum

Sensitivity for eliding words. Higher is more sensitive.

Allowed:

stream_reconnection_wait_time

integer

How long (in minutes) 3Play waits before ending the event if your stream disconnects. Once disconnected, you cannot reconnect to this event and must schedule a new event in 3Play to continue captions.

record_stream

boolean

Whether to save the live stream as the media file's source after the event. Used when service upgrades are anticipated (e.g. upgrading to Transcription). Only available for RTMP streams. Leave off unless needed; incurs extra processing during and after the event.

callback

string

Callback URL for status updates.

Note: If a callback URL is provided, the payload sent to that URL will be the object representation, in application/x-www-form-urlencoded format.

wordlist_file

file

A text file containing up to 75 words or phrases, each on a new line, to aid speech recognition. Files must be sent in a multipart post (e.g. using -F 'wordlist_file=@LOCAL_FILE_PATH' in curl).

live_event_type

string

enum

Type of the live event

fallback_to_automatic_captions

boolean

Whether to fallback to automatic captions if the event exceeds the estimated duration. Events continue with professional captions by default, however the price of professional captions increases to $3.00 per minute once beyond the estimated duration.

event_description

string

Context for the event, such as information about speakers, the event purpose, etc

speaker_names

string

A list of names of people who may be speaking during the event, used to improve speaker label accuracy

meeting_location

string

URL or phone number of the event audio for captioner access

additional_instructions

string

Additional information the captioner needs in order to access the event audio. This could include a secondary method for accessing the event.

contact_name

string

Name of the person managing captions for the live captioning event. 3Play may contact them for the purposes of providing event support.

contact_email

string

Email of the person managing captions for the live captioning event. 3Play may contact them for the purposes of providing event support.

contact_phone_number

string

Phone number of the person managing captions for the live captioning event. 3Play may contact them for the purposes of providing event support.

Responses

405

Invalid input

200Success