Class HMSRoom

constructor

• new HMSRoom(params): HMSRoom

• Parameters

  • params: {
        id: string;
    }

    • id: string

  Returns HMSRoom

id

browserRecordingState

• get browserRecordingState(): HMSBrowserRecordingState

• Returns HMSBrowserRecordingState

hlsRecordingState

• get hlsRecordingState(): undefined | HMSHLSRecordingState

• Returns undefined | HMSHLSRecordingState

hlsStreamingState

• get hlsStreamingState(): HMSHLSStreamingState

• Returns HMSHLSStreamingState

isLargeRoom

• get isLargeRoom(): boolean

• Returns boolean

localPeer

• get localPeer(): HMSLocalPeer

• Returns HMSLocalPeer

metaData

• get metaData(): undefined | string

• Returns undefined | string

name

• get name(): string

• Returns string

peerCount

• get peerCount(): null | number

• Returns null | number

peers

• get peers(): HMSPeer[]

• Returns HMSPeer[]

rtmpHMSRtmpStreamingState

• get rtmpHMSRtmpStreamingState(): HMSRtmpStreamingState

• Returns HMSRtmpStreamingState

serverRecordingState

• get serverRecordingState(): HMSServerRecordingState

• Returns HMSServerRecordingState

sessionId

• get sessionId(): string

• Returns string

transcriptions

• get transcriptions(): Transcriptions[]

• Returns Transcriptions[]