Class ConnectionPublisher

Role が "sendonly" または "sendrecv" の場合に Sora との WebRTC 接続を扱うクラス

Hierarchy

ConnectionBase
- ConnectionPublisher

Constructors

constructor

new ConnectionPublisher(signalingUrlCandidates: string | string[], role: string, channelId: string, metadata: JSONType, options: ConnectionOptions, debug: boolean): ConnectionPublisher
Parameters
- signalingUrlCandidates: string | string[]
- role: string
- channelId: string
- metadata: JSONType
- options: ConnectionOptions
- debug: boolean
Returns ConnectionPublisher

Inherited from ConnectionBase.constructor

Properties

authMetadata

authMetadata: JSONType

type offer に含まれる認証 metadata

channelId

channelId: string

チャネルID

clientId

clientId: null | string

クライアントID

connectedSignalingUrl

connectedSignalingUrl: string

WS シグナリングで type offer メッセージを受信したシグナリング URL

connectionId

connectionId: null | string

コネクションID

constraints

constraints: any

PeerConnection に渡す configuration

contactSignalingUrl

contactSignalingUrl: string

WS シグナリングで最初に type connect を送信したシグナリング URL

debug

debug: boolean

デバッグフラグ

encodings

encodings: RTCRtpEncodingParameters[]

サイマルキャストで使用する RTCRtpEncodingParameters のリスト

metadata

metadata: undefined | JSONType

メタデータ

options

options: ConnectionOptions

接続オプション

pc

pc: null | RTCPeerConnection

PeerConnection インスタンス

remoteConnectionIds

remoteConnectionIds: string[]

リモートコネクションIDのリスト

role

role: string

ロール(sendonly | sendrecv | recvonly)

signalingUrlCandidates

signalingUrlCandidates: string | string[]

シグナリングに使用する URL 候補

stream

stream: null | MediaStream

メディアストリーム

Accessors

audio

get audio(): boolean
audio が有効かどうか

Returns boolean

Inherited from ConnectionBase.audio

datachannels

get datachannels(): DataChannelConfiguration[]
DataChannel メッセージング用の DataChannel 情報のリスト

Returns DataChannelConfiguration[]

Inherited from ConnectionBase.datachannels

e2eeRemoteFingerprints

get e2eeRemoteFingerprints(): undefined | Record<string, string>
E2EE のリモートのフィンガープリントリスト

Returns undefined | Record<string, string>

Inherited from ConnectionBase.e2eeRemoteFingerprints

e2eeSelfFingerprint

get e2eeSelfFingerprint(): undefined | string
E2EE の自分のフィンガープリント

Returns undefined | string

Inherited from ConnectionBase.e2eeSelfFingerprint

signalingUrl

get signalingUrl(): string | string[]
シグナリングに使用する URL

Deprecated

Returns string | string[]

Inherited from ConnectionBase.signalingUrl

video

get video(): boolean
video が有効かどうか

Returns boolean

Inherited from ConnectionBase.video

Methods

connect

connect(stream: MediaStream): Promise<MediaStream>

Sora へ接続するメソッド

Example

const sendrecv = connection.sendrecv("sora");
const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
await sendrecv.connect(mediaStream);

Parameters

stream: MediaStream

メディアストリーム

Returns Promise<MediaStream>

disconnect

disconnect(): Promise<void>
切断処理をするメソッド

Example
```
await sendrecv.disconnect();
```
Returns Promise<void>

Inherited from ConnectionBase.disconnect

on

on<T, U>(kind: T, callback: U): void
SendRecv Object で発火するイベントのコールバックを設定するメソッド

Example
```
const sendrecv = connection.sendrecv("sora");
sendrecv.on("track", (event) => {
  // callback 処理
});
```
Remarks
addstream イベントは非推奨です. track イベントを使用してください

removestream イベントは非推奨です. removetrack イベントを使用してください
Type Parameters
- T extends keyof Callbacks
- U extends ((event: SoraCloseEvent) => void) | ((event: SignalingPushMessage, transportType: TransportType) => void) | ((event: RTCTrackEvent) => void) | ((event: RTCTrackEvent) => void) | ((event: MediaStreamTrackEvent) => void) | ((event: MediaStreamTrackEvent) => void) | ((event: SignalingNotifyMessage, transportType: TransportType) => void) | ((title: string, message: JSONType) => void) | (() => void) | ((event: TimelineEvent) => void) | ((event: SignalingEvent) => void) | ((event: DataChannelMessageEvent) => void) | ((event: DataChannelEvent) => void)
Parameters
- kind: T
  
  イベントの種類(disconnect, push, track, removetrack, notify, log, timeout, timeline, signaling, message, datachannel)
- callback: U
  
  コールバック関数
Returns void

Inherited from ConnectionBase.on

replaceAudioTrack

replaceAudioTrack(stream: MediaStream, audioTrack: MediaStreamTrack): Promise<void>

audio track を入れ替えするメソッド

Example

const sendrecv = connection.sendrecv("sora");
const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
await sendrecv.connect(mediaStream);

const replacedMediaStream = await navigator.mediaDevices.getUserMedia({audio: true});
await sendrecv.replaceAudioTrack(mediaStream, replacedMediaStream.getAudioTracks()[0]);

Remarks

stream の audio track を停止後、新しい audio track をセットします

Parameters

stream: MediaStream

audio track を削除する MediaStream
audioTrack: MediaStreamTrack

新しい audio track

Returns Promise<void>

replaceVideoTrack

replaceVideoTrack(stream: MediaStream, videoTrack: MediaStreamTrack): Promise<void>

video track を入れ替えするメソッド

Example

const sendrecv = connection.sendrecv("sora");
const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
await sendrecv.connect(mediaStream);

const replacedMediaStream = await navigator.mediaDevices.getUserMedia({video: true});
await sendrecv.replaceVideoTrack(mediaStream, replacedMediaStream.getVideoTracks()[0]);

Remarks

stream の video track を停止後、新しい video track をセットします

Parameters

stream: MediaStream

video track を削除する MediaStream
videoTrack: MediaStreamTrack

新しい video track

Returns Promise<void>

sendMessage

sendMessage(label: string, message: Uint8Array): void
DataChannel を使用してメッセージを送信するメソッド
Parameters
- label: string
  
  メッセージを送信する DataChannel のラベル
- message: Uint8Array
  
  Uint8Array
Returns void

Inherited from ConnectionBase.sendMessage

stopAudioTrack

stopAudioTrack(stream: MediaStream): Promise<void>
audio track を停止するメソッド

Example
```
const sendrecv = connection.sendrecv("sora");
const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
await sendrecv.connect(mediaStream);

sendrecv.stopAudioTrack(mediaStream);
```
Remarks
stream の audio track を停止後、PeerConnection の senders から対象の sender を削除します
Parameters
- stream: MediaStream
  
  audio track を削除する MediaStream
Returns Promise<void>

Inherited from ConnectionBase.stopAudioTrack

stopVideoTrack

stopVideoTrack(stream: MediaStream): Promise<void>
video track を停止するメソッド

Example
```
const sendrecv = connection.sendrecv("sora");
const mediaStream = await navigator.mediaDevices.getUserMedia({audio: true, video: true});
await sendrecv.connect(mediaStream);

sendrecv.stopVideoTrack(mediaStream);
```
Remarks
stream の video track を停止後、PeerConnection の senders から対象の sender を削除します
Parameters
- stream: MediaStream
  
  video track を削除する MediaStream
Returns Promise<void>

Inherited from ConnectionBase.stopVideoTrack

Class ConnectionPublisher

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

signalingUrlCandidates: string | string[]

role: string

channelId: string

metadata: JSONType

options: ConnectionOptions

debug: boolean

Returns ConnectionPublisher

Properties

authMetadata

channelId

clientId

connectedSignalingUrl

connectionId

constraints

contactSignalingUrl

debug

encodings

metadata

options

pc

remoteConnectionIds

role

signalingUrlCandidates

stream

Accessors

audio

Returns boolean

datachannels

Returns DataChannelConfiguration[]

e2eeRemoteFingerprints

Returns undefined | Record<string, string>

e2eeSelfFingerprint

Returns undefined | string

signalingUrl

Deprecated

Returns string | string[]

video

Returns boolean

Methods

connect

Example

Parameters

stream: MediaStream

Returns Promise<MediaStream>

disconnect

Example

Returns Promise<void>

on

Example

Remarks

Type Parameters

T extends keyof Callbacks

Parameters

kind: T

callback: U

Returns void

replaceAudioTrack

Example

Remarks

Parameters

stream: MediaStream

audioTrack: MediaStreamTrack

Returns Promise<void>

replaceVideoTrack

Example

Remarks

Parameters

stream: MediaStream

videoTrack: MediaStreamTrack

Returns Promise<void>