Order Live Auto Captions

post

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

Order a new live auto captioning event for a specified Media File.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

media_file_id

integer

required

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

start_time

string

required

Scheduled start time for live auto caption, in RFC 3339 format

Body Params

media_file_id

integer

required

ID of the captioning event's media file

start_time

string

required

Scheduled start time of the captioning event

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

int32

required

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

stream_url

string

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

transcoder_id

integer

ID of the reserved transcoder / stream_target to use

latency

integer

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

offensive_words_sensitivity

int32

enum

Sensitivity for eliding words. Higher is more sensitive.

Allowed:

stream_reconnection_wait_time

int32

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

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).

Responses

405

Invalid input

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success