Navigation
API > API/Plugins > API/Plugins/AvalancheMedia
| Name | UAvaRundownPagePlayer |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Rundown/AvaRundownPagePlayer.h |
| Include Path | #include "Rundown/AvaRundownPagePlayer.h" |
Syntax
UCLASS ()
class UAvaRundownPagePlayer : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UAvaRundownPagePlayer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAvaRundownPagePlayer() |
Rundown/AvaRundownPagePlayer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UAvaRundownPagePlayer() |
Rundown/AvaRundownPagePlayer.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsPreview | bool | Rundown/AvaRundownPagePlayer.h | ||
| ChannelFName | FName | For previews, the channel name will not be the one set in the page. | Rundown/AvaRundownPagePlayer.h | |
| ChannelName | FString | For previews, the channel name will not be the one set in the page. | Rundown/AvaRundownPagePlayer.h | |
| InstancePlayers | TArray< TObjectPtr< UAvaRundownPlaybackInstancePlayer > > | Rundown/AvaRundownPagePlayer.h | ||
| PageId | int32 | Rundown/AvaRundownPagePlayer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddInstancePlayer
(
UAvaRundownPlaybackInstancePlayer* InExistingInstancePlayer |
Add a pre-existing instance player to this page player. | Rundown/AvaRundownPagePlayer.h | |
bool Continue() |
Rundown/AvaRundownPagePlayer.h | ||
UAvaRundownPlaybackInstancePlayer * FindInstancePlayerByAssetPath
(
const FSoftObjectPath& InAssetPath |
Rundown/AvaRundownPagePlayer.h | ||
UAvaRundownPlaybackInstancePlayer * FindInstancePlayerByInstanceId
(
const FGuid& InInstanceId |
Rundown/AvaRundownPagePlayer.h | ||
UAvaRundownPlaybackInstancePlayer * FindInstancePlayerForPlayable
(
const UAvaPlayable* InPlayable |
Rundown/AvaRundownPagePlayer.h | ||
void ForEachInstancePlayer
(
TFunctionRef< void(const UAvaRundownPlaybackInstancePlayer*)> InFunction |
Rundown/AvaRundownPagePlayer.h | ||
void ForEachInstancePlayer
(
TFunctionRef< void(UAvaRundownPlaybackInstancePlayer*)> InFunction |
Rundown/AvaRundownPagePlayer.h | ||
UAvaRundownPlaybackInstancePlayer * GetInstancePlayer
(
int32 InIndex |
Rundown/AvaRundownPagePlayer.h | ||
int32 GetNumInstancePlayers() |
Rundown/AvaRundownPagePlayer.h | ||
UAvaPlaybackGraph * GetPlayback
(
int32 InIndex |
Rundown/AvaRundownPagePlayer.h | ||
FAvaPlaybackInstance * GetPlaybackInstance
(
int32 InIndex |
Rundown/AvaRundownPagePlayer.h | ||
FGuid GetPlaybackInstanceId
(
int32 InIndex |
Rundown/AvaRundownPagePlayer.h | ||
UAvaRundown * GetRundown() |
Rundown/AvaRundownPagePlayer.h | ||
FSoftObjectPath GetSourceAssetPath
(
int32 InIndex |
Rundown/AvaRundownPagePlayer.h | ||
bool HasPlayable
(
const UAvaPlayable* InPlayable |
Rundown/AvaRundownPagePlayer.h | ||
bool Initialize
(
UAvaRundown* InRundown, |
Initialize Page player without loading any playback instances. | Rundown/AvaRundownPagePlayer.h | |
bool InitializeAndLoad
(
UAvaRundown* InRundown, |
Initialize the Page player and loads all playback instances. | Rundown/AvaRundownPagePlayer.h | |
bool IsLoaded() |
Returns true if at least one of the instance player is loaded, false otherwise. | Rundown/AvaRundownPagePlayer.h | |
bool IsPlaying() |
Returns true if at least one of the instance player is playing, false otherwise. | Rundown/AvaRundownPagePlayer.h | |
UAvaRundownPlaybackInstancePlayer * LoadInstancePlayer
(
int32 InSubPageIndex, |
Load an instance player for the "sub page" at the given index. | Rundown/AvaRundownPagePlayer.h | |
bool Play
(
EAvaRundownPagePlayType InPlayType |
Ensure all the playback instances are playing. | Rundown/AvaRundownPagePlayer.h | |
bool Play
(
EAvaRundownPagePlayType InPlayType, |
Rundown/AvaRundownPagePlayer.h | ||
bool Stop() |
Rundown/AvaRundownPagePlayer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UAvaRundownPlaybackInstancePlayer * CreateAndLoadInstancePlayer
(
UAvaRundown* InRundown, |
Rundown/AvaRundownPagePlayer.h | ||
void HandleOnPlayableSequenceEvent
(
UAvaPlayable* InPlayable, |
Rundown/AvaRundownPagePlayer.h | ||
void RemoveInstancePlayer
(
UAvaRundownPlaybackInstancePlayer* InInstancePlayer |
Rundown/AvaRundownPagePlayer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 GetPageIdFromInstanceUserData
(
const FString& InUserData |
Rundown/AvaRundownPagePlayer.h | ||
static void SetInstanceUserDataFromPage
(
FAvaPlaybackInstance& InPlaybackInstance, |
Rundown/AvaRundownPagePlayer.h |