####################
シグナリングの型定義
####################

この章ではシグナリングの型について説明します。
シグナリングの仕様については :doc:`シグナリング </SIGNALING>` を参照ください。

型の表記は TypeScript で記述します。

基本的なデータ型
================

JSON 値
-------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 1-7

JSON 値を表します。
仕様は RFC 8259 に従います。


シグナリング
============

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 9-27

シグナリングは「クライアントからサーバ(Sora)に送信される」メッセージと「サーバ(Sora)からクライアントに送信される」メッセージに分かれます。

- クライアントからサーバに送信されるメッセージ

  - connect
  - answer
  - candidate
  - update
  - pong
  - disconnect

- サーバからクライアントに送信されるメッセージ

  - offer
  - update
  - ping
  - push
  - notify

type: connect
=============

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 30-49

ストリームの種別
----------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 52-57

サイマルキャストで配信する映像の種類
------------------------------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 60

スポットライト
--------------
| :ref:`spotlight_legacy` が有効かどうかによって boolean または number どちらかを使用します。
| 詳しくは :ref:`スポットライト機能` と :ref:`スポットライトレガシー機能` を参照してください。

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 63

音声
----

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 65-66,68-84

映像
----

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 86-92,94-99

type: offer
===========

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 102-110


type: answer
============

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 113-116

type: candidate
===============

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 119-122

type: update (サーバ -> クライアント)
=======================================

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 126-129

type: update (クライアント -> サーバ)
=======================================

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 133-136

type: ping
==========

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 139-142

type: pong
==========

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 145-148

type: push
==========

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 151-154

type: notify
============

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 157-164

接続中のクライアントの情報
--------------------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 166-172

connection.created
------------------
:ref:`signaling_notify_metadata_ext` が有効かどうかによって metadata_list または data どちらに値がセットされます。

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 175-196

connection.updated
------------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 198-215

connection.destroyed
--------------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 218-237

spotlight.changed
-----------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 240-249

spotlight.focused
-----------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 252-260

spotlight.unfocused
--------------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 263-271


network.status
--------------

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 274-278

type: disconnect
================

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript
    :lines: 281-283


完全な型定義
============

.. literalinclude:: ../typescript/SIGNALING_TYPE.ts
    :language: typescript