kit_livestreams

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

Overview

Name	kit_livestreams
Type	Resource
Id	cloudflare.realtime_kit.kit_livestreams

Fields

The following fields are returned by SELECT queries:

get_by_account

Name	Datatype	Description
data	object
success	boolean

list

Name	Datatype	Description
data	object
success	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_account	select	account_id, app_id, livestream_id	page_no, per_page	Returns details of a livestream with sessions for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.
list	select	account_id, app_id	exclude_meetings, per_page, page_no, status, start_time, end_time, sort_order	Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the exclude_meetings query parameter.

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.
livestream_id	string
end_time	string (date-time)	Specify the end time range in ISO format to access the live stream.
exclude_meetings	boolean	Exclude the RealtimeKit meetings that are livestreamed.
page_no	integer	The page number from which you want your page search results to be displayed.
per_page	integer	Number of results per page.
sort_order	string	Specifies the sorting order for the results.
start_time	string (date-time)	Specify the start time range in ISO format to access the live stream.
status	string	Specifies the status of the operation.

SELECT examples

get_by_account

Returns details of a livestream with sessions for the given livestream ID. Retreive the livestream ID using the Start livestreaming a meeting API.

SELECT
data,
success
FROM cloudflare.realtime_kit.kit_livestreams
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND livestream_id = '{{ livestream_id }}' -- required
AND page_no = '{{ page_no }}'
AND per_page = '{{ per_page }}'
;

list

Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the exclude_meetings query parameter.

SELECT
data,
success
FROM cloudflare.realtime_kit.kit_livestreams
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND exclude_meetings = '{{ exclude_meetings }}'
AND per_page = '{{ per_page }}'
AND page_no = '{{ page_no }}'
AND status = '{{ status }}'
AND start_time = '{{ start_time }}'
AND end_time = '{{ end_time }}'
AND sort_order = '{{ sort_order }}'
;