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: RemoteAudioStream | RemoteDataStream | 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: T, options?: PublicationOptions) => Promise<Publication<T>>);
    side: MemberSide;
    state: MemberState;
    subscribe: (<T>(publication: string | Publication<LocalStream>, options?: SubscriptionOptions) => Promise<{
        stream: T;
        subscription: Subscription<T>;
    }>);
    subscriptions: Subscription<RemoteAudioStream | RemoteDataStream | RemoteVideoStream>[];
    subtype: "person";
    type: "person";
    unpublish: ((publication: string | Publication<LocalStream>) => Promise<void>);
    unsubscribe: ((subscription: string | Subscription<RemoteStream>) => Promise<void>);
    updateMetadata: ((metadata: string) => Promise<void>);
}

Hierarchy (view full)

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>)

Description

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

Optionalmetadata

metadata?: string

Optionalname

name?: string

ReadonlyonFatalError

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

Description

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

onLeft

onLeft: Event<void>

Description

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

onMetadataUpdated

onMetadataUpdated: Event<string>

Description

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

ReadonlyonPublicationListChanged

onPublicationListChanged: Event<void>

Description

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

ReadonlyonPublicationSubscribed

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

Description

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

ReadonlyonPublicationUnsubscribed

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

Description

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

ReadonlyonStreamPublished

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

Description

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

ReadonlyonStreamUnpublished

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

Description

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

ReadonlyonSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

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

publications

publications: Publication<LocalStream>[]

Description

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

publish

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

Description

[japanese] StreamをPublishする

side

side: MemberSide

state

state: MemberState

subscribe

subscribe: (<T>(publication: string | Publication<LocalStream>, options?: SubscriptionOptions) => Promise<{
    stream: T;
    subscription: Subscription<T>;
}>)

Description

[japanese] StreamのPublicationをSubscribeする

subscriptions

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

Description

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

Readonlysubtype

subtype

Readonlytype

type

unpublish

unpublish: ((publication: string | Publication<LocalStream>) => Promise<void>)

Description

[japanese] StreamのPublicationをUnpublishする

unsubscribe

unsubscribe: ((subscription: string | Subscription<RemoteStream>) => Promise<void>)

Description

[japanese] StreamのSubscriptionをUnsubscribeする

updateMetadata

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

Description

[japanese] metadataを更新する

Settings

Member Visibility

On This Page

Properties