Template object
Overview
Template is the blueprint of the room. It defines the settings of the room along with the behavior of users who are part of it.
Room will inherit the properties from a template that you have specified while creating it. If you have not specified any template then it will pick the default template.
Each template will be identified by its id or name. For example default_videoconf_7e450ffc-8ef1-4572-ab28-b32474107b89
Endpointhttps://api.100ms.live/v2/templates
Template object
| Argument | Description |
|---|---|
| id | Unique identifier for the template. Deprecation notice: _id argument which was available in the previous version has been deprecated. |
| name | Alias for the template |
| customer_id | Unique identifier for your account. Deprecation notice: customer argument which was available in the previous version has been deprecated. |
| roles | Map of {roleName:roleObject} where roleObject is a collection of arguments and objects such as name, publishParams, subscribeParams, permissions, priority, maxPeerCount, etc. |
| settings | Object of type settings with the collection of arguments and objects such as region, recording, roomState, etc. |
| destinations | Object of type destinations. This object contains information for enabling/configuring features like rtmpDestinations, hlsDestinations, & transcriptions |
Understand sub-objects hierarchy
Refer to the sub-objects attributes here
Postman collection
You can use our Postman collection to start exploring 100ms APIs.
Refer to the Postman guide to get started with 100ms API collection.
Have a suggestion? Recommend changes ->
