Postman Collection
API Reference

Update Live Auto Captions

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

Update a live auto captioning event

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

ID of the live auto captioning event to update

Body Params
string

Scheduled start time of the captioning event. Must be in RFC 3339 format (e.g. 2018-09-01T14:55:00-04:00).

string

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

integer

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

int32
enum

Sensitivity for eliding words. Higher is more sensitive.

Allowed:
integer

Time in milliseconds by which the playback of the stream is delayed on the client.

int32

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

int32

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

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.

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.

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

Updated 5 months ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago