HMSRoom

Properties

disableNoneLayerRequest

• Optional disableNoneLayerRequest: boolean

effectsKey

• Optional effectsKey: string

hls

• hls: HMSHLS

id

• id: string

isConnected

• Optional isConnected: boolean

isEffectsEnabled

• Optional isEffectsEnabled: boolean

isHipaaEnabled

• Optional isHipaaEnabled: boolean

isLargeRoom

• Optional isLargeRoom: boolean

isNoiseCancellationEnabled

• Optional isNoiseCancellationEnabled: boolean

isVBEnabled

• Optional isVBEnabled: boolean

joinedAt

• Optional joinedAt: Date

localPeer

• localPeer: string

name

• name: string

peerCount

• Optional peerCount: number

if this number is available room.peers is not guaranteed to have all the peers.

peers

• peers: string[]

recording

• recording: HMSRecording

roomState

• roomState: HMSRoomState

rtmp

• rtmp: HMSRTMP

sessionId

• sessionId: string

startedAt

• Optional startedAt: Date

transcriptions

• Optional transcriptions: HMSTranscriptionInfo[]

translationConfig

• Optional translationConfig: Record<CAPTION, { enabled: boolean ; roleLanguages?: Record<string, string> }>

Translation config from template policy. Presence means translation is available.