Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRoom

Hierarchy

  • IRoom

Index

Properties

audiocodec

audiocodec: string

comma separated list of allowed audio codecs

bitrate

bitrate: number

bitrate cap that should be forced (via REMB) on all publishers by default

bitrate_cap

bitrate_cap: boolean

true|false, whether the above cap should act as a limit to dynamic bitrate changes by publishers

description

description: string

Name of the room

fir_freq

fir_freq: number

how often a keyframe request is sent via PLI/FIR to active publishers

max_publishers

max_publishers: number

how many publishers can actually publish via WebRTC at the same time

num_participants

num_participants: number

count of the participants (publishers, active or not; not subscribers)

pin_required

pin_required: boolean

true|false, whether a PIN is required to join this room

record

record: boolean

true|false, whether the room is being recorded

record_dir

record_dir: string

if recording, the path where the .mjr files are being saved

room

room: number

unique numeric ID

videocodec

videocodec: string

comma separated list of allowed video codecs

Generated using TypeDoc