Navigation
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, |
Send a stat command to all connected servers. | Playback/IAvaPlaybackClient.h | |
| Playback/IAvaPlaybackClient.h | |||
EAvaBroadcastIssueSeverity GetMediaOutputIssueSeverity
(
const FString& InServerName, |
Playback/IAvaPlaybackClient.h | ||
EAvaBroadcastOutputState GetMediaOutputState
(
const FString& InServerName, |
Playback/IAvaPlaybackClient.h | ||
int32 GetNumConnectedServers() |
Playback/IAvaPlaybackClient.h | ||
| Returns a list of all connected servers having outputs in the given channel. | Playback/IAvaPlaybackClient.h | ||
TOptional< EAvaPlaybackAssetStatus > GetRemotePlaybackAssetStatus
(
const FSoftObjectPath& InAssetPath, |
Returns the status of the playback asset on the given remote server. | Playback/IAvaPlaybackClient.h | |
TOptional< EAvaPlaybackStatus > GetRemotePlaybackStatus
(
const FGuid& InInstanceId, |
Returns the status of the playback asset on the given channel on the remote server. | Playback/IAvaPlaybackClient.h | |
const FString * GetRemotePlaybackUserData
(
const FGuid& InInstanceId, |
Returns the user data of the specified playback instance. | Playback/IAvaPlaybackClient.h | |
FMessageAddress GetServerAddress
(
const FString& InServerName |
Returns the corresponding server address for the given server name. | Playback/IAvaPlaybackClient.h | |
| Playback/IAvaPlaybackClient.h | |||
const FString & GetServerUserData
(
const FString& InServerName, |
Returns the corresponding server user data for the given server name and key. | Playback/IAvaPlaybackClient.h | |
| Returns the corresponding client user data for the given key. Returns empty container if not found. | Playback/IAvaPlaybackClient.h | ||
bool HasAnyServerOnlineForChannel
(
const FName& InChannelName |
Returns true if the client has at least one connected server for the given channel. | Playback/IAvaPlaybackClient.h | |
| Returns true if the corresponding server user data for the given server name is found. | Playback/IAvaPlaybackClient.h | ||
bool HasUserData
(
const FString& InKey |
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, |
Playback/IAvaPlaybackClient.h | ||
void RequestAnimPlayback
(
const FGuid& InInstanceId, |
Playback/IAvaPlaybackClient.h | ||
void RequestBroadcast
(
const FString& InProfile, |
Playback/IAvaPlaybackClient.h | ||
void RequestPlayableTransitionStart
(
const FGuid& InTransitionId, |
Playback/IAvaPlaybackClient.h | ||
| Playback/IAvaPlaybackClient.h | |||
void RequestPlayback
(
const FGuid& InInstanceId, |
Playback/IAvaPlaybackClient.h | ||
void RequestPlaybackAssetStatus
(
const FSoftObjectPath& InAssetPath, |
Playback/IAvaPlaybackClient.h | ||
void RequestRemoteControlUpdate
(
const FGuid& InInstanceId, |
Playback/IAvaPlaybackClient.h | ||
| Add user data to this client. This is replicated and accessible to the servers. | Playback/IAvaPlaybackClient.h |