Interface RoomSubscription<T>

interface RoomSubscription<T> {
    cancel: (() => Promise<void>);
    changePreferredEncoding: ((id) => void);
    codec?: Codec;
    contentType: ContentType;
    id: string;
    onCanceled: Event<void>;
    onConnectionStateChanged: Event<TransportConnectionState>;
    onStreamAttached: Event<void>;
    preferredEncoding?: string;
    publication: RoomPublication<LocalStream>;
    state: SubscriptionState;
    stream?: T;
    subscriber: RemoteRoomMember;
    getConnectionState(): TransportConnectionState;
    getRTCPeerConnection(): undefined | RTCPeerConnection;
    getStats(): Promise<WebRTCStats>;
}

Type Parameters

Properties

cancel changePreferredEncoding codec? contentType id onCanceled onConnectionStateChanged onStreamAttached preferredEncoding? publication state stream? subscriber

Methods

getConnectionState getRTCPeerConnection getStats

Properties

cancel

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Deprecated

Use

LocalPerson.unsubscribe

Description

[japanese] unsubscribeする

changePreferredEncoding

changePreferredEncoding: ((id) => void)

Type declaration

    • (id): void

    • Parameters

      • id: string

      Returns void

Description

[japanese] 優先して受信するエンコード設定を変更する

Optional codec

codec?: Codec

Readonly contentType

contentType: ContentType

Readonly id

id: string

Readonly onCanceled

onCanceled: Event<void>

Deprecated

Use

LocalPerson.onPublicationUnsubscribed or Channel.onPublicationUnsubscribed

Description

[japanese] このSubscriptionがUnsubscribeされた時に発火する

onConnectionStateChanged

onConnectionStateChanged: Event<TransportConnectionState>

Description

[japanese] メディア通信の状態が変化した時に発火するイベント

Readonly onStreamAttached

onStreamAttached: Event<void>

Description

[japanese] このSubscriptionにStreamが紐つけられた時に発火する

Optional preferredEncoding

preferredEncoding?: string

Description

[japanese] 現在の優先エンコーディング設定

Readonly publication

publication: RoomPublication<LocalStream>

state

state: SubscriptionState

Optional stream

stream?: T

Description

[japanese] subscribeしているStreamの実体。 ローカルでSubscribeしているSubscriptionでなければundefinedとなる

Readonly subscriber

subscriber: RemoteRoomMember

Methods

getConnectionState

getRTCPeerConnection

  • getRTCPeerConnection(): undefined | RTCPeerConnection
  • Experimental

    Returns undefined | RTCPeerConnection

    Description

    [japanese] 試験的なAPIです。今後インターフェースや仕様が変更される可能性があります

    Description

    [japanese] 対象のMemberとのRTCPeerConnectionを取得する。RTCPeerConnectionを直接操作すると SDK は正しく動作しなくなる可能性があります。

getStats

  • getStats(): Promise<WebRTCStats>
  • Experimental

    Returns Promise<WebRTCStats>

    Description

    [japanese] RemoteStreamの通信の統計情報を取得する

Settings

Member Visibility

Theme

On This Page

cancelchangePreferredEncodingcodeccontentTypeidonCanceledonConnectionStateChangedonStreamAttachedpreferredEncodingpublicationstatestreamsubscribergetConnectionStategetRTCPeerConnectiongetStats