100ms Logo

100ms

Docs

Search docs
/

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

ArgumentDescription
idUnique identifier for the template.

Deprecation notice: _id argument which was available in the previous version has been deprecated.
nameAlias for the template
customer_idUnique identifier for your account.

Deprecation notice: customer argument which was available in the previous version has been deprecated.
rolesArray of roles objects with a collection of arguments and objects such as name, publishParams, subscribeParams, permissions, priority, maxPeerCount, etc.
settingsObject of type settings with the collection of arguments and objects such as region, subscribeDegradation, recording, roomState, etc.
destinationsObject of type destinations. This object contains information for enabling/configuring features like browserRecordings, rtmpDestinations, & hlsDestinations.
defaultWhether this is default template for a customer. Default template for a customer is used when no template is provided in create room API.

Understand sub-objects hierarchy

Template sub-objects hierarchy

Refer to the sub-objects attributes here

Postman collection

You can use our Postman collection to start exploring 100ms APIs.

Run in Postman

Refer to the Postman guide to get started with 100ms API collection.



Run in postman