Interface Room

interface Room {
    close: (() => Promise<void>);
    dispose: (() => Promise<void>);
    disposed: boolean;
    id: string;
    join: ((memberInit?: PersonInit) => Promise<LocalRoomMember>);
    leave: ((member: RoomMember) => Promise<void>);
    localRoomMember?: LocalRoomMember;
    members: RoomMember[];
    metadata?: string;
    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" | "default";
    updateMetadata: ((metadata: string) => Promise<void>);
}

Hierarchy (view full)

Properties

close dispose disposed id join leave localRoomMember? members metadata? 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>)

Description

[japanese] Roomを閉じる

dispose

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

Description

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

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

Readonlydisposed

disposed: boolean

Readonlyid

id: string

join

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

Description

[japanese] RoomにMemberを追加する

leave

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

Description

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

OptionallocalRoomMember

localRoomMember?: LocalRoomMember

Readonlymembers

members: RoomMember[]

Description

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

Optional Readonlymetadata

metadata?: string

Optional Readonlyname

name?: string

ReadonlyonClosed

onClosed: Event<RoomClosedEvent>

Description

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

ReadonlyonMemberJoined

onMemberJoined: Event<MemberJoinedEvent>

Description

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

ReadonlyonMemberLeft

onMemberLeft: Event<MemberLeftEvent>

Description

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

ReadonlyonMemberListChanged

onMemberListChanged: Event<ListChangedEvent>

Description

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

ReadonlyonMemberMetadataUpdated

onMemberMetadataUpdated: Event<MemberMetadataUpdatedEvent>

Description

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

ReadonlyonMetadataUpdated

onMetadataUpdated: Event<RoomMetadataUpdatedEvent>

Description

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

ReadonlyonPublicationDisabled

onPublicationDisabled: Event<PublicationDisabledEvent>

Description

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

ReadonlyonPublicationEnabled

onPublicationEnabled: Event<PublicationEnabledEvent>

Description

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

ReadonlyonPublicationListChanged

onPublicationListChanged: Event<ListChangedEvent>

Description

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

ReadonlyonPublicationMetadataUpdated

onPublicationMetadataUpdated: Event<PublicationMetadataUpdatedEvent>

Description

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

ReadonlyonPublicationSubscribed

onPublicationSubscribed: Event<StreamSubscribedEvent>

Description

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

ReadonlyonPublicationUnsubscribed

onPublicationUnsubscribed: Event<StreamUnsubscribedEvent>

Description

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

ReadonlyonStreamPublished

onStreamPublished: Event<StreamPublishedEvent>

Description

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

ReadonlyonStreamUnpublished

onStreamUnpublished: Event<StreamUnpublishedEvent>

Description

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

ReadonlyonSubscriptionListChanged

onSubscriptionListChanged: Event<ListChangedEvent>

Description

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

Readonlypublications

publications: RoomPublication<LocalStream>[]

Description

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

Readonlystate

state: ChannelState

Readonlysubscriptions

subscriptions: RoomSubscription<RemoteStream>[]

Description

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

Readonlytype

type: "sfu" | "p2p" | "default"

updateMetadata

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

Description

[japanese] Roomのmetadataを更新する

Settings

Member Visibility

On This Page

Properties