Interface RoomPublication<T>

interface RoomPublication<T> {
    codecCapabilities: Codec[];
    contentType: ContentType;
    disable: (() => Promise<void>);
    enable: (() => Promise<void>);
    encodings: EncodingParameters[];
    id: string;
    metadata?: string;
    onConnectionStateChanged: Event<{
        remoteMember?: RoomMember;
        state: TransportConnectionState;
    }>;
    onDisabled: Event<void>;
    onEnabled: Event<void>;
    onMetadataUpdated: Event<{
        metadata: string;
    }>;
    onStateChanged: Event<void>;
    onSubscribed: Event<StreamSubscribedEvent>;
    onSubscriptionListChanged: Event<void>;
    onUnsubscribed: Event<StreamUnsubscribedEvent>;
    publisher: RoomMember;
    replaceStream: ((stream: LocalAudioStream | LocalVideoStream | LocalCustomVideoStream, options?: ReplaceStreamOptions) => void);
    state: PublicationState;
    stream?: T;
    subscriptions: RoomSubscription<RemoteStream>[];
    type: null | "sfu" | "p2p";
    updateEncodings: ((encodings: EncodingParameters[]) => void);
    updateMetadata: ((metadata: string) => Promise<void>);
    getConnectionState(selector: string | RoomMember): TransportConnectionState;
    getRTCPeerConnection(selector: string | RoomMember): undefined | RTCPeerConnection;
    getStats(selector: string | RoomMember): Promise<WebRTCStats>;
}

Type Parameters

Properties

codecCapabilities contentType disable enable encodings id metadata? onConnectionStateChanged onDisabled onEnabled onMetadataUpdated onStateChanged onSubscribed onSubscriptionListChanged onUnsubscribed 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] publicationを無効化する

enable

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

Description

[japanese] publicationを有効化する

encodings

encodings: EncodingParameters[]

Description

[japanese] Encode設定

Readonlyid

id: string

Optionalmetadata

metadata?: string

ReadonlyonConnectionStateChanged

onConnectionStateChanged: Event<{
    remoteMember?: RoomMember;
    state: TransportConnectionState;
}>

Description

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

ReadonlyonDisabled

onDisabled: Event<void>

Description

[japanese] このPublicationが無効化されたときに発火するイベント

ReadonlyonEnabled

onEnabled: Event<void>

Description

[japanese] このPublicationが有効化されたときに発火するイベント

ReadonlyonMetadataUpdated

onMetadataUpdated: Event<{
    metadata: string;
}>

Description

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

ReadonlyonStateChanged

onStateChanged: Event<void>

Description

[japanese] このPublicationの有効化状態が変化したときに発火するイベント

ReadonlyonSubscribed

onSubscribed: Event<StreamSubscribedEvent>

Description

[japanese] このPublicationがSubscribeされたときに発火するイベント

ReadonlyonSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

[japanese] このPublicationをSubscribeするSubscriptionの数が変わったときに発火するイベント

ReadonlyonUnsubscribed

onUnsubscribed: Event<StreamUnsubscribedEvent>

Description

[japanese] このPublicationがUnsubscribeされたときに発火するイベント

Readonlypublisher

publisher: RoomMember

replaceStream

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

Description

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

state

state: PublicationState

Description

[japanese] Publicationの状態

  • enabled : 配信中
  • disabled : 配信停止中
  • canceled : 配信終了

Optional Readonlystream

stream?: T

Description

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

subscriptions

subscriptions: RoomSubscription<RemoteStream>[]

Description

[japanese] このPublicationをSubscribeしているSubscriptionの一覧

Readonlytype

type: null | "sfu" | "p2p"

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 | RoomMember

      [japanese] 接続相手

    Returns TransportConnectionState

    Description

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

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

On This Page

Properties
Methods