1. Epic GamesDeveloper
  3. IAvaPlaybackClient

IAvaPlaybackClient

API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/Playback

References

   
Module AvalancheMedia
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheMedia/Public/Playback/IAvaPlaybackClient.h
Include #include "Playback/IAvaPlaybackClient.h"

Syntax

class IAvaPlaybackClient

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

BroadcastStatCommand ( const FString& InCommand,
bool bInBroadcastLocalState
)

 Send a stat command to all connected servers.
Public function Const const TArray< FString > &

GetMediaOutputIssueMessages ( const FString& InServerName,
const FString& InChannelName,
const FGuid& InOutputGuid
)

  
Public function Const EAvaBroadcastIssueSeverity

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

  
Public function Const EAvaBroadcastOutputState

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

  
Public function Const int32  
Public function Const TOptional< EAvaPlaybackAssetStatus >

GetRemotePlaybackAssetStatus ( const FSoftObjectPath& InAssetPath,
const FString& InServerName
)

 Returns the status of the playback asset on the given remote server.
Public function Const TOptional< EAvaPlaybackStatus >

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

 Returns the status of the playback asset on the given channel on the remote server.
Public function Const const FString *

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

 Returns the user data of the specified playback instance.
Public function Const FMessageAddress

GetServerAddress ( const FString& InServerName
)

 Returns the corresponding server address for the given server name.
Public function Const TArray< FString >  
Public function Const const FString &

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

 Returns the corresponding server user data for the given server name and key.
Public function Const const FString &

GetUserData ( const FString& InKey
)

 Returns the corresponding client user data for the given key. Returns empty container if not found.
Public function Const bool

HasAnyServerOnlineForChannel ( const FName& InChannelName
)

 Returns true if the client has at least one connected server for the given channel.
Public function Const bool

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

 Returns true if the corresponding server user data for the given server name is found.
Public function Const bool

HasUserData ( const FString& InKey
)

 Returns true if the corresponding client user data for the given key is found.
Public function bool

IsMediaOutputRemoteFallback ( const UMediaOutput* InMediaOutput
)

 Use the device provider to determine if the media output is remote.
Public function void

RemoveUserData ( const FString& InKey
)

 Remove the client's user data entry from the given key.
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

 Add user data to this client. This is replicated and accessible to the servers.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page