Optional
params: { Optional
name?: stringOptional
permissions?: HMSPermissionsOptional
priority?: numberOptional
publishOptional
subscribeOptional
nameThe name of the role.
Optional
permissionsPermissions granted to this role.
Optional
priorityThe priority of the role, determining its precedence in the session.
Optional
publishSettings related to publishing streams for this role.
Optional
subscribeSettings related to subscribing to streams for this role.
Generated using TypeDoc
Represents a role within the HMS ecosystem.
A role defines the capabilities and permissions a user has in a session, such as publishing or subscribing to streams, and the priority of the user in the session. This class encapsulates the properties of a role, including its name, publishing settings, subscribing settings, permissions, and priority.
See
https://www.100ms.live/docs/get-started/v2/get-started/concepts/templates-and-roles