Create Room User

Livepeer Studio API endpoint

POST /room/{id}/user

Go

Go

package main

import(
	livepeergo "github.com/livepeer/livepeer-go"
	"context"
	"github.com/livepeer/livepeer-go/models/components"
	"log"
)

func main() {
    s := livepeergo.New(
        livepeergo.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Room.CreateUser(ctx, "<id>", components.RoomUserPayload{
        Name: "name",
        CanPublish: livepeergo.Bool(true),
        CanPublishData: livepeergo.Bool(true),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.RoomUserResponse != nil {
        // handle response
    }
}

201

{
  "id": "d32ae9e6-c459-4931-9898-e86e2f5e7e16",
  "joinUrl": "https://meet.livepeer.chat",
  "token": "token"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Body

application/json

name · string · required

Display name

Example:

"name"

canPublish · boolean

Whether a user is allowed to publish audio/video tracks

Example:

true

canPublishData · boolean

Whether a user is allowed to publish data messages to the room

Example:

true

metadata · string

User defined payload to store for the participant

Response

201

application/json

Success

id · string

The ID of the user

Example:

"d32ae9e6-c459-4931-9898-e86e2f5e7e16"

joinUrl · string

Joining URL - use this for Livepeer's default meeting app (see the multiparticipant streaming guide for more info).

Example:

"https://meet.livepeer.chat"

token · string

Joining JWT - this can be used if you have a custom meeting app (see the multiparticipant streaming guide for more info).

Example:

"token"