Interface RemoteRoomMember

interface RemoteRoomMember {
    id: string;
    leave: (() => Promise<void>);
    metadata?: string;
    name?: string;
    onLeft: Event<void>;
    onMetadataUpdated: Event<string>;
    onPublicationListChanged: Event<void>;
    onPublicationSubscribed: Event<{
        subscription: RoomSubscription<RemoteStream>;
    }>;
    onPublicationUnsubscribed: Event<{
        subscription: RoomSubscription<RemoteStream>;
    }>;
    onSubscriptionListChanged: Event<void>;
    publications: RoomPublication<LocalStream>[];
    roomId: string;
    roomName?: string;
    roomType: "sfu" | "p2p" | "default";
    side: "remote";
    state: MemberState;
    subscribe: ((publicationId: string) => Promise<{
        subscription: RoomSubscription<RemoteStream>;
    }>);
    subscriptions: RoomSubscription<RemoteStream>[];
    unsubscribe: ((subscriptionId: string) => Promise<void>);
    updateMetadata: ((metadata: string) => Promise<void>);
}

Hierarchy (view full)

Properties

id leave metadata? name? onLeft onMetadataUpdated onPublicationListChanged onPublicationSubscribed onPublicationUnsubscribed onSubscriptionListChanged publications roomId roomName? roomType side state subscribe subscriptions unsubscribe updateMetadata

Properties

Readonlyid

id: string

leave

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

Description

[japanese] Channelから退室する

Optional Readonlymetadata

metadata?: string

Optional Readonlyname

name?: string

ReadonlyonLeft

onLeft: Event<void>

Description

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

ReadonlyonMetadataUpdated

onMetadataUpdated: Event<string>

Description

[japanese] Memberのメタデータが更新された時に発火するイベント

ReadonlyonPublicationListChanged

onPublicationListChanged: Event<void>

Description

[japanese] MemberのPublicationの数が変化したとき

ReadonlyonPublicationSubscribed

onPublicationSubscribed: Event<{
    subscription: RoomSubscription<RemoteStream>;
}>

Description

[japanese] この RemoteRoomMember がPublicationをSubscribeしたとき

ReadonlyonPublicationUnsubscribed

onPublicationUnsubscribed: Event<{
    subscription: RoomSubscription<RemoteStream>;
}>

Description

[japanese] この RemoteRoomMember がPublicationをUnsubscribeしたとき

ReadonlyonSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

[japanese] MemberのSubscriptionの数が変化したとき

Readonlypublications

publications: RoomPublication<LocalStream>[]

Description

[japanese] Memberが Publish した Publication のリスト

ReadonlyroomId

roomId: string

Optional ReadonlyroomName

roomName?: string

ReadonlyroomType

roomType: "sfu" | "p2p" | "default"

Readonlyside

side

state

state: MemberState

subscribe

subscribe: ((publicationId: string) => Promise<{
    subscription: RoomSubscription<RemoteStream>;
}>)

Description

[japanese] この RemoteRoomMember にPublicationをSubscribeさせる

Readonlysubscriptions

subscriptions: RoomSubscription<RemoteStream>[]

Description

[japanese] Memberが Subscribe している Subscription のリスト

unsubscribe

unsubscribe: ((subscriptionId: string) => Promise<void>)

Description

[japanese] この RemoteRoomMember にPublicationをUnsubscribeさせる

updateMetadata

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

Description

[japanese] Memberのメタデータを更新する

Settings

Member Visibility

On This Page

Properties