roomuserpayload.md

RoomUserPayload

Example Usage

import { RoomUserPayload } from "livepeer/models/components";

let value: RoomUserPayload = {
  name: "name",
  canPublish: true,
  canPublishData: true,
};

Fields

Field	Type	Required	Description	Example
name	string	✔️	Display name	name
canPublish	boolean	➖	Whether a user is allowed to publish audio/video tracks	true
canPublishData	boolean	➖	Whether a user is allowed to publish data messages to the room	true
metadata	string	➖	User defined payload to store for the participant