Interface Publication<T>

interface Publication<T> {
    codecCapabilities: Codec[];
    contentType: ContentType;
    disable: (() => Promise<void>);
    enable: (() => Promise<void>);
    encodings: Encoding[];
    id: string;
    metadata?: string;
    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: LocalCustomVideoStream | LocalVideoStream | LocalAudioStream, options?: ReplaceStreamOptions) => void);
    state: PublicationState;
    stream?: T;
    subscriptions: Subscription<RemoteStream>[];
    type: PublicationType;
    updateEncodings: ((encodings: EncodingParameters[]) => void);
    updateMetadata: ((metadata: string) => Promise<void>);
    getConnectionState(selector: string | Member): TransportConnectionState;
    getRTCPeerConnection(selector: string | Member): undefined | RTCPeerConnection;
    getStats(selector: string | Member): Promise<WebRTCStats>;
}

Type Parameters

Properties

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

Methods

getConnectionState getRTCPeerConnection getStats

Properties

ReadonlycodecCapabilities

codecCapabilities: Codec[]

ReadonlycontentType

contentType: ContentType

disable

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

Description

[japanese] 無効化する

enable

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

Throws

Readonlyencodings

encodings: Encoding[]

Readonlyid

id: string

Optionalmetadata

metadata?: string

onConnectionStateChanged

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

Description

[japanese] メディア通信の状態が変化した時に発火するイベント。 状態の現在値を参照する場合はgetConnectionStateメソッドを利用してください。 DataStreamを利用している場合、書き込み可能になったことはLocalDataStream.onWritableイベントで別途通知されます。

onDisabled

onDisabled: Event<void>

Description

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

onEnabled

onEnabled: Event<void>

Description

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

onMetadataUpdated

onMetadataUpdated: Event<{
    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 Readonlyorigin

origin?: Publication<LocalStream>

Readonlypublisher

publisher: Member

replaceStream

replaceStream: ((stream: LocalCustomVideoStream | LocalVideoStream | LocalAudioStream, options?: ReplaceStreamOptions) => void)

Description

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

state

state: PublicationState

Optionalstream

stream?: T

Description

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

Readonlysubscriptions

subscriptions: Subscription<RemoteStream>[]

Readonlytype

type: PublicationType

updateEncodings

updateEncodings: ((encodings: EncodingParameters[]) => void)

Description

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

updateMetadata

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

Description

[japanese] Metadataの更新

Methods

getConnectionState

  • getConnectionState(selector): TransportConnectionState

  • Parameters

    • selector: string | Member

      [japanese] 接続相手

    Returns TransportConnectionState

    Description

    [japanese] メディア通信の状態を取得する。 状態が変化したことはonConnectionStateChangedイベントで通知されます。

getRTCPeerConnection

  • getRTCPeerConnection(selector): undefined | RTCPeerConnection
  • Experimental

    Parameters

    • selector: string | Member

      [japanese] 接続相手

    Returns undefined | RTCPeerConnection

    Description

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

    Description

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

getStats

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

    Parameters

    • selector: string | Member

      [japanese] 接続相手

    Returns Promise<WebRTCStats>

    Description

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

    Description

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

Settings

Member Visibility

On This Page

Properties
Methods