HMSRole class
Role is a powerful concept that takes a lot of complexity away in handling permissions and supporting features like breakout rooms.
Each HMSPeer instance has a role property which returns an HMSRole instance. You can use this property to do following:
1.Check what this role is allowed to publish. i.e can it send video (and at what resolution)? can it send audio? can it share screen? Who can this role subscribe to? (eg: student can only see the teacher's video) This is can be discovered by checking publishSettings and subscribeSettings properties.
2.Check what actions this role can perform. i.e can it change someone else's current role, end meeting, remove someone from the room. This is can be discovered by checking the permissions property.
HMSRole contains details about the role.
Constructors
- HMSRole({required String name, required HMSPublishSetting? publishSettings, required HMSSubscribeSettings? subscribeSettings, required int priority, required HMSPermissions permissions})
- HMSRole.fromMap(Map map)
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- name ↔ String
-
getter/setter pair
- permissions ↔ HMSPermissions
-
getter/setter pair
- priority ↔ int
-
getter/setter pair
- publishSettings ↔ HMSPublishSetting?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- subscribeSettings ↔ HMSSubscribeSettings?
-
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited