Interface LocalP2PRoomMember

interface LocalP2PRoomMember {
    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: T, options?: RoomPublicationOptions) => Promise<RoomPublication<T>>);
    room: Room;
    roomId: string;
    roomName?: string;
    roomType: "sfu" | "p2p" | "default";
    side: "local";
    state: MemberState;
    subscribe: (<T>(publicationId: string | RoomPublication<LocalStream>, options?: SubscriptionOptions) => Promise<{
        stream: T;
        subscription: RoomSubscription<T>;
    }>);
    subscriptions: RoomSubscription<RemoteStream>[];
    unpublish: ((publicationId: string | RoomPublication<LocalStream>) => Promise<void>);
    unsubscribe: ((subscriptionId: string | RoomSubscription<RemoteStream>) => Promise<void>);
    updateMetadata: ((metadata: string) => 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

Readonlyid

id: string

leave

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

Description

[japanese] Channelから退室する

Optional Readonlymetadata

metadata?: string

Optional Readonlyname

name?: string

ReadonlyonFatalError

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

Description

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

ReadonlyonLeft

onLeft: Event<void>

Description

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

ReadonlyonMetadataUpdated

onMetadataUpdated: Event<string>

Description

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

onPublicationListChanged

onPublicationListChanged: Event<void>

Description

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

onPublicationSubscribed

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

Description

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

onPublicationUnsubscribed

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

Description

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

onStreamPublished

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

Description

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

onStreamUnpublished

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

Description

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

onSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

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

Readonlypublications

publications: RoomPublication<LocalStream>[]

Description

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

publish

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

Description

[japanese] StreamをPublishする

room

room: Room

ReadonlyroomId

roomId: string

Optional ReadonlyroomName

roomName?: string

ReadonlyroomType

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

side

side

state

state: MemberState

subscribe

subscribe: (<T>(publicationId: string | RoomPublication<LocalStream>, options?: SubscriptionOptions) => Promise<{
    stream: T;
    subscription: RoomSubscription<T>;
}>)

Description

[japanese] StreamのPublicationをSubscribeする

Readonlysubscriptions

subscriptions: RoomSubscription<RemoteStream>[]

Description

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

unpublish

unpublish: ((publicationId: string | RoomPublication<LocalStream>) => Promise<void>)

Description

[japanese] StreamのPublicationをUnpublishする

unsubscribe

unsubscribe: ((subscriptionId: string | RoomSubscription<RemoteStream>) => Promise<void>)

Description

[japanese] StreamのSubscriptionをUnsubscribeする

updateMetadata

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

Description

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

Settings

Member Visibility

On This Page

Properties