language
Creates, updates, deletes, gets or lists a language resource.
Overview
| Name | language |
| Type | Resource |
| Id | cloudflare.streams.language |
Fields
The following fields are returned by SELECT queries:
- get
List captions or subtitles response for a provided language.
| Name | Datatype | Description |
|---|---|---|
generated | boolean | Whether the caption was generated via AI. |
label | string | The language label displayed in the native language to users. (example: Türkçe) |
language | string | The language tag in BCP 47 format. (example: tr) |
status | string | The status of a generated caption. (ready, inprogress, error) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | language, identifier, account_id | Lists the captions or subtitles for provided language. | |
create | insert | language, identifier, account_id | Generate captions or subtitles for provided language via AI. | |
update | replace | language, identifier, account_id, file | Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed. | |
delete | delete | language, identifier, account_id | Removes the captions or subtitles from a video. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
identifier | string | Resource identifier. |
language | string |
SELECT examples
- get
Lists the captions or subtitles for provided language.
SELECT
generated,
label,
language,
status
FROM cloudflare.streams.language
WHERE language = '{{ language }}' -- required
AND identifier = '{{ identifier }}' -- required
AND account_id = '{{ account_id }}' -- required
;
INSERT examples
- create
- Manifest
Generate captions or subtitles for provided language via AI.
INSERT INTO cloudflare.streams.language (
language,
identifier,
account_id
)
SELECT
'{{ language }}',
'{{ identifier }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;
# Description fields are for documentation purposes
- name: language
props:
- name: language
value: "{{ language }}"
description: Required parameter for the language resource.
- name: identifier
value: "{{ identifier }}"
description: Required parameter for the language resource.
- name: account_id
value: "{{ account_id }}"
description: Required parameter for the language resource.
REPLACE examples
- update
Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.
REPLACE cloudflare.streams.language
SET
file = '{{ file }}'
WHERE
language = '{{ language }}' --required
AND identifier = '{{ identifier }}' --required
AND account_id = '{{ account_id }}' --required
AND file = '{{ file }}' --required
RETURNING
errors,
messages,
result,
success;
DELETE examples
- delete
Removes the captions or subtitles from a video.
DELETE FROM cloudflare.streams.language
WHERE language = '{{ language }}' --required
AND identifier = '{{ identifier }}' --required
AND account_id = '{{ account_id }}' --required
;