Update Live Professional Captioning

put

https://api.3playmedia.com/v3/live_professional_captions/{id}

Update existing live professional captioning

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

ID of the live professional captioning record to update

Body Params

start_time

string

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

stream_url

string

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

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_delay

integer

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

event_wait_time

int32

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

event_max_time

integer

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

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.

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

speaker_names

string

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

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

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.

captioner_join_time

string

Time at which the captioner will access the event audio

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

Language

Credentials

Query

URL

Loading…

Response

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

application/json

200Success