Interface Person

interface Person {
    channel: Channel;
    id: string;
    leave: (() => Promise<void>);
    metadata?: string;
    name?: string;
    onLeft: Event<void>;
    onMetadataUpdated: Event<string>;
    publications: Publication<LocalStream>[];
    side: MemberSide;
    state: MemberState;
    subscriptions: Subscription<RemoteDataStream | RemoteAudioStream | RemoteVideoStream>[];
    subtype: "person";
    type: "person";
    updateMetadata: ((metadata) => Promise<void>);
}

Hierarchy (view full)

Member
- Person
  - LocalPerson

Index

Properties

channel id leave metadata? name? onLeft onMetadataUpdated publications side state subscriptions subtype type 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

onLeft

onLeft: Event<void>

Description

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

onMetadataUpdated

onMetadataUpdated: Event<string>

Description

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

publications

publications: Publication<LocalStream>[]

Description

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

side

side: MemberSide

state

state: MemberState

subscriptions

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

Description

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

`Readonly` subtype

subtype: "person"

`Readonly` type

type: "person"

updateMetadata

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

Type declaration

- (metadata): Promise<void>
- Parameters
  - metadata: string
  Returns Promise<void>

Description

[japanese] metadataを更新する