Skip to main content

livestream

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

Overview

Namelivestream
TypeResource
Idcloudflare.realtime_kit.livestream

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
dataobject
successboolean

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectmeeting_id, account_id, app_idpage_no, per_pageReturns livestream session details for 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.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.
app_idstringThe Access application ID.
meeting_idstringThe Realtime Kit meeting ID.
page_nointegerThe page number from which you want your page search results to be displayed.
per_pageintegerNumber of results per page.

SELECT examples

Returns livestream session details for the given meeting ID. Retreive the meeting ID using the Create a meeting API.

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