Configure recordings

This endpoint is used to configure recordings.


curl --location --request POST 'https://api.100ms.live/v2/templates/<template_id>/recordings' \
--header 'Authorization: Bearer <management_token>' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "name": "default",
        "role": "host",
        "maxDuration": 1800,
        "presignDuration": 3600,
        "thumbnails": {
            "enabled": false,
            "width": 1280,
            "height": 720,
            "offsets": [2],
            "fps": 60
        },
        "compositeRecording": {
            "browserComposite": {
                "autoStart": false,
                "autoStopTimeout": 500,
                "width": 1920,
                "height": 1080
            },
            "customComposite": {
                "enabled": false
            }
        },
        "trackRecording": {
            "enabled": false
        },
        "streamRecording": {
            "enabled": false,
            "width": 1920,
            "height": 1080
        }
    }
]'

RESPONSE

Status: 200 OK


[
    {
        "name": "default",
        "role": "host",
        "maxDuration": 1800,
        "presignDuration": 3600,
        "thumbnails": {
            "width": 1280,
            "height": 720,
            "offsets": [2],
            "fps": 60
        },
        "compositeRecording": {
            "browserComposite": {
                "autoStopTimeout": 500,
                "width": 1920,
                "height": 1080
            },
            "customComposite": {}
        },
        "trackRecording": {},
        "streamRecording": {
            "width": 1920,
            "height": 1080
        }
    }
]

Arguments

Name	Type	Description	Required
template_id — path param	`string`	Unique identifier of the template you wish to update destinations details for. Example: 6316d5ca5a2635a5849a0216	Yes
recordingConfigs	`list`	List of recordingConfig objects corresponding for the given template. Currently only one recordingConfig object is allowed.	Yes

RecordingConfig Object

Name	Type	Description	Required
name	`string`	A string value to identify the configuration	Yes
role	`string`	One of the roles present in template	Yes
maxDuration	`int`	Sets the maximum duration, in seconds, of the recording. For example, 1800 seconds(30 minutes)	No
presignDuration	`int`	Indicates the expiry of the pre-signed URLs—the duration for which the pre-signed URL should be signed	No
thumbnails	`object`	Object of type thumbnails. This can be used to configure thumbnail's dimension	No
compositeRecording	`object`	Object of type compositeRecording	No
trackRecording	`object`	Object of type trackRecording	No
streamRecording	`object`	Object of type streamRecording	No

CompositeRecording Object

Name	Type	Description	Required
browserComposite	`object`	Object of type browserComposite	No
customComposite	`object`	Object of type customComposite	No

BrowserComposite Object

Name	Type	Description	Required
autoStart	`boolean`	Indicates whether recordings should automatically start on room join for this destination. Disabled by default	No
autoStopTimeout	`int`	Maximum duration to wait before automatically stopping recording after all peers leave	No
width	`int`	Indicates the width of the screen to be recorded in pixels. For example, 1280 pixels	No
height	`int`	Indicates the height of the screen to be recorded in pixels. For example, 720 pixels	No

CustomeComposite Object

Name	Type	Description	Required
enabled	`boolean`	Enable the custom composite recording for rooms belonging to the template. Disabled by default	No

StreamRecording Object

Name	Type	Description	Required
enabled	`boolean`	Enable the stream recording for rooms belonging to the template. Disabled by default	No

TrackRecording Object

Name	Type	Description	Required
enabled	`boolean`	Enable the track recording for rooms belonging to the template. Disabled by default	No

Retrieve current recordings configuration


curl --location --request GET 'https://api.100ms.live/v2/templates/<template_id>/recordings' \
--header 'Authorization: Bearer <management_token>'

RESPONSE

Status: 200 OK


[
    {
        "name": "default",
        "role": "host",
        "maxDuration": 1800,
        "presignDuration": 3600,
        "thumbnails": {
            "width": 1280,
            "height": 720,
            "offsets": [2],
            "fps": 60
        },
        "compositeRecording": {
            "browserComposite": {
                "enabled": true,
                "autoStopTimeout": 500,
                "width": 1920,
                "height": 1080
            },
            "customComposite": {}
        },
        "trackRecording": {},
        "streamRecording": {
            "width": 1920,
            "height": 1080
        }
    }
]

Update destinations

Have a suggestion? Recommend changes ->