livestreams

Creates, updates, deletes, gets or lists a livestreams resource.

Overview

Name	livestreams
Type	Resource
Id	cloudflare.realtime_kit.livestreams

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
start_livestreaming_a_meeting	insert	meeting_id, account_id, app_id		Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.
create_independent_livestream	insert	account_id, app_id		Creates a livestream for the given App ID and returns ingest server, stream key, and playback URL. You can pass custom input to the ingest server and stream key, and freely distribute the content using the playback URL on any player that supports HLS/LHLS.
stop_livestreaming_a_meeting	exec	meeting_id, account_id, app_id		Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

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.
app_id	string	The Access application ID.
meeting_id	string	The Realtime Kit meeting ID.

INSERT examples

start_livestreaming_a_meeting

Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

INSERT INTO cloudflare.realtime_kit.livestreams (
name,
video_config,
meeting_id,
account_id,
app_id
)
SELECT 
'{{ name }}',
'{{ video_config }}',
'{{ meeting_id }}',
'{{ account_id }}',
'{{ app_id }}'
RETURNING
data,
success
;

create_independent_livestream

Creates a livestream for the given App ID and returns ingest server, stream key, and playback URL. You can pass custom input to the ingest server and stream key, and freely distribute the content using the playback URL on any player that supports HLS/LHLS.

INSERT INTO cloudflare.realtime_kit.livestreams (
name,
account_id,
app_id
)
SELECT 
'{{ name }}',
'{{ account_id }}',
'{{ app_id }}'
RETURNING
data,
success
;

Manifest

# Description fields are for documentation purposes
- name: livestreams
props:
  - name: meeting_id
    value: "{{ meeting_id }}"
    description: Required parameter for the livestreams resource.
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the livestreams resource.
  - name: app_id
    value: "{{ app_id }}"
    description: Required parameter for the livestreams resource.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the livestream
  - name: video_config
    value:
      height: {{ height }}
      width: {{ width }}

Lifecycle Methods

stop_livestreaming_a_meeting

Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the Create a meeting API.

EXEC cloudflare.realtime_kit.livestreams.stop_livestreaming_a_meeting 
@meeting_id='{{ meeting_id }}' --required, 
@account_id='{{ account_id }}' --required, 
@app_id='{{ app_id }}' --required
;