Overview

Recording assets are files that are generated after a successful recording. Recording assets are also generated through live streams and external streams when recording is enabled.

If a cloud storage location (for example, AWS S3 or GCS) is configured on the template, we upload the recording asset to the defined location. Else, the asset is uploaded to 100ms storage buckets. These recordings can be downloaded by generating short-live pre-signed URLs before the retention period of 15 days.

Endpointhttps://api.100ms.live/v2/recording-assets

Asset types

  • room-composite: This type composes a single video (mp4) out of all peers in the room.
  • room-vod: This is also a composition of all peers in the room and is available in HLS (or m3u8) format for on-demand playback.
  • chat: This type captures chat messages that were exchanged while recording was running.

Object

PropertyDescription
idUnique identifier for the recording asset
job_idUnique identifier for the recording job that generated the asset
room_idUnique identifier of the room which was recorded
session_idUnique identifier of the session which was recorded
typeType of recording asset (room-composite, room-vod, chat)
statusStatus for this asset, can be completed or failed
pathPath of the recording asset (pointing to your or 100ms cloud storage bucket)
sizeSize of the asset (in bytes)
durationDuration of the media in asset (in seconds)
created_atTimestamp when the asset was created (in ISO-8601 format)
thumbnailsArray of paths of thumbnails generated out of the recording (only for room-vod)
metadataAdditional information (e.g. resolution, VOD layers) based on asset type

Object as JSON

{ "id": "<asset-id>", "job_id": "<job-id>", "room_id": "<room-id>", "session_id": "<session-id>", "type": "<asset-type>", "path": "<recording_path", "status": "<status", "size": 42, "duration": 42, "created_at": "2023-03-02T07:44:27.010516042Z", "thumbnails": ["<thumbnail_path"], "metadata": { "resolution": { "width": 1280, "height": 720 }, "num_layers": "<num_layers>", "layer": "<layer_idx>", "max_width": 1920, "max_height": 1080 } }

Postman collection

You can use our Postman collection to start exploring 100ms APIs. Use the Postman guide to get started.

Run in Postman


Have a suggestion? Recommend changes ->

Run in postman

Was this helpful?

1234