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) => Promise<{
        subscription: RoomSubscription<RemoteStream>;
    }>);
    subscriptions: RoomSubscription<RemoteStream>[];
    unsubscribe: ((subscriptionId) => Promise<void>);
    updateMetadata: ((metadata) => 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

Readonly id

id: string

leave

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Description

[japanese] Channelから退室する

Optional Readonly metadata

metadata?: string

Optional Readonly name

name?: string

Readonly onLeft

onLeft: Event<void>

Description

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

Readonly onMetadataUpdated

onMetadataUpdated: Event<string>

Description

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

Readonly onPublicationListChanged

onPublicationListChanged: Event<void>

Description

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

Readonly onPublicationSubscribed

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

Type declaration

Description

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

Readonly onPublicationUnsubscribed

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

Type declaration

Description

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

Readonly onSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

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

Readonly publications

publications: RoomPublication<LocalStream>[]

Description

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

Readonly roomId

roomId: string

Optional Readonly roomName

roomName?: string

Readonly roomType

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

Readonly side

side: "remote"

state

state: MemberState

subscribe

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

Type declaration

Description

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

Readonly subscriptions

subscriptions: RoomSubscription<RemoteStream>[]

Description

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

unsubscribe

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

Type declaration

    • (subscriptionId): Promise<void>

    • Parameters

      • subscriptionId: string

      Returns Promise<void>

Description

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

updateMetadata

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

Type declaration

    • (metadata): Promise<void>

    • Parameters

      • metadata: string

      Returns Promise<void>

Description

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

Settings

Member Visibility

Theme

On This Page

idleavemetadatanameonLeftonMetadataUpdatedonPublicationListChangedonPublicationSubscribedonPublicationUnsubscribedonSubscriptionListChangedpublicationsroomIdroomNameroomTypesidestatesubscribesubscriptionsunsubscribeupdateMetadata