Interface Publication<T>

interface Publication<T> {
    cancel: (() => Promise<void>);
    codecCapabilities: Codec[];
    contentType: ContentType;
    disable: (() => Promise<void>);
    enable: (() => Promise<void>);
    encodings: Encoding[];
    id: string;
    metadata?: string;
    onCanceled: Event<void>;
    onConnectionStateChanged: Event<{
        remoteMember: RemoteMember;
        state: TransportConnectionState;
    }>;
    onDisabled: Event<void>;
    onEnabled: Event<void>;
    onMetadataUpdated: Event<{
        metadata: string;
    }>;
    onStateChanged: Event<void>;
    onSubscribed: Event<StreamSubscribedEvent>;
    onSubscriptionListChanged: Event<void>;
    onUnsubscribed: Event<StreamUnsubscribedEvent>;
    origin?: Publication<LocalStream>;
    publisher: Member;
    replaceStream: ((stream, options?) => void);
    state: PublicationState;
    stream?: T;
    subscriptions: Subscription<RemoteStream>[];
    updateEncodings: ((encodings) => void);
    updateMetadata: ((metadata) => Promise<void>);
    getConnectionState(selector): TransportConnectionState;
    getRTCPeerConnection(selector): undefined | RTCPeerConnection;
    getStats(selector): Promise<WebRTCStats>;
}

Type Parameters

Properties

cancel codecCapabilities contentType disable enable encodings id metadata? onCanceled onConnectionStateChanged onDisabled onEnabled onMetadataUpdated onStateChanged onSubscribed onSubscriptionListChanged onUnsubscribed origin? publisher replaceStream state stream? subscriptions updateEncodings updateMetadata

Methods

getConnectionState getRTCPeerConnection getStats

Properties

cancel

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Deprecated

Use

LocalPerson.unpublish

Description

[japanese] unpublishする

Readonly codecCapabilities

codecCapabilities: Codec[]

Readonly contentType

contentType: ContentType

disable

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Description

[japanese] 無効化する

enable

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Throws

Readonly encodings

encodings: Encoding[]

Readonly id

id: string

Optional metadata

metadata?: string

onCanceled

onCanceled: Event<void>

Deprecated

Use

LocalPerson.onStreamUnpublished or Channel.onStreamUnpublished

Description

[japanese] Unpublishされた時に発火するイベント

onConnectionStateChanged

onConnectionStateChanged: Event<{
    remoteMember: RemoteMember;
    state: TransportConnectionState;
}>

Type declaration

Description

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

onDisabled

onDisabled: Event<void>

Description

[japanese] 無効化された時に発火するイベント

onEnabled

onEnabled: Event<void>

Description

[japanese] 有効化された時に発火するイベント

onMetadataUpdated

onMetadataUpdated: Event<{
    metadata: string;
}>

Type declaration

  • metadata: string

Description

[japanese] Metadataが変更された時に発火するイベント

onStateChanged

onStateChanged: Event<void>

Description

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

onSubscribed

onSubscribed: Event<StreamSubscribedEvent>

Description

[japanese] Subscribeされた時に発火するイベント

onSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

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

onUnsubscribed

onUnsubscribed: Event<StreamUnsubscribedEvent>

Description

[japanese] このPublicationをSubscribeしたSubscriptionがUnsubscribeされた時に発火するイベント

Optional Readonly origin

origin?: Publication<LocalStream>

Readonly publisher

publisher: Member

replaceStream

replaceStream: ((stream, options?) => void)

Type declaration

Description

[japanese] Publicationのstreamを同じContentTypeの別のStreamに入れ替える。 dataStreamを入れ替えることはできない。 RemoteのPublication(streamがnull)では利用不可。

state

state: PublicationState

Optional stream

stream?: T

Description

[japanese] publishしたstreamの実体。 ローカルで作られたPublicationでなければundefinedとなる

Readonly subscriptions

subscriptions: Subscription<RemoteStream>[]

updateEncodings

updateEncodings: ((encodings) => void)

Type declaration

Description

[japanese] Video|Audio Streamの場合、encoding設定を更新する

updateMetadata

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

Type declaration

    • (metadata): Promise<void>

    • Parameters

      • metadata: string

      Returns Promise<void>

Description

[japanese] Metadataの更新

Methods

getConnectionState

getRTCPeerConnection

  • getRTCPeerConnection(selector): undefined | RTCPeerConnection
  • Experimental

    Parameters

    Returns undefined | RTCPeerConnection

    Description

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

    Description

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

getStats

  • getStats(selector): Promise<WebRTCStats>
  • Experimental

    Parameters

    Returns Promise<WebRTCStats>

    Description

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

    Description

    [japanese] StreamをSubscribeしているMemberとの通信の統計情報を取得する

Settings

Member Visibility

Theme

On This Page

cancelcodecCapabilitiescontentTypedisableenableencodingsidmetadataonCanceledonConnectionStateChangedonDisabledonEnabledonMetadataUpdatedonStateChangedonSubscribedonSubscriptionListChangedonUnsubscribedoriginpublisherreplaceStreamstatestreamsubscriptionsupdateEncodingsupdateMetadatagetConnectionStategetRTCPeerConnectiongetStats