1. Epic GamesDeveloper
  3. UAvaRundownPagePlayer

UAvaRundownPagePlayer

API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/Rundown

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class UAvaRundownPagePlayer : public UObject

Variables

  Type Name Description
Public variable UProperty bool bIsPreview  
Public variable UProperty FName ChannelFName For previews, the channel name will not be the one set in the page.
Public variable UProperty FString ChannelName For previews, the channel name will not be the one set in the page.
Public variable UProperty TArray< TObjectPtr< UAvaRundownPlaybackInstancePlayer > > InstancePlayers  
Public variable UProperty int32 PageId  
Protected variable TWeakObjectPtr< UAvaRundown > RundownWeak  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Add a pre-existing instance player to this page player.
Public function bool  
Protected function UAvaRundownPlaybackInstancePlayer *

CreateAndLoadInstancePlayer ( UAvaRundown* InRundown,
const FAvaRundownPage& InPage,
int32 InSubPageIndex,
const FGuid& InInstanceId
)

  
Public function Const UAvaRundownPlaybackInstancePlayer *  
Public function Const UAvaRundownPlaybackInstancePlayer *

FindInstancePlayerByInstanceId ( const FGuid& InInstanceId
)

  
Public function Const UAvaRundownPlaybackInstancePlayer *

FindInstancePlayerForPlayable ( const UAvaPlayable* InPlayable
)

  
Public function void  
Public function Const void  
Public function Const UAvaRundownPlaybackInstancePlayer *

GetInstancePlayer ( int32 InIndex
)

  
Public function Const int32  
Public function Static int32

GetPageIdFromInstanceUserData ( const FString& InUserData
)

  
Public function Const UAvaPlaybackGraph *

GetPlayback ( int32 InIndex
)

  
Public function Const FAvaPlaybackInstance *  
Public function Const FGuid  
Public function Const UAvaRundown *  
Public function Const FSoftObjectPath  
Protected function void

HandleOnPlayableSequenceEvent ( UAvaPlayable* InPlayable,
FName InSequenceLabel,
EAvaPlayableSequenceEventType InEventType
)

  
Public function Const bool

HasPlayable ( const UAvaPlayable* InPlayable
)

  
Public function bool

Initialize ( UAvaRundown* InRundown,
const FAvaRundownPage& InPage,
bool bInIsPreview,
const FName& InPreviewChannel
)

 Initialize Page player without loading any playback instances.
Public function bool

InitializeAndLoad ( UAvaRundown* InRundown,
const FAvaRundownPage& InPage,
bool bInIsPreview,
const FName& InPreviewChannel
)

 Initialize the Page player and loads all playback instances.
Public function Const bool Returns true if at least one of the instance player is loaded, false otherwise.
Public function Const bool Returns true if at least one of the instance player is playing, false otherwise.
Public function UAvaRundownPlaybackInstancePlayer *

LoadInstancePlayer ( int32 InSubPageIndex,
const FGuid& InInstanceId
)

 Load an instance player for the "sub page" at the given index.
Public function bool

Play ( EAvaRundownPagePlayType InPlayType,
bool bInIsUsingTransitionLogic
)

  
Protected function void  
Public function Static void

SetInstanceUserDataFromPage ( FAvaPlaybackInstance& InPlaybackInstance,
const FAvaRundownPage& InPage
)

  
Public function bool

Stop ()

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page