Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ConcertSyncClient > FConcertActivityStream > FConcertActivityStream::Read

Light Theme

Dark Theme

FConcertActivityStream::Read

Reads all buffered activities.

Windows

MacOS

Linux

References

Module	ConcertSyncClient
Header	/Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncClient/Source/ConcertSyncClient/Public/ConcertActivityStream.h
Include	#include "ConcertActivityStream.h"
Source	/Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncClient/Source/ConcertSyncClient/Private/ConcertActivityStream.cpp

Syntax

bool Read
(
    TArray< TSharedPtr< FConcertClientSessionActivity >> & InOutActivities,
    int32 & OutReadCount,
    FText & OutErrorMsg
)

Remarks

Reads all buffered activities. Call this function periodically (between frames, not in a tight loop). Every times this function is called, all buffered activities are consumed (appended to InOutActivities buffer) and a new request is fired to refill the internal buffer. The activities are streamed from the most recent to the oldest.

Returns

True if all activities were consumed, false otherwise.

Parameters

Parameter	Description
InOutActivities	The array to which the activities should be appended.
OutReadCount	The number of activities consumed and appended to InOutActivities. Can be 0 if consumed faster than received form the server.
OutErrorMsg	Contains the last error message, if any or an empty text.

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

Take our survey

Dismiss