Interface Room

interface Room {
    close: (() => Promise<void>);
    dispose: (() => Promise<void>);
    disposed: boolean;
    id: string;
    join: ((memberInit?) => Promise<LocalRoomMember>);
    leave: ((member) => Promise<void>);
    localRoomMember?: LocalRoomMember;
    members: RemoteRoomMember[];
    metadata?: string;
    moveRoom: ((member) => Promise<LocalRoomMember>);
    name?: string;
    onClosed: Event<RoomClosedEvent>;
    onMemberJoined: Event<MemberJoinedEvent>;
    onMemberLeft: Event<MemberLeftEvent>;
    onMemberListChanged: Event<ListChangedEvent>;
    onMemberMetadataUpdated: Event<MemberMetadataUpdatedEvent>;
    onMetadataUpdated: Event<RoomMetadataUpdatedEvent>;
    onPublicationDisabled: Event<PublicationDisabledEvent>;
    onPublicationEnabled: Event<PublicationEnabledEvent>;
    onPublicationListChanged: Event<ListChangedEvent>;
    onPublicationMetadataUpdated: Event<PublicationMetadataUpdatedEvent>;
    onPublicationSubscribed: Event<StreamSubscribedEvent>;
    onPublicationUnsubscribed: Event<StreamUnsubscribedEvent>;
    onStreamPublished: Event<StreamPublishedEvent>;
    onStreamUnpublished: Event<StreamUnpublishedEvent>;
    onSubscriptionListChanged: Event<ListChangedEvent>;
    publications: RoomPublication<LocalStream>[];
    state: ChannelState;
    subscriptions: RoomSubscription<RemoteStream>[];
    type: "sfu" | "p2p";
    updateMetadata: ((metadata) => Promise<void>);
}

Hierarchy (view full)

Properties

close dispose disposed id join leave localRoomMember? members metadata? moveRoom name? onClosed onMemberJoined onMemberLeft onMemberListChanged onMemberMetadataUpdated onMetadataUpdated onPublicationDisabled onPublicationEnabled onPublicationListChanged onPublicationMetadataUpdated onPublicationSubscribed onPublicationUnsubscribed onStreamPublished onStreamUnpublished onSubscriptionListChanged publications state subscriptions type updateMetadata

Properties

close

close: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Description

[japanese] Roomを閉じる

dispose

dispose: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Description

[japanese] Roomを閉じずにRoomインスタンスの利用を終了し次のリソースを解放する。

  • サーバとの通信
  • イベントリスナー
  • LocalMemberのインスタンス

Readonly disposed

disposed: boolean

Readonly id

id: string

join

join: ((memberInit?) => Promise<LocalRoomMember>)

Type declaration

Description

[japanese] RoomにMemberを追加する

leave

leave: ((member) => Promise<void>)

Type declaration

    • (member): Promise<void>

    • Parameters

      Returns Promise<void>

Description

[japanese] RoomからMemberを退室させる

Optional localRoomMember

localRoomMember?: LocalRoomMember

Readonly members

members: RemoteRoomMember[]

Description

[japanese] Roomに参加しているMemberの一覧を取得する

Optional Readonly metadata

metadata?: string

moveRoom

moveRoom: ((member) => Promise<LocalRoomMember>)

Type declaration

Description

[japanese] 別のRoomのMemberを移動させる

Optional Readonly name

name?: string

Readonly onClosed

onClosed: Event<RoomClosedEvent>

Description

[japanese] Roomが閉じられたときに発火するイベント

Readonly onMemberJoined

onMemberJoined: Event<MemberJoinedEvent>

Description

[japanese] RoomにMemberが参加したときに発火するイベント

Readonly onMemberLeft

onMemberLeft: Event<MemberLeftEvent>

Description

[japanese] RoomからMemberが離脱したときに発火するイベント

Readonly onMemberListChanged

onMemberListChanged: Event<ListChangedEvent>

Description

[japanese] Memberの数が変化した時に発火するイベント

Readonly onMemberMetadataUpdated

onMemberMetadataUpdated: Event<MemberMetadataUpdatedEvent>

Description

[japanese] Room上のMemberのメタデータが変更されたときに発火するイベント

Readonly onMetadataUpdated

onMetadataUpdated: Event<RoomMetadataUpdatedEvent>

Description

[japanese] RoomのMetadataが更新されたときに発火するイベント

Readonly onPublicationDisabled

onPublicationDisabled: Event<PublicationDisabledEvent>

Description

[japanese] Publicationが無効化された時に発火するイベント

Readonly onPublicationEnabled

onPublicationEnabled: Event<PublicationEnabledEvent>

Description

[japanese] Publicationが有効化された時に発火するイベント

Readonly onPublicationListChanged

onPublicationListChanged: Event<ListChangedEvent>

Description

[japanese] Publicationの数が変化した時に発火するイベント

Readonly onPublicationMetadataUpdated

onPublicationMetadataUpdated: Event<PublicationMetadataUpdatedEvent>

Description

[japanese] Room上のPublicationのメタデータが変更されたときに発火するイベント

Readonly onPublicationSubscribed

onPublicationSubscribed: Event<StreamSubscribedEvent>

Description

[japanese] Room上のStreamがSubscribeされたときに発火するイベント

Readonly onPublicationUnsubscribed

onPublicationUnsubscribed: Event<StreamUnsubscribedEvent>

Description

[japanese] Room上のStreamがUnSubscribeされたときに発火するイベント

Readonly onStreamPublished

onStreamPublished: Event<StreamPublishedEvent>

Description

[japanese] RoomにStreamがPublishされたときに発火するイベント

Readonly onStreamUnpublished

onStreamUnpublished: Event<StreamUnpublishedEvent>

Description

[japanese] RoomからStreamがUnPublishされたときに発火するイベント

Readonly onSubscriptionListChanged

onSubscriptionListChanged: Event<ListChangedEvent>

Description

[japanese] Subscriptionの数が変化した時に発火するイベント

Readonly publications

publications: RoomPublication<LocalStream>[]

Description

[japanese] RoomにPublishされているStreamのPublicationの一覧を取得する

Readonly state

state: ChannelState

Readonly subscriptions

subscriptions: RoomSubscription<RemoteStream>[]

Description

[japanese] Room上のStreamのSubscriptionの一覧を取得する

Readonly type

type: "sfu" | "p2p"

updateMetadata

updateMetadata: ((metadata) => Promise<void>)

Type declaration

    • (metadata): Promise<void>

    • Parameters

      • metadata: string

      Returns Promise<void>

Description

[japanese] Roomのmetadataを更新する

Settings

Member Visibility

Theme

On This Page

closedisposedisposedidjoinleavelocalRoomMembermembersmetadatamoveRoomnameonClosedonMemberJoinedonMemberLeftonMemberListChangedonMemberMetadataUpdatedonMetadataUpdatedonPublicationDisabledonPublicationEnabledonPublicationListChangedonPublicationMetadataUpdatedonPublicationSubscribedonPublicationUnsubscribedonStreamPublishedonStreamUnpublishedonSubscriptionListChangedpublicationsstatesubscriptionstypeupdateMetadata