Class SkyWayRoom

Index

Methods

Create Find FindOrCreate

Methods

`Static` Create

Create<Init>(context, init): Promise<Init["type"] extends "sfu"
? SfuRoom
: P2PRoom>
Type Parameters
- Init extends RoomInit
Parameters
- context: SkyWayContext
- init: Init
Returns Promise<Init["type"] extends "sfu"
? SfuRoom
: P2PRoom>
Description
[japanese] Roomの作成

`Static` Find

Find<Type>(context, query, roomType, options?): Promise<Type extends "sfu"
? SfuRoom
: P2PRoom>
Type Parameters
- Type extends "sfu" | "p2p"
Parameters
- context: SkyWayContext
- query: {
  id?: string;
  name?: string;
  }
  - Optional id?: string
  - Optional name?: string
- roomType: Type
- Optional options: Type extends "sfu"
  ? SfuRoomOptions
  : void
Returns Promise<Type extends "sfu"
? SfuRoom
: P2PRoom>
Description
[japanese] 既存のRoomの取得

`Static` FindOrCreate

FindOrCreate<Init>(context, init): Promise<Init["type"] extends "p2p"
? P2PRoom
: SfuRoom>
Type Parameters
- Init extends RoomInit
Parameters
- context: SkyWayContext
- init: Init
Returns Promise<Init["type"] extends "p2p"
? P2PRoom
: SfuRoom>
Description
[japanese] Roomの取得を試み、存在しなければ作成する