Livekit.Grants (Livekit v0.1.4)

Defines the structure and types for Livekit access token grants.

Summary

Types

t()

Functions

ingress_admin()

Creates a new grant for ingress administration.

join_room(room_name, can_publish \\ true, can_subscribe \\ true)

Creates a new grant for joining a room.

room_admin()

Creates a new grant for room administration.

room_create()

Creates a new grant for room creation.

room_record()

Creates a new grant for room recording.

Types

t()

@type t() :: %Livekit.Grants{
  ingress_admin: boolean(),
  room: String.t() | nil,
  room_admin: boolean(),
  room_create: boolean(),
  room_join: boolean(),
  room_list: boolean(),
  room_record: boolean()
}

Functions

ingress_admin()

Creates a new grant for ingress administration.

join_room(room_name, can_publish \\ true, can_subscribe \\ true)

Creates a new grant for joining a room.

room_admin()

Creates a new grant for room administration.

room_create()

Creates a new grant for room creation.

room_record()

Creates a new grant for room recording.