Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Room

Hierarchy

  • EventTarget<RoomEventMap>
    • Room

Index

Properties

Accessors

Methods

Properties

createdAt

createdAt: number

Long value of the date when the room created at.

createdBy

createdBy: string

The ID of user who created the room

customItems

customItems: CustomItems

The custom items of room

roomId

roomId: string

The ID of room

Accessors

localParticipant

  • get localParticipant(): LocalParticipant

  • The local participant.

    Returns LocalParticipant

participants

  • The list of all participants including local participant.

    Returns Participant[]

remoteParticipants

  • get remoteParticipants(): RemoteParticipant[]

  • The list of remote participants.

    Returns RemoteParticipant[]

Methods

deleteCustomItems

  • Delete custom items

    Parameters

    • customItemKeys: string[]

    Returns true | Promise<CustomItemsResult>

enter

  • enter(params: EnterParams): Promise<void>

  • Enters a room

    Parameters

    • params: EnterParams

    Returns Promise<void>

exit

  • exit(): void

  • Exits a room

    Returns void

fetchCustomItems

setAudioForLargeRoom

  • setAudioForLargeRoom(mediaView: HTMLAudioElement): Promise<void>

  • Parameters

    • mediaView: HTMLAudioElement

    Returns Promise<void>

updateCustomItems

Generated using TypeDoc