Navigation
API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/IAvaPlaybackClient
Description
Returns the status of the playback asset on the given channel on the remote server. If the return value is not set, it is because it is not yet available, in which case a status request can be made to make it available.
This supports forked channels by allowing to specify the optional server to further precise the request. In a forked channel situation, a channel will be hosted by multiple servers and therefore, have a playback status per server. If the server name is left empty, the playback status of the first server hosting the given channel will be returned.
| Name | GetRemotePlaybackStatus |
| Type | function |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Playback/IAvaPlaybackClient.h |
| Include Path | #include "Playback/IAvaPlaybackClient.h" |
TOptional < EAvaPlaybackStatus > GetRemotePlaybackStatus
(
const FGuid & InInstanceId,
const FSoftObjectPath & InAssetPath,
const FString & InChannelName,
const FString & InServerName
) const
Parameters
| Name | Remarks |
|---|---|
| InInstanceId | Specify instance. If not specified, it will look for the most relevant status for the given asset. |
| InAssetPath | Full path of the playback asset to fetch the status of. |
| InChannelName | Servers can be running different channels, so need to identify the channel as well. |
| InServerName | Identifies the server to fetch the status from. |