Class SkyWayRoom

Index

Methods

Create Find FindOrCreate

Methods

`Static` Create

Create<Init>(context, init): Promise<Init["type"] extends "p2p"
    ? P2PRoom
    : Init["type"] extends "sfu"
        ? SFURoom
        : Room>
Type Parameters
- Init extends RoomInit
Parameters
- context: SkyWayContext
- init: Init
Returns Promise<Init["type"] extends "p2p"
    ? P2PRoom
    : Init["type"] extends "sfu"
        ? SFURoom
        : Room>
Description
[japanese] Roomの作成 RoomInit.typeに応じてRoom, P2PRoom, SFURoomのいずれかとして作成する
- 'default'または未指定: Roomとして作成する
- 'p2p': P2PRoomとして作成する
- 'sfu': SFURoomとして作成する

`Static` Find

Find<Options>(context, query, options?): Promise<Options["type"] extends "p2p"
    ? P2PRoom
    : Options["type"] extends "sfu"
        ? SFURoom
        : Room>
Type Parameters
- Options extends FindOptions
Parameters
- context: SkyWayContext
- query: {
  id?: string;
  name?: string;
  }
  - Optional id?: string
  - Optional name?: string
- Optional options: Options
Returns Promise<Options["type"] extends "p2p"
    ? P2PRoom
    : Options["type"] extends "sfu"
        ? SFURoom
        : Room>
Description
[japanese] 既存のRoomの取得 FindOptions.typeに応じてRoom, P2PRoom, SFURoomのいずれかとして取得する
- 'default'または未指定: Roomとして取得する
- 'p2p': P2PRoomとして取得する
- 'sfu': SFURoomとして取得する

`Static` FindOrCreate

FindOrCreate<Init>(context, init): Promise<Init["type"] extends "p2p"
    ? P2PRoom
    : Init["type"] extends "sfu"
        ? SFURoom
        : Room>
Type Parameters
- Init extends RoomInit
Parameters
- context: SkyWayContext
- init: Init
Returns Promise<Init["type"] extends "p2p"
    ? P2PRoom
    : Init["type"] extends "sfu"
        ? SFURoom
        : Room>
Description
[japanese] Roomの取得を試み、存在しなければ作成する RoomInit.typeに応じてRoom, P2PRoom, SFURoomのいずれかとして作成または取得する
- 'default'または未指定: Roomとして作成または取得する
- 'p2p': P2PRoomとして作成または取得する
- 'sfu': SFURoomとして作成または取得する