1. Epic GamesDeveloper
  3. IAvaPlaybackClient

IAvaPlaybackClient

API > API/Plugins > API/Plugins/AvalancheMedia

   
Name IAvaPlaybackClient
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Playback/IAvaPlaybackClient.h
Include Path #include "Playback/IAvaPlaybackClient.h"

Syntax

class IAvaPlaybackClient

Constructors

Name Remarks Include Path Unreal Specifiers

IAvaPlaybackClient()

   Playback/IAvaPlaybackClient.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IAvaPlaybackClient()

   Playback/IAvaPlaybackClient.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BroadcastStatCommand ( const FString& InCommand,
bool bInBroadcastLocalState
)

 Send a stat command to all connected servers. Playback/IAvaPlaybackClient.h  

const TArray< FString > & GetMediaOutputIssueMessages ( const FString& InServerName,
const FString& InChannelName,
const FGuid& InOutputGuid
) const

   Playback/IAvaPlaybackClient.h  

EAvaBroadcastIssueSeverity GetMediaOutputIssueSeverity ( const FString& InServerName,
const FString& InChannelName,
const FGuid& InOutputGuid
) const

   Playback/IAvaPlaybackClient.h  

EAvaBroadcastOutputState GetMediaOutputState ( const FString& InServerName,
const FString& InChannelName,
const FGuid& InOutputGuid
) const

   Playback/IAvaPlaybackClient.h  

int32 GetNumConnectedServers()

   Playback/IAvaPlaybackClient.h  

TArray< FString > GetOnlineServersForChannel ( const FName& InChannelName
) const

 Returns a list of all connected servers having outputs in the given channel. Playback/IAvaPlaybackClient.h  

TOptional< EAvaPlaybackAssetStatus > GetRemotePlaybackAssetStatus ( const FSoftObjectPath& InAssetPath,
const FString& InServerName
) const

 Returns the status of the playback asset on the given remote server. Playback/IAvaPlaybackClient.h  

TOptional< EAvaPlaybackStatus > GetRemotePlaybackStatus ( const FGuid& InInstanceId,
const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
const FString& InServerName
) const

 Returns the status of the playback asset on the given channel on the remote server. Playback/IAvaPlaybackClient.h  

const FString * GetRemotePlaybackUserData ( const FGuid& InInstanceId,
const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
const FString& InServerName
) const

 Returns the user data of the specified playback instance. Playback/IAvaPlaybackClient.h  

FMessageAddress GetServerAddress ( const FString& InServerName
) const

 Returns the corresponding server address for the given server name. Playback/IAvaPlaybackClient.h  

TArray< FString > GetServerNames()

   Playback/IAvaPlaybackClient.h  

const FString & GetServerUserData ( const FString& InServerName,
const FString& InUserDataKey
) const

 Returns the corresponding server user data for the given server name and key. Playback/IAvaPlaybackClient.h  

const FString & GetUserData ( const FString& InKey
) const

 Returns the corresponding client user data for the given key. Returns empty container if not found. Playback/IAvaPlaybackClient.h  

bool HasAnyServerOnlineForChannel ( const FName& InChannelName
) const

 Returns true if the client has at least one connected server for the given channel. Playback/IAvaPlaybackClient.h  

bool HasServerUserData ( const FString& InServerName,
const FString& InUserDataKey
) const

 Returns true if the corresponding server user data for the given server name is found. Playback/IAvaPlaybackClient.h  

bool HasUserData ( const FString& InKey
) const

 Returns true if the corresponding client user data for the given key is found. Playback/IAvaPlaybackClient.h  

bool IsMediaOutputRemoteFallback ( const UMediaOutput* InMediaOutput
)

 Use the device provider to determine if the media output is remote. Playback/IAvaPlaybackClient.h  

void RemoveUserData ( const FString& InKey
)

 Remove the client's user data entry from the given key. Playback/IAvaPlaybackClient.h  

void RequestAnimAction ( const FGuid& InInstanceId,
const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
const FString& InAnimationName,
EAvaPlaybackAnimAction InAction
)

   Playback/IAvaPlaybackClient.h  

void RequestAnimPlayback ( const FGuid& InInstanceId,
const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
const FAvaPlaybackAnimPlaySettings& InAnimSettings
)

   Playback/IAvaPlaybackClient.h  

void RequestBroadcast ( const FString& InProfile,
const FName& InChannel,
const TArray< UMediaOutput* >& InRemoteMediaOutputs,
EAvaBroadcastAction InAction,
const FString& InServerName
)

   Playback/IAvaPlaybackClient.h  

void RequestPlayableTransitionStart ( const FGuid& InTransitionId,
TArray< FGuid >&& InEnterInstanceIds,
TArray< FGuid >&& InPlayingInstanceIds,
TArray< FGuid >&& InExitInstanceIds,
TArray< FAvaPlayableRemoteControlValues >&& InEnterValues,
const FName& InChannelName,
EAvaPlayableTransitionFlags InTransitionFlags
)

   Playback/IAvaPlaybackClient.h  

void RequestPlayableTransitionStop ( const FGuid& InTransitionId,
const FName& InChannelName
)

   Playback/IAvaPlaybackClient.h  

void RequestPlayback ( const FGuid& InInstanceId,
const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
EAvaPlaybackAction InAction,
const FString& InArguments
)

   Playback/IAvaPlaybackClient.h  

void RequestPlaybackAssetStatus ( const FSoftObjectPath& InAssetPath,
const FString& InChannelOrServerName,
bool bInForceRefresh
)

   Playback/IAvaPlaybackClient.h  

void RequestRemoteControlUpdate ( const FGuid& InInstanceId,
const FSoftObjectPath& InAssetPath,
const FString& InChannelName,
const FAvaPlayableRemoteControlValues& InRemoteControlValues,
EAvaPlayableRCUpdateFlags InFlags
)

   Playback/IAvaPlaybackClient.h  

void SetUserData ( const FString& InKey,
const FString& InData
)

 Add user data to this client. This is replicated and accessible to the servers. Playback/IAvaPlaybackClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page