リリース & アップグレードノート

Genvid SDK の最新バージョンのリリースノートを以下に記載しています。このセクションには、SDK の これまでのリリース および リリース & アップグレードノート が含まれています。



Genvid SDK 1.27.0

Genvid Technologies SDK 1.27.0. へようこそ。このリリースで、安定した状態で統合を行うことができ、ローカルでの開発や、限定したクラウドでのデプロイに使用することができます。プロダクションを完全にデプロイするための一部の機能はまだ実装されていませんが、他のソフトウェアによって提供可能です。プロダクションのデプロイを予定している場合、support@genvidtech.com にお問い合わせください。

プロダクションの快適なデプロイを行うための機能がすべて備わるまで、定期的にリリースの更新を行っていきます。リリース間のアップグレードをスムーズに行うことができ、可能な限り後方互換サポートを行えるよう、常に努力しています。既知の問題や回避策については、 フォーラム でご参照ください。不明な点などございましたら、弊社までお問い合わせください。

現在の機能

現在の機能の概要を紹介します。本リリースの新機能一覧は以下の 主な修正と変更 を参照してください。

  • ビデオとゲームデータストリームの自動同期。
  • YouTube および Twitch へのライブ動画配信。
  • 埋め込み型 Web ページ用 Javascript SDK。
  • オーディオ/ビデオおよびデータの複数のソース。
  • 任意の追加ゲームイベントおよび通知のライブ配信。
  • スケーラブル イベント メッセージ システム。
  • Windows C++ API、C# ラッパー。
  • ビデオエンコード (H264 + AAC)。
  • Unity3D 統合 (ゲームと管理)。
  • Unreal Engine 統合 (ゲームと管理)。
  • D3D11 または未処理フレームのビデオキャプチャ。
  • WASAPI オーディオキャプチャ。
  • ローカル、リモートクラスタの管理用ツール、スクリプト。AWS および Azure 用サンプルスクリプト。
  • ライブ動画編集と基本コンポジション効果 (ベータ版)。
  • RTMP Ingest サーバー (ベータ版)。
  • サービス制御用 REST API (ベータ版)。
  • メトリクス フィード (ベータ版)。
  • 負荷テスト用ライブラリ。
  • 複数の統合サンプル。
  • 詳細な解説書。

主な修正と変更

Windows Server 20H2 アップデート

マイクロソフトは先日、サービス終了が近づいている機器を対象に、Windows Server バージョン 20H2 への自動アップデート件数を増やしました。このアップデートにより、Genvid SDK のバージョン 1.26 以前でいくつかの問題が発生しました。この問題を解決するために、1.27 では、アップデートされたデバイスとアップデートされていないデバイスの両方に対応するパッチが含まれています。

このアップデートの詳細については、 こちらのマイクロソフトのページをご覧ください。

Terraform 0.14 の準備

Terraform 0.14 (Genvid SDK 1.28 リリースで実装予定) へのアップデートの準備のため、 SDK コードを大幅に整理しました。今回のアップグレードに関する注意事項 1.28 では、Terraform アップデートの詳細について説明します。

その他変更点や修正点

  • [解説書] genvid.toolbox.Backupgenvid.toolbox.ConsulBackupgenvid.toolbox.TerraformBackup, genvid.toolbox.TerraformProvidergenvid.toolbox.VaultBackupgenvid.toolbox.VersionBackup の解説を追加し、Python class の解説を改善。
  • [sdk] エンコーダのヘルスチェックにブロードキャストエラーレポートを追加。
  • [sdk] SDK の初期化中に frontend.gcl.sent メトリクスが送信されない問題を修正。
  • [sdk] オーディオキャプチャで希望の FPS でフレームが出力されない問題を修正。
  • [ツールボックス] s3 images bucket-configuration がない場合の例外処理を追加。
  • [ツールボックス] Windows 上で動作する Consul/Vault/Nomad にログローテーション設定を追加。
  • [ツールボックス] genvid.toolbox.LocalService メソッド print_log からパラメータ stdout を削除。出力ログとエラーログが、 ログディレクトリ内の同じファイルに書き込まれるようになりました。
  • [ツールボックス] TerraformProvider のバージョンパラメータが非推奨になりました。
  • [gvencode] 同期がエンコーダの障害に遭遇した場合、gvencode がストリームに失敗する問題を修正。
  • [bastion-api] 新規ログ作成時にファイル名を入力するテキストボックスをコンボボックスに変更し、ドロップダウンリストからオプションを選択するか、カスタム名を入力できるようにすることで、UI を改善。
  • [bastion-api] その変数がモジュールにとって未知のものであっても、Terraform のグローバル設定が Terraform モジュールの入力変数として渡される問題を修正。
  • [bastion-api] プロフィールの読み込みに失敗したときのエラーメッセージを改善し、エラーの原因を明確化。
  • [bastion-api] Terraform 設定ページのプロパティボックスに固定の最小の高さを割り当てることで、下部にラベルを追加してもレイアウトが統一されるように、UIを改善。
  • [bastion-api] Bastion API で Provider.Meta フィールドを非推奨にしました。
  • [bastion-api] Bastion API で Provider.Meta.Alias フィールドを Provider.Alias に移動。
  • [bastion-api] Bastion API で Provider.Meta.Version フィールドを非推奨にしました。
  • [aws] Terraform モジュール minimal_cluster から未使用の変数 cidr を削除。
  • [aws] Terraform モジュール minimal_setup_ami から未使用の変数 game_az を削除。
  • [aws] Terraform モジュール basic_cluster およびサブモジュール cluster/sample から未使用の変数 region を削除。
  • [aws] Terraform サブモジュール genvid/aws から未使用の変数 user を削除。
  • [aws] Terraform モジュール minimal_cluster_alb_ssl および basic_cluster_alb_ssl から未使用の変数 validation_method を削除。
  • [aws] AWS クラスタの ami_prefix 変数名を game_ami_prefix に変更。
  • [aws] すべての AWS クラスタに server_ami_prefix 変数を追加。
  • [azure] 変数 trusted_security_groupsazurerm_basic_cluster_alb_ssl および azurerm_basic_cluster モジュールから削除。
  • [azure] 変数 toolbox_locationazurerm_basic_cluster モジュールに追加。
  • [azure] server_image_prefix 変数をすべての Azure クラスタに追加。
  • [terraform] AWS の subdomain_name のデフォルト値を null に変更。詳細は、 basic/basic_cluster_alb_ssl および basic/minimal_cluster_alb_ssl を参照してください。
  • [terraform] AWS の basic_cluster_alb_sslminimal_cluster_alb_ssl のゲーム AMI のデフォルト値を genvidtech から default に変更し、ツールボックスのデフォルト動作と一致させました。
  • [aws, azure] 新しいタグ genvid:terraform-module-namegenvid:terraform-module-version をすべてのクラスタに追加。
  • [bastion-ui] Terraform Configuration ページの UI を改善し、ジョブコントロール列の下に正しいボタンを表示することで、ページのリロード時にボタンの状態が変わらないようにしました。
  • [bastion-ui] Terraform Configuration ページで、クラスタ上でモジュールのインポートが実行されているときに、クラスタのステータスが BUSY ではなく DOWN と表示される問題を修正。
  • [bastion-ui] Terraform 設定の custom_tags 変数の UI を改善。
  • [bastion-ui] Bastion ID の検証でエラーが発生したときに、誤解を招くような警告メッセージが表示される問題を修正。
  • [bastion-ui] Bastion ID とクラスタ ID の最小、最大文字数の制限に関する警告を追加し、 UI を改善。
  • [consul] Consul サーバーとクライアントを 1.8.4 から 1.9.3 にアップグレード。
  • [eventsd] NATS の再接続時に発生する Eventsd の読み書きの問題により、まれに競合状態が発生することがある問題を修正。
  • [sdk, composed, gvencode] Windows のスリープ時間が長すぎる場合、オーディオ/ビデオのストリーミングが機能しない問題を修正。
  • [sdk, composed, gvencode, gcl] メトリクスをバッファで送信することで、ネットワーク使用率を改善しました。

既知の問題

プロキシを使用している場合に Compose ウィンドウが使用できない。

Bastion の将来のバージョンには、異なるマシンからのアクセスを許可するリモートサーバーが追加されます。現行バージョンではこの機能を限定的にサポートしており、Bastion ホストがクラスタファイアウォールに守られている場合に (Amazon EC2 マシンなど)、問題が発生することがあります。

回避方法としては、マシンのローカル IP がクライアントマシンからアクセスできるように、Bastion マシンへの VPN 接続を行うことです。

Firefox でのスタンドアロンプレイヤーが動作しない。

スタンドアロンプレイヤーを適切に動作させるためには、読み込み可能なストリームを Firefox で有効にする必要があります。about:config URL で、dom.streams.enabledjavascript.options.streamstrue に設定する必要があります。

オートカットのチェックボックス設定はローカルにのみ保存されます。

Studio では、Scene Widget 内の自動カットチェックボックスの設定はローカルストレージにのみ保存されます (ブラウザのキャッシュがクリアされるとユーザーからの入力もクリアされます)。また、Studio セッション終了時に自動カットが「オン」になっている場合は、Studio セッションを再び開始すると、デフォルトで「オフ」に戻ります。

オーディオがマイクの音声やループを無限にキャプチャする。

WASAPI のオーディオ自動キャプチャモードを使用した際に、マシンのデフォルトのオーディオデバイスを通過するすべてのサウンドがキャプチャされてしまいます。Web ブラウザだけでなく、システムアラート、マイク入力も含まれます。ゲームを実行しているのと同じローカルマシンを使用してゲームストリームをテスト視聴すると、ゲームは自分自身のオーディオストリームを~10秒の遅延でキャプチャします。これが次第に音質が劣化する (ライブ配信される度に圧縮されるため) エコーを生み出します。

オーディオを無効にするには、次の 2 つの方法があります。

  • 設定で settings.encode.input.silenttrue にする (デフォルト設定) 。
  • raw オーディオキャプチャを使用する (Unity のデフォルト設定)。

Nomad を使用して起動していない場合、Genvid SDK が統合されたアプリケーションは一度に 1 つしか実行できません。

Genvid SDK を使用しているアプリケーションを Nomad なしで起動した場合、デフォルトのセッション名が割り当てられます。Unity engine や Unreal engine でアプリケーションのテストを行う場合や、アプリケーションを手動で起動する際に便利です。

現在、環境変数 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_typeStandard_NV6_Promo に変更し、コマンドページで Plan apply -> Apply を再度行ってください。

Twitch における iPhone の問題

iOS デバイス上では Twitch API は getPlaybackStats() 呼び出しの属性の値を返さないため、同期のパフォーマンスが不正確であったり、一貫性がなかったりすることがあります。

スタンドアロンプレーヤーでの iOS デバイスへのストリーミングは現在、機能していません。

スタンドアロンプレーヤーでの iOS デバイス (iPhone、iPad) へのストリーミングは現在、機能していません。この問題は、今後のリリースで修正予定です。

インターネットの接続速度が遅いと、Ingest の実行中にゲームデータが非同期になることがあります。

Ingest で Studio を実行している場合、インターネット接続の速度が低下すると、ゲームデータがビデオストリームから非同期化されることがあります。スローダウンが解消すると、ゲームデータはビデオストリームに再同期されます。

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 のメッセージが表示されます)。

回避策:

  1. Azure UI を開きます。
  2. イメージを手動でアップロードします。
  3. もう一度 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_sslsubnet_cidr_block_size を変更したり、AZ の数を減らしたり、既存の AZ を並べ替えたりすると、クラスタはサブネットを削除しようとして止まってしまいます。

設定を再適用しても、問題は解決しません。

回避策: クラスタを削除して作り直してください。

Bastion クラスタの設定ページのモーダルウィンドウが閉じない。

クラスタの Bastion 設定 ページで、クリックしても、カスタムタグの Properties モーダルウィンドウが閉じない。

回避策としては、もう一度 Properties をクリックしてモーダルウィンドウを閉じてください。

制限事項

誤った順序で設定をロードすると、値が上書きされることがあります。

クラウド上で 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 文字以上にすることは可能ですが、結果は予測できないものになります。