Interface LocalRoomMember

interface LocalRoomMember {
    id: string;
    leave: (() => Promise<void>);
    metadata?: string;
    name?: string;
    onFatalError: Event<SkyWayError<Record<string, any>>>;
    onLeft: Event<void>;
    onMetadataUpdated: Event<string>;
    onPublicationListChanged: Event<void>;
    onPublicationSubscribed: Event<{
        stream: RemoteVideoStream | RemoteAudioStream | RemoteDataStream;
        subscription: RoomSubscription<RemoteStream>;
    }>;
    onPublicationUnsubscribed: Event<{
        subscription: RoomSubscription<RemoteStream>;
    }>;
    onStreamPublished: Event<{
        publication: RoomPublication<LocalStream>;
    }>;
    onStreamUnpublished: Event<{
        publication: RoomPublication<LocalStream>;
    }>;
    onSubscriptionListChanged: Event<void>;
    publications: RoomPublication<LocalStream>[];
    publish: (<T>(stream, options?) => Promise<RoomPublication<T>>);
    room: Room;
    roomId: string;
    roomName?: string;
    roomType: "sfu" | "p2p" | "default";
    side: "local";
    state: MemberState;
    subscribe: (<T>(publicationId, options?) => Promise<{
        stream: T;
        subscription: RoomSubscription<T>;
    }>);
    subscriptions: RoomSubscription<RemoteStream>[];
    unpublish: ((publicationId) => Promise<void>);
    unsubscribe: ((subscriptionId) => Promise<void>);
    updateMetadata: ((metadata) => Promise<void>);
}

Hierarchy (view full)

Properties

id leave metadata? name? onFatalError onLeft onMetadataUpdated onPublicationListChanged onPublicationSubscribed onPublicationUnsubscribed onStreamPublished onStreamUnpublished onSubscriptionListChanged publications publish room roomId roomName? roomType side state subscribe subscriptions unpublish 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 onFatalError

onFatalError: Event<SkyWayError<Record<string, any>>>

Description

[japanese] 回復不能なエラー。このインスタンスは継続して利用できない。

Readonly onLeft

onLeft: Event<void>

Description

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

Readonly onMetadataUpdated

onMetadataUpdated: Event<string>

Description

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

onPublicationListChanged

onPublicationListChanged: Event<void>

Description

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

onPublicationSubscribed

onPublicationSubscribed: Event<{
    stream: RemoteVideoStream | RemoteAudioStream | RemoteDataStream;
    subscription: RoomSubscription<RemoteStream>;
}>

Type declaration

Description

[japanese] このMemberがStreamをSubscribeしたときに発火するイベント

onPublicationUnsubscribed

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

Type declaration

Description

[japanese] このMemberがStreamをUnsubscribeしたときに発火するイベント

onStreamPublished

onStreamPublished: Event<{
    publication: RoomPublication<LocalStream>;
}>

Type declaration

Description

[japanese] このMemberがStreamをPublishしたときに発火するイベント

onStreamUnpublished

onStreamUnpublished: Event<{
    publication: RoomPublication<LocalStream>;
}>

Type declaration

Description

[japanese] このMemberがStreamをUnPublishしたときに発火するイベント

onSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

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

Readonly publications

publications: RoomPublication<LocalStream>[]

Description

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

publish

publish: (<T>(stream, options?) => Promise<RoomPublication<T>>)

Type declaration

Description

[japanese] RoomにStreamをPublishする

room

room: Room

Readonly roomId

roomId: string

Optional Readonly roomName

roomName?: string

Readonly roomType

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

side

side: "local"

state

state: MemberState

subscribe

subscribe: (<T>(publicationId, options?) => Promise<{
    stream: T;
    subscription: RoomSubscription<T>;
}>)

Type declaration

Description

[japanese] StreamのPublicationをSubscribeする

Readonly subscriptions

subscriptions: RoomSubscription<RemoteStream>[]

Description

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

unpublish

unpublish: ((publicationId) => Promise<void>)

Type declaration

Description

[japanese] StreamのPublicationをUnpublishする

unsubscribe

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

Type declaration

Description

[japanese] StreamのSubscriptionを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

idleavemetadatanameonFatalErroronLeftonMetadataUpdatedonPublicationListChangedonPublicationSubscribedonPublicationUnsubscribedonStreamPublishedonStreamUnpublishedonSubscriptionListChangedpublicationspublishroomroomIdroomNameroomTypesidestatesubscribesubscriptionsunpublishunsubscribeupdateMetadata