Interface RoomPublication<T>

interface RoomPublication {
    cancel: (() => Promise<void>);
    codecCapabilities: Codec[];
    contentType: ContentType;
    disable: (() => Promise<void>);
    enable: (() => Promise<void>);
    encodings: EncodingParameters[];
    id: string;
    metadata?: string;
    onCanceled: Event<void>;
    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, options?) => void);
    state: PublicationState;
    stream?: T;
    subscriptions: RoomSubscription<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 publisher replaceStream state stream? subscriptions updateEncodings updateMetadata

Methods

getConnectionState getRTCPeerConnection getStats

Properties

cancel

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      Description

      [japanese] unpublishする

Readonly codecCapabilities

codecCapabilities: Codec[]

Readonly contentType

contentType: ContentType

disable

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      Description

      [japanese] publicationを無効化する

enable

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

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      Description

      [japanese] publicationを有効化する

encodings

encodings: EncodingParameters[]

Description

[japanese] Encode設定

Readonly id

id: string

Optional metadata

metadata?: string

Readonly onCanceled

onCanceled: Event<void>

Description

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

Readonly onConnectionStateChanged

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

Type declaration

Description

[japanese] メディア通信の状態が変化した時に発火するイベント SFURoomの場合、remoteMemberはundefinedになる SFURoomの場合、memberがルームを離れたときのみ発火する

Readonly onDisabled

onDisabled: Event<void>

Description

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

Readonly onEnabled

onEnabled: Event<void>

Description

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

Readonly onMetadataUpdated

onMetadataUpdated: Event<{
    metadata: string;
}>

Type declaration

  • metadata: string

Description

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

Readonly onStateChanged

onStateChanged: Event<void>

Description

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

Readonly onSubscribed

onSubscribed: Event<StreamSubscribedEvent>

Description

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

Readonly onSubscriptionListChanged

onSubscriptionListChanged: Event<void>

Description

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

Readonly onUnsubscribed

onUnsubscribed: Event<StreamUnsubscribedEvent>

Description

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

Readonly publisher

publisher: RoomMember

replaceStream

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

Type declaration

state

state: PublicationState

Description

[japanese] Publicationの状態

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

Optional Readonly stream

stream?: T

Description

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

subscriptions

subscriptions: RoomSubscription<RemoteStream>[]

Description

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

updateEncodings

updateEncodings: ((encodings) => void)

Type declaration

    • (encodings): void

    • Parameters

      Returns void

      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

Generated using TypeDoc