SoraMediaChannel

class SoraMediaChannel @JvmOverloads constructor(context: Context, signalingEndpoint: String?, signalingEndpointCandidates: List<String>, channelId: String, signalingMetadata: Any?, mediaOption: SoraMediaOption, timeoutSeconds: Long, listener: SoraMediaChannel.Listener?, clientId: String?, signalingNotifyMetadata: Any?, peerConnectionOption: PeerConnectionOption, dataChannelSignaling: Boolean?, ignoreDisconnectWebSocket: Boolean?)

Sora への接続を行うクラスです. SignalingChannelPeerChannel の管理、協調動作制御を行っています. このクラスを利用することでシグナリングの詳細が隠蔽され、単一の Listener でイベントを受けることが出来ます.

シグナリングの手順とデータに関しては Sora のドキュメント https://sora.shiguredo.jp/doc/SIGNALING.htmlを参照ください.

Parameters

context

android.content.Context

signalingEndpoint

シグナリングの URL

signalingEndpointCandidates

シグナリングの URL (クラスター機能で複数の URL を利用したい場合はこちらを指定する)

signalingMetadata

connect メッセージに含める metadata

channelId

Sora に接続するためのチャネル ID

mediaOption

映像、音声に関するオプション

timeoutSeconds

WebSocket の接続タイムアウト (秒)

listener

イベントリスナー

clientId

connect メッセージに含める client_id

signalingNotifyMetadata

connect メッセージに含める signaling_notify_metadata

dataChannelSignaling

connect メッセージに含める data_channel_signaling

ignoreDisconnectWebSocket

connect メッセージに含める ignore_disconnect_websocket

Constructors

SoraMediaChannel
Link copied to clipboard
fun SoraMediaChannel(context: Context, signalingEndpoint: String? = null, signalingEndpointCandidates: List<String> = emptyList(), channelId: String, signalingMetadata: Any? = "", mediaOption: SoraMediaOption, timeoutSeconds: Long = DEFAULT_TIMEOUT_SECONDS, listener: SoraMediaChannel.Listener?, clientId: String? = null, signalingNotifyMetadata: Any? = null, peerConnectionOption: PeerConnectionOption = PeerConnectionOption(), dataChannelSignaling: Boolean? = null, ignoreDisconnectWebSocket: Boolean? = null)

SoraMediaChannel インスタンスを生成します.

Types

Companion
Link copied to clipboard
object Companion
Listener
Link copied to clipboard
interface Listener

SoraMediaChannel からコールバックイベントを受けるリスナー

Functions

connect
Link copied to clipboard
fun connect()

Sora に接続します.

disconnect
Link copied to clipboard
fun disconnect()

Sora への接続を切断します.

Properties

connectedSignalingEndpoint
Link copied to clipboard
var connectedSignalingEndpoint: String? = null

シグナリングに利用しているエンドポイント.

connectionId
Link copied to clipboard
var connectionId: String? = null

コネクション ID.

role
Link copied to clipboard
val role: SoraChannelRole

ロール

Sources

androidJvm source
Link copied to clipboard