Interface LocalPerson

interface LocalPerson {
    channel: Channel;
    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: RemoteDataStream | RemoteAudioStream | RemoteVideoStream;
        subscription: Subscription<RemoteStream>;
    }>;
    onPublicationUnsubscribed: Event<{
        subscription: Subscription<RemoteStream>;
    }>;
    onStreamPublished: Event<{
        publication: Publication<LocalStream>;
    }>;
    onStreamUnpublished: Event<{
        publication: Publication<LocalStream>;
    }>;
    onSubscriptionListChanged: Event<void>;
    publications: Publication<LocalStream>[];
    publish: (<T>(stream, options?) => Promise<Publication<T>>);
    side: MemberSide;
    state: MemberState;
    subscribe: (<T>(publication, options?) => Promise<{
        stream: T;
        subscription: Subscription<T>;
    }>);
    subscriptions: Subscription<RemoteDataStream | RemoteAudioStream | RemoteVideoStream>[];
    subtype: "person";
    type: "person";
    unpublish: ((publication) => Promise<void>);
    unsubscribe: ((subscription) => Promise<void>);
    updateMetadata: ((metadata) => Promise<void>);
}

Hierarchy

Properties

channel id leave metadata? name? onFatalError onLeft onMetadataUpdated onPublicationListChanged onPublicationSubscribed onPublicationUnsubscribed onStreamPublished onStreamUnpublished onSubscriptionListChanged publications publish side state subscribe subscriptions subtype type unpublish unsubscribe updateMetadata

Properties

channel

channel: Channel

id

id: string

leave

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      Description

      [japanese] memberをChannelから退去させる

Optional metadata

metadata?: string

Optional name

name?: string

Readonly onFatalError

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

Description

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

onLeft

onLeft: Event<void>

Description

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

onMetadataUpdated

onMetadataUpdated: Event<string>

Description

[japanese] Metadataが変化したときに発火するイベント

Readonly onPublicationListChanged

onPublicationListChanged: Event<void>

Description

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

Readonly onPublicationSubscribed

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

Type declaration

Description

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

Readonly onPublicationUnsubscribed

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

Type declaration

Description

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

Readonly onStreamPublished

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

Type declaration

Description

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

Readonly onStreamUnpublished

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

Type declaration

Description

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

Readonly onSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

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

publications

publications: Publication<LocalStream>[]

Description

[japanese] このMemberのPublicationのリスト

publish

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

Type declaration

side

side: MemberSide

state

state: MemberState

subscribe

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

Type declaration

subscriptions

subscriptions: Subscription<RemoteDataStream | RemoteAudioStream | RemoteVideoStream>[]

Description

[japanese] このMemberのSubscriptionのリスト

Readonly subtype

subtype: "person"

Readonly type

type: "person"

unpublish

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

Type declaration

    • (publication): Promise<void>

    • Parameters

      Returns Promise<void>

      Description

      [japanese] StreamのPublicationをUnpublishする

unsubscribe

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

Type declaration

    • (subscription): Promise<void>

    • Parameters

      Returns Promise<void>

      Description

      [japanese] StreamのSubscriptionをUnsubscribeする

updateMetadata

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

Type declaration

    • (metadata): Promise<void>

    • Parameters

      • metadata: string

      Returns Promise<void>

      Description

      [japanese] metadataを更新する

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc