UPixelStreamerInputComponent::AddJsonStringValue

Helper function to add a string field to a JSON descriptor.

Windows
MacOS
Linux

References

Module

PixelStreaming

Header

/Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamerInputComponent.h

Include

#include "PixelStreamerInputComponent.h"

Source

/Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Private/PixelStreamerInputComponent.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="PixelStreamer Input")
void AddJsonStringValue
(
    const FString & Descriptor,
    FString FieldName,
    FString StringValue,
    FString & NewDescriptor,
    bool & Success
)

Remarks

Helper function to add a string field to a JSON descriptor. This produces a new descriptor which may then be chained to add further string fields.

Parameters

Parameter

Description

Descriptor

The initial JSON descriptor which may be blank initially.

FieldName

The name of the field to add to the JSON.

StringValue

The string value associated with the field name.

NewDescriptor

The JSON descriptor with the string field added.

Success

True if the string field could be added successfully.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss