Interface Channel

interface Channel {
    appId: string;
    bots: RemoteMember[];
    close: (() => Promise<void>);
    dispose: (() => void);
    id: string;
    join: ((memberInit?) => Promise<LocalPerson>);
    leave: ((member) => Promise<void>);
    localPerson?: LocalPerson;
    members: RemoteMember[];
    metadata?: string;
    moveChannel: ((adapter) => Promise<void>);
    name?: string;
    onClosed: Event<ChannelClosedEvent>;
    onMemberJoined: Event<MemberJoinedEvent>;
    onMemberLeft: Event<MemberLeftEvent>;
    onMemberListChanged: Event<ListChangedEvent>;
    onMemberMetadataUpdated: Event<MemberMetadataUpdatedEvent>;
    onMetadataUpdated: Event<ChannelMetadataUpdatedEvent>;
    onPublicationDisabled: Event<PublicationDisabledEvent>;
    onPublicationEnabled: Event<PublicationEnabledEvent>;
    onPublicationListChanged: Event<ListChangedEvent>;
    onPublicationMetadataUpdated: Event<PublicationMetadataUpdatedEvent>;
    onPublicationSubscribed: Event<StreamSubscribedEvent>;
    onPublicationUnsubscribed: Event<StreamUnsubscribedEvent>;
    onStreamPublished: Event<StreamPublishedEvent>;
    onStreamUnpublished: Event<StreamUnpublishedEvent>;
    onSubscriptionListChanged: Event<ListChangedEvent>;
    publications: Publication<LocalStream>[];
    state: ChannelState;
    subscriptions: Subscription<RemoteStream>[];
    updateMetadata: ((metadata) => Promise<void>);
}

Properties

appId: string
bots: RemoteMember[]

Description

[japanese] Channel中のBotの一覧を取得する

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

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

Description

[japanese] Channelを閉じる。

dispose: (() => void)

Type declaration

    • (): void
    • Returns void

Description

[japanese] Channelを閉じずにChannelインスタンスの利用を終了し次のリソースを解放する。

  • サーバとの通信
  • イベントリスナー
  • LocalPersonのインスタンス
id: string
join: ((memberInit?) => Promise<LocalPerson>)

Type declaration

Description

[japanese] ChannelにMemberを追加する

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

Type declaration

    • (member): Promise<void>
    • Parameters

      Returns Promise<void>

Description

[japanese] ChannelからMemberを退出させる

localPerson?: LocalPerson

Description

[japanese] Channel中のLocalPersonを取得する

members: RemoteMember[]

Description

[japanese] Channel中のMemberの一覧を取得する

metadata?: string
moveChannel: ((adapter) => Promise<void>)

Type declaration

    • (adapter): Promise<void>
    • Parameters

      Returns Promise<void>

Deprecated

Description

[japanese] 別のChannelのMemberを移動させる

name?: string

Description

[japanese] このChannelが閉じられた時に発生するイベント

onMemberJoined: Event<MemberJoinedEvent>

Description

[japanese] ChannelにMemberが参加した時に発生するイベント

onMemberLeft: Event<MemberLeftEvent>

Description

[japanese] ChannelからMemberが退出した時に発生するイベント

onMemberListChanged: Event<ListChangedEvent>

Description

[japanese] このChannelのMemberの数が変化した時に発生するイベント

onMemberMetadataUpdated: Event<MemberMetadataUpdatedEvent>

Description

[japanese] MemberのMetadataが更新された時に発生するイベント

Description

[japanese] このChannelのMetadataが更新された時に発生するイベント

onPublicationDisabled: Event<PublicationDisabledEvent>

Description

[japanese] このChannelのPublicationが無効化された時に発生するイベント

onPublicationEnabled: Event<PublicationEnabledEvent>

Description

[japanese] このChannelのPublicationが有効化された時に発生するイベント

onPublicationListChanged: Event<ListChangedEvent>

Description

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

onPublicationMetadataUpdated: Event<PublicationMetadataUpdatedEvent>

Description

[japanese] StreamのPublicationのMetadataが更新された時に発生するイベント

onPublicationSubscribed: Event<StreamSubscribedEvent>

Description

[japanese] ChannelのPublicationがSubscribeされた時に発生するイベント

onPublicationUnsubscribed: Event<StreamUnsubscribedEvent>

Description

[japanese] ChannelのPublicationがUnsubscribeされた時に発生するイベント

onStreamPublished: Event<StreamPublishedEvent>

Description

[japanese] ChannelにStreamがPublishされた時に発生するイベント

onStreamUnpublished: Event<StreamUnpublishedEvent>

Description

[japanese] ChannelからStreamがUnpublishされた時に発生するイベント

onSubscriptionListChanged: Event<ListChangedEvent>

Description

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

publications: Publication<LocalStream>[]

Description

[japanese] Channel中のPublicationの一覧を取得する

subscriptions: Subscription<RemoteStream>[]

Description

[japanese] Channel中のSubscriptionの一覧を取得する

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

Type declaration

    • (metadata): Promise<void>
    • Parameters

      • metadata: string

      Returns Promise<void>

Description

[japanese] ChannelのMetadataを更新する