GenvidStreams

バージョン 1.12.0 で追加.

ヘッダー:Genvid/Public/GenvidStreams.h 実装:Genvid/Private/GenvidStreams.cpp

class UGenvidStreams

GenvidStreams は、任意のゲーム データをストリーミングすることができる基本 class です。 UGenvidSession に直接依存します。

** 機能 **

virtual void Create()

すべての定義済みストリームを作成します。

virtual void Destroy()

すべての定義済みストリームを破棄します。

static UGenvidStreams *CreateStreams(...)

Genvid ストリームの作成に使用する関数。

void InternalReceiveBeginPlay()

AActor BeginPlay のスーパー セットとして機能します。GenvidStreams class の作成時に呼び出される最初の関数です。

void InternalReceiveTick(float DeltaSeconds)

Tick 可能な UObject のスーパーセットとして動作します。オブジェクトが生きている場合に呼び出されます。

void InternalReceiveEndPlay(const EEndPlayReason::Type EndPlayReason)

AActor EndPlay のスーパー セットとして機能します。class の破棄を開始すると最後に呼び出される関数です。

void ReceiveMatchHasStarted()

マッチ開始時にトリガされます。cpp:func:~UGenvidStreams::BeginPlay の後、マッチ開始直前に呼び出されます。

void ReceiveMatchHasEnded()

マッチ終了時にトリガされます (Tick は継続)。マッチ終了時、cpp:func:~UGenvidStreams::EndPlay の直前に呼び出されます。

void SubmitGameData(const FString &streamName, const FString &gameData, ...)

ストリーム名に紐づく gameData を Genvid MILE SDK に送信します。

void SubmitAnnotation(const FString &streamName, const FString &annotation, ...)

ストリーム名に紐づくアノテーション データを Genvid MILE SDK に送信します。

void SubmitNotification(const FString &streamName, const FString &notification)

バージョン 1.24.0 で撤廃: 代わりに、 UGenvidSession::SubmitNotification を使用してください。

プロパティ

TArray<FGenvidStream> Streams

作成するすべてのストリームを含む構造体の配列。

bool bCompressJsonString

構造体のデータを JSON から ZIP に圧縮します。

bool bIsCreated

ストリームが作成されているかどうかレポートする読み取り専用の変数です。

class FGenvidStream

単一のデータストリームを表す class です。

** 機能 **

void TriggerStream(float DeltaTime)

実行間隔に基づいて OnGenvidStreamDelegate を呼び出すかどうか決定。

void TriggerBeginPlay()

OnBeginPlayDelegate の呼び出し。

void TriggerMatchHasStarted()

OnMatchHasStartedDelegate の呼び出し。

void TriggerMatchHasEnded()

OnMatchHasEndedDelegate の呼び出し。

void TriggerEndPlay()

OnEndPlayDelegate の呼び出し。

プロパティ

FString Name

このストリームの名前。

float Framerate

このストリームの最大送信速度。

FOnGenvidStream OnGenvidStreamDelegate

Framerate がゼロまたは実行間隔以下ならば、毎 Tick ごとに呼び出されるデリゲート。

FOnGenvidStream OnBeginPlayDelegate

BeginPlay イベントで呼び出されるデリゲート。

FOnGenvidStream OnMatchHasStartedDelegate

新規マッチの開始時に呼び出されるデリゲート。

FOnGenvidStream OnMatchHasEndedDelegate

マッチの終了時に呼び出されるデリゲート。

FOnGenvidStream OnEndPlayDelegate

EndPlay イベントで呼び出されるデリゲート。

class FOnGenvidStream

ストリームの Name を保持する Unreal Dynamic Delegate と FString パラメータ。 具体的には次のように宣言:

DECLARE_DYNAMIC_DELEGATE_OneParam(FOnGenvidStream, const FString&, Id)