WebRTC SFU Sora ドキュメント¶
製品のお問い合わせなどは sora at shiguredo.jp までお願いいたします。 (このメールアドレスへの特定電子メールの送信を拒否いたします)
重要なお知らせ¶
Sora のクラウド版 Sora Cloud を正式リリースしました
Sora 2023.1.0 より、サポート提供期間をメジャーアップデートがリリースされた日から 12 ヶ月後の月末最終日までに変更しました
レガシー録画機能の廃止について¶
2023 年 12 月リリースの Sora 2023.2.0 で新しい録画機能を追加しました。 今までの録画機能はレガシー録画機能と名前を変更しました。 2025 年 12 月リリース予定の Sora でレガシー録画機能を廃止します。
移行については レガシー録画機能から新しい録画機能への移行 をご覧ください。
廃止については レガシー録画機能の廃止 をご覧ください。
レガシー録画機能をご利用のお客様は、新しい録画機能へ移行をご検討ください。
機能や移行に関してのご不明点などがあれば、サポートまでお問い合わせください。
レガシーストリーム(非マルチストリーム)機能の廃止予定について¶
2024 年 6 月リリース予定の Sora にてレガシーストリーム機能をデフォルトで無効にする予定です。
2025 年 6 月リリース予定の Sora でレガシーストリーム機能を廃止予定です。
レガシーストリーム機能をご利用のお客様は、マルチストリーム機能へ移行をご検討ください。
機能や移行に関してのご不明点などがあれば、サポートまでお問い合わせください。
CentOS 7 版の提供終了ついて¶
CentOS 7 は 2024 年 6 月末でサポートが終了となるのに合わせて、Sora の CentOS 7 版については以下のとおりとなります。
- パッケージの提供
2023 年 12 月にリリースの 2023.2.0、およびその後リリースされる可能性のある 2023.2.x の提供をもって終了
- サポートの終了
2023.2.0 およびおよびその後リリースされる可能性のある 2023.2.x に対しては 2024 年 12 月末で終了
CentOS 7 版をご利用のお客様は、早めに OS の変更をご検討の上、移行先の OS をサポートまでご連絡下さい。
古いドキュメントについて¶
古いドキュメント をご確認ください。
このドキュメントについて¶
このドキュメントは WebRTC SFU Sora 2023.2.7 に対応しています。
- 2023.1.x から 2023.2.x への移行
- 概要
- 2023.1.x へのローリングアップデートによるクラスター切り戻しはできません
- クラスター関連ログの出力先を
cluster.jsonlへ変更 sora.confのsignaling_notify_metadataをfalseに設定した場合の挙動の変更- セッションウェブフック
session.updatedの送信 - ウェブフックなどに利用する信頼された CA 証明書のインストール
- ログ出力を JSONL 形式に変更
- ログ出力ファイルの拡張子を
jsonlに変更 - ウェブフックの audio と video 項目の JSON をフラット構造に変更
- レガシー録画から新しい録画への移行
- クラスターを構成する Sora ノードの
data/ディレクトリが消えた場合の挙動の変更
- レガシー録画機能から新しい録画機能 (セッション単位) への移行
- リリースノート
- 用語集
- 既知の問題
- 実験的機能
- 非推奨機能
- 廃止機能
- 概要
- sora.conf の legacy_log_format の廃止
- sora.conf の legacy_log_extension の廃止
- sora.conf の legacy_webhook_audio_video_json_structure の廃止
- DataChannel で利用している SCTP 関連の実験的な設定の廃止
- Ubuntu 18.04 サポートの終了
- sora.conf の split_archive_legacy_prefix の廃止
- sora.conf の default_multistream の廃止
- redact_archive_metadata_sensitive_data と redact_api_sensitive_data の廃止
- recording.report の metadata_filename と metadata_file_path の廃止
- シグナリング通知メタデータ metadata_list の廃止
"type": "update"の廃止- sora.conf の demo の廃止
- sora.conf の remote_stats の廃止
- StopRecording API の redirect の配信
- CentOS 8 対応
- extmap_allow_mixed 設定のデフォルト有効化と廃止
- スポットライトレガシー機能の廃止
rtpにある RTCP 関連統計情報を廃止sora.confのopus_param_clock_rateを廃止sora.confのdcsctp_association_max_retransを廃止- role の upstream と downstream を廃止
- client_id を指定する設定の廃止
- 旧サイマルキャスト画質変更 API の廃止
- bin/sora start の廃止
- Ubuntu 16.04 サポートの終了
問い合わせ (サポート)
設定
- チュートリアル
- 本番稼働に向けて
- IPv4 アドレスの固定
- IPv6 アドレスの利用について
- sora.conf の turn_fqdn を設定する
- ウェブフックなどで利用する CA 証明書のインストール
- HTTP API のループバックアドレスからのみのアクセス
- シグナリングのループバックアドレスからのみのアクセス
- ファイルディスクリプタ数の設定
- systemd の適用
- TURN-TLS、TURN-TCP、シグナリングで 443 番ポートを使用する
- カーネルパラメーターの適用
- SDK の利用
- やりたいことが 1:1 の双方向配信の場合
- やりたいことが複数人での双方向配信の場合
- やりたいことが 1:多 の双方向配信の場合
- やりたいことが OBS からの配信の場合
- Edge が機能要件に含まれている場合
- 認証を外部の指定した HTTP サーバーで判断したい場合
- 接続、切断の検知を外部の指定した HTTP サーバーで利用したい場合
- 配信されている音声や映像を記録したい場合
- クライアント側で参加してきたユーザーの情報を通知したい場合
- ライセンス
- ログファイル
- sora.conf リファレンス
- 単位指定
- 範囲表記
- license_file
- label
- ipv4_address
- ipv6
- ipv6_address
- ipv6_only
- devtools
- rtp_publish_worker_number
- auth_webhook_url
- auth_webhook_log
- session_webhook_url
- session_webhook_worker_number
- session_created_timeout
- session_destroyed_timeout
- session_updated_webhook_interval
- event_webhook_url
- event_webhook_worker_number
- webhook_ipv6
- webhook_response_timeout
- connection_updated_webhook_interval
- webhook_insecure
- webhook_basic_authn
- webhook_basic_authn_user_id
- webhook_basic_authn_password
- webhook_proxy_url
- webhook_proxy_auth_user
- webhook_proxy_auth_password
- webhook_tls_fullchain_file
- webhook_tls_privkey_file
- webhook_tls_verify_cacert_file
- ignore_connection_updated_webhook
- ignore_connection_failed_webhook
- ignore_session_updated_webhook
- ignore_session_vanished_webhook
- ignore_audio_streaming_webhook
- ignore_spotlight_changed_webhook
- ignore_recording_started_webhook
- ignore_archive_started_webhook
- ignore_split_archive_available_webhook
- archive_dir
- archive_tmp_dir
- recording_max_expire_time
- recording_max_split_duration
- recording_expire_time_required
- recording_dual_output
- signaling_port
- signaling_loopback_address_only
- signaling_notify
- signaling_notify_session_id
- signaling_notify_client_id
- signaling_notify_bundle_id
- signaling_notify_connection_id
- signaling_notify_connection_created_timestamp
- signaling_notify_media
- signaling_notify_metadata
- signaling_notify_metadata_ext
- signaling_notify_authn_metadata_max_size
- signaling_notify_network
- signaling_notify_rtp_stream
- signaling_notify_recording
- signaling_notify_forwarding_filter
- signaling_vp9_params
- signaling_av1_params
- signaling_h264_params
- signaling_h265_params
- signaling_bundle_id
- websocket_signaling_ping_interval
- websocket_signaling_pong_timeout
- websocket_stats_timer_interval
- default_data_channel_signaling
- default_ignore_disconnect_websocket
- data_channel_messaging
- data_channel_messaging_only
- data_channel_stats_timer_interval
- data_channel_stats_max_retransmits
- whip
- whip_bearer_token_metadata_key
- api_port
- api_loopback_address_only
- api_cors_origin
- turn
- turn_realm
- turn_fqdn
- turn_tls_fqdn
- turn_tcp
- turn_tcp_allocate_success_delay_time
- turn_tcp_listen_port
- turn_tcp_port
- turn_tcp_only
- turn_tls
- turn_tls_port
- turn_tls_only
- rtx
- ulpfec
- audio_red
- generic_nack
- default_audio_bit_rate
- default_video_bit_rate
- default_vp9_param_profile_id
- default_av1_param_profile
- default_h264_param_profile_level_id
- default_h265_param_level_id
- default_simulcast_rid
- default_forwarding_pli_interval
- forwarding_simulcast
- signaling_forwarding_filter
- audio_streaming_url
- default_audio_streaming_result_push
- default_audio_streaming_language_code
- audio_streaming_tls_fullchain_file
- audio_streaming_tls_privkey_file
- audio_streaming_tls_verify_cacert_file
- recycle_media_section
- hide_origin_username
- connection_created_wait_timeout
- default_spotlight_focus_rid
- default_spotlight_unfocus_rid
- default_spotlight_unfocus_audio
- default_spotlight_unfocus_audio_rate_limit
- default_spotlight_delayed_focus
- default_spotlight_delayed_focus_interval
- default_spotlight_auto_unfocus
- default_spotlight_auto_unfocus_interval
- default_spotlight_focus_min_interval
- default_spotlight_number
- simulcast_encodings_file
- spotlight_encodings_file
- multistream_auto_sharing_video_bit_rate
- user_agent_stats
- ice_connection_state_disconnected_timeout
- ice_connection_state_failed_timeout
- skip_redact_sensitive_data
- default_h264_profile_level_id
- e2ee
- stats_collector_url
- default_stats_exporter
- stats_exporter_number
- stats_exporter_tls_fullchain_file
- stats_exporter_tls_privkey_file
- stats_exporter_tls_verify_cacert_file
- node_name
- cluster
- external_signaling_url
- external_api_url
- contact_node_name_list
- cluster_auto_reconnect
- cluster_listen_min_port
- cluster_listen_max_port
- data_dir
- av1
- h265
- lyra
- lyra_param_bitrate
- legacy_recording
- rtp_hdrext_video_orientation
- rtp_hdrext_video_content_type
- rtp_hdrext_video_timing
- rtp_hdrext_playout_delay
- rtp_hdrext_color_space
- rtp_hdrext_sdes_mid
- rtp_hdrext_abs_capture_time
- rtp_packet_loss_simulator_incoming
- rtp_packet_loss_simulator_outgoing
- data_channel_packet_loss_simulator_incoming
- data_channel_packet_loss_simulator_outgoing
- opus_param_channels
- opus_param_maxplaybackrate
- opus_param_stereo
- opus_param_sprop_stereo
- opus_param_ptime
- opus_param_minptime
- opus_param_useinbandfec
- opus_param_usedtx
- systemd
- Linux カーネルチューニング
- IPv6 での動作について
- メタデータ
- 概要
- 接続時の認証メタデータ指定
- 認証ウェブフック成功時のメタデータ払い出し
- 認証ウェブフック成功時のイベントメタデータ払い出し
- 接続時のシグナリング通知メタデータ指定
- 認証ウェブフック成功時のシグナリング通知メタデータ払い出し
- シグナリング通知メタデータ拡張
- セッション生成時のセッションメタデータ払い出し
- 一括録画ファイルメタデータ archive-<connection_id>.json
- 分割録画ファイルメタデータ split-archive-<connection_id>_<index>.json
- 録画(セッション単位) の StartRecording API で指定するメタデータ
- 録画(セッション単位) のセッションウェブフック
session.createdで指定するメタデータ - レガシー録画の StartRecording API で指定するメタデータ
- センシティブデータ
アプリケーション連携
シグナリング
ウェブフック
- ウェブフック
- 認証ウェブフック
- 認証ウェブフック成功時の払い出し
- 概要
- 範囲表記
- audio の払い出し
- video の払い出し
- client_id の払い出し
- bundle_id の払い出し
- simulcast / simulcast_rid の払い出し
- simulcast_encodings の払い出し
- spotlight_encodings の払い出し
- spotlight / spotlight_number の払い出し
- data_channel_signaling の払い出し
- ignore_disconnect_websocket の払い出し
- data_channels の払い出し
- metadata の払い出し
- event_metadata の払い出し
- シグナリング経由での通知機能の払い出し
- シグナリング通知メタデータ拡張機能の初期値払い出し
- 録画ブロックの払い出し
- ipv4_address と ipv6_address の払い出し
- turn_fqdn 払い出し
- turn_tls_fqdn の 払い出し
- user_agent_stats の払い出し
- audio_streaming_language_code の払い出し
- stats_exporter の払い出し
- h264_profile_level_id の払い出し
- turn_tcp_only / turn_tls_only の払い出し
- rtp_packet_loss_simulator_incoming / rtp_packet_loss_simulator_outgoing の払い出し
- シーケンス図
- セッションウェブフック
- イベントウェブフック
- ウェブフックの型定義
実験的 API
非推奨・廃止 API
クラスター機能
機能
SDK
ツール
libwebrtc