kit_recordings

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

Overview

Name	kit_recordings
Type	Resource
Id	cloudflare.realtime_kit.kit_recordings

Fields

The following fields are returned by SELECT queries:

get_by_account

Success response

Name	Datatype	Description
data	object	Data returned by the operation (title: Recording)
success	boolean	Success status of the operation

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, recording_id		Returns details of a recording for the given recording ID.
start_recordings	insert	account_id, app_id		Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

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.
recording_id	string	ID of the recording

SELECT examples

get_by_account

Returns details of a recording for the given recording ID.

SELECT
data,
success
FROM cloudflare.realtime_kit.kit_recordings
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND recording_id = '{{ recording_id }}' -- required
;

INSERT examples

start_recordings

Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

INSERT INTO cloudflare.realtime_kit.kit_recordings (
allow_multiple_recordings,
audio_config,
file_name_prefix,
interactive_config,
max_seconds,
meeting_id,
realtimekit_bucket_config,
rtmp_out_config,
storage_config,
url,
video_config,
account_id,
app_id
)
SELECT 
{{ allow_multiple_recordings }},
'{{ audio_config }}',
'{{ file_name_prefix }}',
'{{ interactive_config }}',
{{ max_seconds }},
'{{ meeting_id }}',
'{{ realtimekit_bucket_config }}',
'{{ rtmp_out_config }}',
'{{ storage_config }}',
'{{ url }}',
'{{ video_config }}',
'{{ account_id }}',
'{{ app_id }}'
RETURNING
data,
success
;

Manifest

# Description fields are for documentation purposes
- name: kit_recordings
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the kit_recordings resource.
  - name: app_id
    value: "{{ app_id }}"
    description: Required parameter for the kit_recordings resource.
  - name: allow_multiple_recordings
    value: {{ allow_multiple_recordings }}
    description: |
      By default, a meeting allows only one recording to run at a time. Enabling the `allow_multiple_recordings` parameter to true allows you to initiate multiple recordings concurrently in the same meeting. This allows you to record separate videos of the same meeting with different configurations, such as portrait mode or landscape mode.
    default: false
  - name: audio_config
    description: |
      Object containing configuration regarding the audio that is being recorded.
    value:
      channel: "{{ channel }}"
      codec: "{{ codec }}"
      export_file: {{ export_file }}
  - name: file_name_prefix
    value: "{{ file_name_prefix }}"
    description: |
      Update the recording file name.
  - name: interactive_config
    description: |
      Allows you to add timed metadata to your recordings, which are digital markers inserted into a video file to provide contextual information at specific points in the content range. The ID3 tags containing this information are available to clients on the playback timeline in HLS format. The output files are generated in a compressed .tar format.
    value:
      type: "{{ type }}"
  - name: max_seconds
    value: {{ max_seconds }}
    description: |
      Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.
  - name: meeting_id
    value: "{{ meeting_id }}"
    description: |
      ID of the meeting to record.
  - name: realtimekit_bucket_config
    value:
      enabled: {{ enabled }}
  - name: rtmp_out_config
    value:
      rtmp_url: "{{ rtmp_url }}"
  - name: storage_config
    value:
      access_key: "{{ access_key }}"
      auth_method: "{{ auth_method }}"
      bucket: "{{ bucket }}"
      host: "{{ host }}"
      password: "{{ password }}"
      path: "{{ path }}"
      port: {{ port }}
      private_key: "{{ private_key }}"
      region: "{{ region }}"
      secret: "{{ secret }}"
      type: "{{ type }}"
      username: "{{ username }}"
  - name: url
    value: "{{ url }}"
    description: |
      Pass a custom url to record arbitary screen
  - name: video_config
    value:
      codec: "{{ codec }}"
      export_file: {{ export_file }}
      height: {{ height }}
      watermark:
        position: "{{ position }}"
        size:
          height: {{ height }}
          width: {{ width }}
        url: "{{ url }}"
      width: {{ width }}