Genvid SDK 1.30.0¶
Genvid SDK 1.30.0 へようこそ。このリリースで、安定した状態で統合を行うことができ、ローカルでの開発や、限定したクラウドでのデプロイに使用することができます。プロダクションを完全にデプロイするための一部の機能はまだ実装されていませんが、他のソフトウェアによって提供可能です。プロダクションのデプロイを予定している場合は、support@genvidtech.com にお問い合わせください。
私たちは、快適な製品展開のためにすべての機能を完成させるまで、定期的にリリースを行うことをお約束します。私たちは常に、リリース間のスムーズなアップグレードを保証し、可能な限りの後方互換性サポートを提供するよう努力しています。既知の問題と回避策の完全なリストは、弊社の Forum に掲載されています。何か問題がありましたら、ご連絡ください。
現在ご利用になれる機能¶
現在の機能の概要を紹介します。本リリースの新機能一覧は以下の 主な修正と変更 を参照してください。
- ビデオとゲームデータストリームの自動同期。
- YouTube および Twitch へのライブ動画配信。
- 埋め込み型 Web ページ用 Javascript SDK。
- オーディオ/ビデオおよびデータの複数のソース。
- 任意の追加ゲームイベントおよび通知のライブ配信。
- スケーラブル イベント メッセージ システム。
- Windows C++ API、C# ラッパー。
- ビデオエンコード (H264 + AAC)。
- Unity3D 統合 (ゲームと管理)。
- Unreal Engine 統合 (ゲームと管理)。
- D3D11 または未処理フレームのビデオキャプチャ。
- WASAPI オーディオキャプチャ。
- ローカル、リモートクラスタの管理用ツール、スクリプト。AWS および Azure 用サンプルスクリプト。
- ライブ動画編集と基本コンポジション効果 (ベータ版)。
- RTMP Ingest サーバー (ベータ版)。
- サービス制御用 REST API (ベータ版)。
- メトリクス フィード (ベータ版)。
- 負荷テスト用ライブラリ。
- 複数の統合サンプル。
- 詳細な解説書。
主な修正と変更¶
genvid-azure-image create-images コマンドの改良¶
このコマンドは、 image および blob タイプの中間リソースを削除するようになりました。–keep-intermediate-resources という新しい引数を、デバッグ用に中間リソースを保持するために追加しました。
このコマンドは、プライベートなアクセスレベルを持つソースおよびデスティネーションのストレージコンテナで動作するようになりました。これは、 Azure CLI が、プライベートコンテナにアクセスできるサブスクリプションでログインしている限り、機能します。このコマンドは、 blob コンテナにアクセスする前に、 Azure CLI を使って内部でアクセスキーの取得を試み、取得できた場合にはそれを使用します。
クラスタ設定¶
クラスタ設定の新しいフレームレート値¶
クラスタ設定出力セクションにフレームレート値を追加しました。入力フレームレートから独立してストリーミングプロバイダに送信されるビデオストリームのフレームレートを定義できるようになります。
改善されたフローに合わせて改訂されている解説書。¶
SDK 解説書に加えられる一部の大きな変更の準備のため、主なセクションの数を減らし、内容の一部を移動しました。1.30.0 の改訂ではその内容をわかりやすくするために、既存の解説書のセクションを再編成しました。
- インストールされたサンプルの更新についての情報は、サンプル、およびリリースとアップグレードに関する注意事項の両方のセクションにあります。
- 導入部には、Genvid SDK のアーキテクチャとその動作についての情報が含まれます (以前はクイックツアーにありましたが、削除しました)。
- Genvid SDK に含まれる各種ツールに関する情報は新しい「Genvid ツール統合」セクションにあります (以前はサンプルと参照の両方のセクションにありました)。
その他変更点や修正点¶
- [解説書] YouTube セクションにプライバシーオプション、遅延オプション、またデータとキャッシュの関係についての情報を追加。
- [解説書] Firefox がスタンドアロンプレイヤーと同期しない既知の問題を解消。
- [解説書] genvid.compose-gameframes.framesize メトリックのタイプが正しくないという問題を解決。
- [解説書] genvid.gvencode-compose framereceivedfps と framesentfps が不足していたエントリーを追加。
- [解説書] 著作権情報をアップデート。
- [解説書] Python 3.8 に飛ばなかった Python の公式解説書へのリンクを修正。
- [解説書] 主なリファクタリングの準備でドキュメントフォルダの階層構造をアップデート。
- [sdk]
GenvidSDKCSharp.cs
にStatusFailed()
対応について情報を追加。 - [sdk] 複数のフレームが同時に送信される問題を解決。
- [sdk] インストーラのライセンスを、更新されたバージョン 07/30/2021 にアップデート。
- [sdk]
Genvid_GetParameterPointer
のパラメータキーが null の時に起こるクラッシュを解決。 - [unity-plugin] NewtonSoft.JSON の依存性を JsonUtility の使用と置き換え。
- [toolbox] より使いやすいインターフェイスの新しい
PackageArchiver
class をgenvid.toolbox
に追加。 - [toolbox]
genvid.toolbox.Package
を廃止し、genvid.toolbox.PackageFactory
を採用。詳細は、アップグレードに関する注意事項を参照してください。 - [toolbox]
genvid.toolbox.Package
を廃止し、genvid.toolbox.PackageFactory
を採用。詳細は、アップグレードに関する注意事項を参照してください。 - [toolbox] より使いやすいインターフェイスの新しい
PackageArchiver
class をgenvid.toolbox
に追加。 - [toolbox] 常にアーカイブファイルの名前と内容に基づいてチェックサムを使用するように
genvid-sdk package
コマンドを改良。 - [toolbox] PackageArchiver を使用するため
SDK.update_archive
コマンドを廃止。 - [ツールボックス] ツールボックス CLI による環境変数 VAULT_TOKEN_FILE および VAULT_KEYS_FILE のサポートを追加。
- [ツールボックス] Consul 設定を変更せずに
SDK.load_config
を複製する新しいメソッドload_config_folder
を追加。 - [ツールボックス]
load_nomad_template_job
をProjectTool
に移動することで再利用性を改善。 - [ツールボックス]
ConsulTemplateTool
ではなくProjectTool
から派生させることでRuntimeTool
およびSDK
classes を改良。 - [ツールボックス] ツールボックスがサービス用に CONSUL_HTTP_ADDR を設定する GENVID_DEFAULT_IP 環境変数を使わない問題を修正。この問題で、CONSUL_HTTP_ADDR が GENVID_DEFAULT_IP に合わせて明示的に設定されていない場合に
bastion-api
がクラッシュしていました。 - [ツールボックス] は非推奨です。詳細については、アップグレードノートを参照してください。詳しい情報はアップグレードに関する注意事項を参照してください。
- [ツールボックス] ローカルサービスに対してエラーを返していた
genvid-bastion log
コマンドを修正。 - [ツールボックス]
genvid-bastion log
コマンドのすべての登録済みログのサポートを追加。 - [ツールボックス]
genvid-sdk log
とgenvid-bastion log
のすべてのログをリスト化する機能を追加。 - [ツールボックス] 使用されなくなった
BastionTool.SETUP_LOGS
を廃止。 - [ツールボックス]
chardet
モジュールの依存関係が欠けていた問題を修正。 - [ツールボックス]
GENVID_BASTION_URL
が設定されている時にgenvid-sdk
コマンドは Consul にもアクセスする必要があるという問題を修正。 - [ツールボックス] SSL プロキシの背後で swagger が使われている時の Swagger UI 用のベース URL を修正。
- [installer] デフォルトのインストールフォルダとレジストリが実際の製品名と一致するように修正。修正後のインストールフォルダは
Genvid Technologies\\Genvid SDK X.Y.Z.W
と呼ばれ、レジストリキーはSOFTWARE\\Genvid Technologies\\Genvid SDK X.Y.Z.W
にあります。 - [composed] composeD を再スタートした後にプログラムコンポジションが記憶されていないという問題を修正。
- [composed] ストリームバスがフルでメッセージが削除された時に、削除された RTMSP メッセージの数をログとメトリクスに追加。
- [composed] GVEncode との接続がアクティブでない時に、Composed 内でデータフレームと遅延 A/V フレームのキャッシュをクリアする機能を追加。
- [gvencode] コンポジションがオンでゲームが再スタートされた時に音声が非同期される問題を修正。
- [gvencode] 終了したソースがデコーダを正しく破棄しない問題を修正。
- [gvencode] Sink Filter のオーディオパケットが長いストリーミングセッションの間に蓄積される問題を修正。
- [gvencode] 重複したビデオフレームがログに正しく報告されない問題を修正。
- [gvencode] ビデオフレームの補償が起きた時に発生するオーディオ/ビデオの非同期を修正。
- [gvencode] ビデオの補償が起きた時のリソースの漏れを修正。
- [samples] ツールボックスから生成される SSL 認証を使うことでローカル SSL 制御を改善。
- [studio] シーンからトランジションを削除。現在トランジションはグローバルで、カットされる次のシーンに適用されます。
- [studio] gvencode がダウンした時に、モニタのストリームへ自動再接続するよう修正。
- [ingest] composeD ジョブが再スタートされた時に、Ingest ジョブが再スタートされる問題を修正。
- [remotegui] RemoteGUI が重複フレームを表示しなかった問題を修正。
- [loadtester]
loadtester
の代わりにloadtest
がプレフィックスとして使用されることについて解説書を修正。 - [metrics] 表示される値がストリームタイプであるということを示すメトリクスタグ内のテキストが欠けていたことを修正。
- [genvid-ami] Python 3.8.6 と PIP 21.1 を使用するようゲームマシーンをアップデート。
- [aws]
modify-permissions
およびdescribe-permissions
コマンドをgenvid-ami
に追加。詳しい情報は AMI の管理 セクションを参照してください。 - [aws] すべてのサンプルクラスタでゲームとサーバー AMI 両方の AMI オーナーを設定する機能を追加。詳しい情報は解説書とアップグレードに関する注意事項を参照してください。
- [nats] Windows と Linux の NATS サーバーを 2.0.4 から 2.2.6 へアップグレード。
- [tick] Tick サンプルで使われるアプリをその最新バージョンにアップグレード。合わせて Chronograf ダッシュボードを更新。
- [cluster-api] サービス用のログがない時の問題を修正。「404 存在しません」の代わりに 500 ステータスコードを返していた。
- [gvencode, ingest] 異なるビデオモードで OBS のスタートやストップを続けると黒いフレームを表示するようになる問題を修正。
- [sdk, composed, gvencode] 単調増加クロックを使用することで Genvid クロックの精度を改善。
- [Web サンプル] ビデオプレイヤーが準備できている場合はオーバーレイのみ表示することでデザインを改善。
- [Web サンプル] 出力フレームレートオプションを Web サンプルに追加することで視認性を改善。
既知の問題¶
プロキシを使用している場合に Compose ウィンドウが使用できない。¶
Bastion の将来のバージョンには、異なるマシンからのアクセスを許可するリモートサーバーが追加されます。現行バージョンではこの機能を限定的にサポートしており、Bastion ホストがクラスタファイアウォールに守られている場合に (Amazon EC2 マシンなど)、問題が発生することがあります。
回避方法としては、マシンのローカル IP がクライアントマシンからアクセスできるように、Bastion マシンへの VPN 接続を行うことです。
オートカットのチェックボックス設定はローカルにのみ保存されます。¶
Studio では、Scene Widget 内の自動カットチェックボックスの設定はローカルストレージにのみ保存されます。ブラウザのキャッシュがクリアされるとユーザーからの入力もクリアされます。また、Studio セッション終了時に自動カットが 「on」 になっている場合は、Studio セッションを再び開始すると、デフォルトで 「off」 に戻ります。
オーディオがマイクの音声やループを無限にキャプチャする。¶
WASAPI のオーディオ自動キャプチャモードを使用した時に、マシンのデフォルトのオーディオ-デバイスを通過するサウンドがすべてキャプチャされてしまいます。これには、システムアラートやマイク入力だけでなく、Web ブラウザも含まれます。ゲームを実行しているのと同じローカルマシンを使用してゲームストリームをテスト視聴すると、ゲームは自分自身のオーディオストリームを~10秒の遅延でキャプチャします。これが次第に音質が劣化する (ストリーミングされる度に圧縮されるため) エコーを生み出します。
オーディオを無効にするには、次の 2 つの方法があります。
- 設定で
settings.encode.input.silent
をtrue
にする。 (デフォルト設定をする。) - raw オーディオキャプチャを使用する (Unity のデフォルト設定)。
Nomad を使用して起動していない場合、Genvid SDK が統合されたアプリケーションは一度に 1 つしか実行できません。¶
Genvid SDK を使用したアプリケーションを Nomad を使用せずに起動した場合、デフォルトのセッション名が割り振られます。Unity エンジンや Unreal エンジンでアプリケーションをテストするときや、アプリケーションを手動で起動するときに便利です。
現在、環境変数 GENVID_SESSION_NAME をユニーク名に変更していない場合、Genvid SDK は、この方法で起動した複数のアプリケーションをサポートできません。Nomad を使用してアプリケーションを起動することで、この問題を回避することもできます。
この問題は、今後のリリースで修正予定です。
Twitch および YouTube の同期について¶
テストにおいて、Twitch と YouTube でのライブ配信時に同期の問題が発生することを確認しています。詳細と回避策については Twitch および YouTube を参照してください。
Azure のレポートでは、要求されたインスタンスサイズが利用できない。¶
Azure では、ゲームマシン用の計算インスタンスタイプ Standard_NV6 を使用しています。一部のアカウントでは、このインスタンスタイプのプロモバージョンしか利用できません (Standard_NV6_Promo)。
Azure モジュールで Terraform のセットアップを行うと、エラーが発生することがあります。
The requested size for resource 'XXXX-game-1' is currently not available in location 'XXXX'
回避策としては、Terraform の設定ページで instance_game_type を Standard_NV6_Promo に変更し、コマンドページで Plan apply -> Apply を再度行ってください。
Twitch における iPhone の問題¶
iOS デバイス上では Twitch API は getPlaybackStats()
呼び出しの属性の値を返さないため、同期のパフォーマンスが不正確であったり、一貫性がなかったりすることがあります。
スタンドアロンプレーヤーでの iOS デバイスへのストリーミングは現在、機能していません。¶
スタンドアロンプレーヤーでの iOS デバイス (iPhones と iPads) へのストリーミングは現在、機能していません。この問題は、今後のリリースで修正予定です。
インターネットの接続速度が遅いと、Ingest の実行中にゲームデータが非同期になることがあります。¶
Ingest で Studio を実行している場合、インターネット接続の速度が低下すると、ゲームデータがビデオストリームから非同期化されることがあります。スローダウンが解消すると、ゲームデータはビデオストリームに再同期されます。
RemoteGUI インターフェイスでは、ローカルクラスタのリンクは無効です。¶
ローカルクラスタで RemoteGUI を使用している場合、コンポジション、エンコーディング、SDK GUI ボタンからリンクをクリックしてタブを開くと、リンクが無効になります (青から赤に変わります)。当該タブを閉じるとリンクは再び有効になります。
Azure でアベイラビリティゾーンを変更する際には、リソースを破壊して再構築する必要があります。¶
Azure で AZ を変更する際に、パブリック IP が仮想マシンから切り離されていないため、パブリック IP の削除に失敗することがありました。これは、Terraform プロバイダのバグです。詳しくは、Hashicorp Github の issue をご覧ください。
回避策としては、問題のあるパブリック IP を Azure ポータルの仮想マシンから手動で切り離します。
ツールボックスは Python 3.9.x との完全な互換性はありません。¶
Genvid ツールボックスは、現時点では Python 3.9.x との完全な互換性はありません。ツールボックスを使用する際の問題を避けるため、Python をバージョン 3.8.x にダウングレードすることをお勧めします。
genvid-sdk upload-images-sdk
コマンドが、Azure Cloud 上での Docker イメージのアップロードに失敗します。¶
一部の Docker イメージは、サイズが大きいため、 genvid-sdk upload-images-sdk
コマンドを使用して Azure Cloud にアップロードできません。(SSL エラーと Max retries exceeded
のメッセージが表示されます)。
回避策:
- Azure UI を開きます。
- イメージを手動でアップロードします。
- もう一度
genvid-sdk upload-images-sdk
を起動します。
Chroma Key Filter 使用時のパフォーマンスの問題¶
Chroma Key Filter を使用する場合、エンコードマシンには c5.4xlarge 以上のものを使用することをお勧めします。性能の低いインスタンスでは、システムがいくつかのフレームをメモリに蓄積することになり、メモリ不足となる場合があります。
蓄積されるフレームの量は、エンコードパラメータ、ソースの FPS、ソース画像の内容の変化、内容の密度など、さまざまな要因に左右されます。 GVEncode
のメモリー使用量の監視については、Hashicorp documentation を参照してください。
既存の AWS クラスタでサブドメインを更新する際に、サブドメイン NS レコードを手動で削除する必要があります。¶
basic_cluster_alb_ssl
または minimal_cluster_alb_ssl
を使用して AWS クラスタを作成する場合、ドメインとサブドメインが提供されます。既存クラスタのサブドメインを更新する場合、以前のサブドメインの route53 の NS レコードをメインドメインから手作業で削除する必要があります。これは Terraform 内での NS レコードの処理のためです。
AWS を使用しているクラスタ basic_cluster_alb_ssl
のサブネットを削除できません。¶
basic_cluster_alb_ssl
の subnet_cidr_block_size
を変更したり、AZ の数を減らしたり、既存の AZ を並べ替えたりすると、クラスタはサブネットを削除しようとして止まってしまいます。
設定を再適用しても、問題は解決しません。
回避策: クラスタを削除して作り直してください。
Bastion クラスタの設定ページのモーダルウィンドウが閉じない。¶
クラスタの Bastion 設定 ページで、クリックしても、カスタムタグの Properties モーダルウィンドウが閉じない。
回避策としては、もう一度 Properties をクリックしてモーダルウィンドウを閉じてください。
Terraform をアップグレードすると 『Error: Failed to query available provider packages』 が発生します。¶
既存のクラスタを Terraform 0.14 にアップグレードする場合、Error: Failed to query available provider packages が発生することがあります。Terraform のロックファイルを %USERPROFILE%.genvidterraformworkdir{cluster name}tf から削除してクラスタを初期化しなおすと解決することができます。
制限事項¶
誤った順序で設定をロードすると、値が上書きされることがあります。¶
クラウド上で SSL を使用している場合でも、ローカルクラスタで SSL を使用している場合でも、Web サンプルを読み込む前に youtube.sample.hcl
を読み込むと、Web サンプルは web.hcl
ファイルから embed_ssl に関連付けられた値を上書きします。
NTP の時間オフセットが大きいと、ストリームの再生ができなくなります。¶
大きな NTP 時間オフセットが発生した場合、ストリームの再生が停止する可能性があります。回避策としては、ゲーム機が自動的に時計を更新するように設定されていることを確認してください。ローカル設定では、AWS IP アドレスを pool.ntp.org
に置き換えてください。
詳細については、 AWS 設定セクション を参照してください。
Studio は、複数のウィンドウから同じコントロールの入力を受け取ることはできません。¶
Studio が、複数のブラウザウィンドウで開かれていて、異なるソースから 1 つのコントロールに入力を受信した場合、最後の値は最新のものに更新されるのではなく、異なる入力間でバウンスされます。たとえば、Audio Mixer Widget でユーザーが Master Gain のスライダを 20 db に変更し、別のユーザーが 0 db に変更した場合、スライダハンドルは 0 db に設定される代わりに 20 db と 0 db の間でバウンスします。
この問題が解決されるまで、複数の Studio ウィンドウから 1 つのコントロールへ入力することはお勧めできません。
Windows がスリープ状態から復帰後、アプリケーションが正常に動作しない。¶
Nomad は、それ自体も含み、スリープ中のジョブで問題が発生する場合があります。Nomad 側で修正される可能性は低いものの、プロダクション環境では発生しません。最善の回避方法としては、サービス実行中は Windows がスリープ状態にならないようにするか、 genvid-bastion reinstall
でサービスを開始しなおすことです (genvid-bastion restart
だけでは不十分です)。
SDK はフレームレートを 1.0 以下に固定します。¶
問題を回避するためにストリームのフレームレートを 1.0 に下げました。フレームレートが 1.0 以下の場合は、SDK が 1.0 FPS に固定します。
Azure リソースグループ名のデフォルト値が長すぎる場合がある。¶
変数 resource_group_name
に値が設定されていない場合、 {bastionid}-{clustername}
の組み合わせで設定されます。そのため、Azure リソースグループ名が最大文字数である 64 文字よりも長くなってしまう場合があります。
この問題を避けるために、変数 resource_group_name
には必ず 64 文字以下の値を指定してください。
Azure での命名についての詳細は Azure Github を参照してください。
AWS クラスタサブネットの競合エラー¶
AWS クラスタの subnet_cidr_block_size
を減らして AZ 数を増やすことを同時に行うと、サブネットの競合エラーが発生します。
この問題が発生した場合、設定を適用しなおしてください。
クラスタの更新時に、Azure ディスクに新しいタグが追加されない。¶
新しいタグを Azure クラスタに適用する際、ディスクを所有する仮想マシンインスタンスが apply
プロセス中に再作成されない限り、 disk
にタグは適用されません。
回避策としては、クラスタを削除して再作成することで問題が解決します。
クラスタ名は 64 文字までです。¶
クラスタ名は、Windows のファイルシステムの制限により、64 文字に制限されています。ファイルディレクトリの最大文字数には、システムのユーザー名やクラスタ名などが影響します。
技術的には 64 文字以上にすることは可能ですが、結果は予測できないものになります。