1. Epic GamesDeveloper
  3. UAvaBroadcast

UAvaBroadcast

Single Instance Class that manages all the Output Channels

API > API/Plugins > API/Plugins/AvalancheMedia

Single Instance Class that manages all the Output Channels

   
Name UAvaBroadcast
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Broadcast/AvaBroadcast.h
Include Path #include "Broadcast/AvaBroadcast.h"

Syntax

UCLASS (NotBlueprintable)  
class UAvaBroadcast : public UObject

Inheritance Hierarchy

Functions

Public

Name Remarks Include Path Unreal Specifiers

FDelegateHandle AddChangeListener ( FOnAvaBroadcastChanged::FDelegate&& InDelegate
)

   Broadcast/AvaBroadcast.h  

int32 AddChannelName ( FName InChannelName
)

 Add the given channel name to the array of channel names. Broadcast/AvaBroadcast.h  

bool CanRenameChannel ( FName InChannelName,
FName InNewChannelName
) const

   Broadcast/AvaBroadcast.h  

bool CanRenameProfile ( FName InProfileName,
FName InNewProfileName,
FText* OutErrorMessage
) const

   Broadcast/AvaBroadcast.h  

bool CanShowPreview()

   Broadcast/AvaBroadcast.h  

bool ConditionalStartBroadcastChannel ( const FName& InChannelName
)

 Starts the channel if not started. Does nothing if already started. Broadcast/AvaBroadcast.h  

FName CreateProfile ( FName InProfileName,
bool bMakeCurrentProfile
)

 Returns the actual name of the profile created. Defers in Number from InProfileName if it is an already existing Profile. Broadcast/AvaBroadcast.h  

bool DuplicateCurrentProfile ( FName InNewProfileName,
bool bMakeCurrentProfile
)

   Broadcast/AvaBroadcast.h  

bool DuplicateProfile ( FName InNewProfile,
FName InTemplateProfile,
bool bMakeCurrentProfile
)

   Broadcast/AvaBroadcast.h  

FString GetBroadcastSaveFilepath()

   Broadcast/AvaBroadcast.h  

int32 GetChannelIndex ( FName InChannelName
) const

 Returns the index of the channel in the channel name array. Broadcast/AvaBroadcast.h  

FName GetChannelName ( int32 ChannelIndex
) const

   Broadcast/AvaBroadcast.h  

int32 GetChannelNameCount()

   Broadcast/AvaBroadcast.h  

EAvaBroadcastChannelType GetChannelType ( FName InChannelName
) const

   Broadcast/AvaBroadcast.h  
  Broadcast/AvaBroadcast.h  
  Broadcast/AvaBroadcast.h  

FName GetCurrentProfileName()

   Broadcast/AvaBroadcast.h  

FOnAvaBroadcastChannelsListChanged & GetOnChannelsListChanged()

   Broadcast/AvaBroadcast.h  

FName GetOrAddChannelName ( int32 ChannelIndex
)

   Broadcast/AvaBroadcast.h  

FName GetPinnedChannelProfileName ( FName InChannelName
) const

 If the given channel was pinned, returns the profile it was pinned in, returns Name_None otherwise. Broadcast/AvaBroadcast.h  

const FAvaBroadcastProfile & GetProfile ( FName InProfileName
) const

   Broadcast/AvaBroadcast.h  

FAvaBroadcastProfile & GetProfile ( FName InProfileName
)

   Broadcast/AvaBroadcast.h  

TArray< FName > GetProfileNames()

   Broadcast/AvaBroadcast.h  

const TMap< FName, FAvaBroadcastProfile > & GetProfiles()

   Broadcast/AvaBroadcast.h  

bool IsBroadcastingAllChannels()

   Broadcast/AvaBroadcast.h
  • BlueprintCallable
  • Category="Motion Design Broadcast"

bool IsBroadcastingAnyChannel()

   Broadcast/AvaBroadcast.h
  • BlueprintCallable
  • Category="Motion Design Broadcast"

bool IsChannelPinned ( FName InChannelName
) const

   Broadcast/AvaBroadcast.h  

void LoadBroadcast()

   Broadcast/AvaBroadcast.h  

void PinChannel ( FName InChannelName,
FName InProfileName
)

 Pins the given channel from the given profile to persist across all the profiles. Broadcast/AvaBroadcast.h  

void QueueNotifyChange ( EAvaBroadcastChange InChange
)

 Rather than Immediately calling the Broadcast Event change, it will queue all the multiple calls and dispatch it once to avoid redundancy. Broadcast/AvaBroadcast.h  

void RebuildProfiles ()

 Rebuilds the channel lists that might include pinned channels from other profiles. Broadcast/AvaBroadcast.h  

void RemoveChangeListener ( FDelegateHandle InDelegateHandle
)

   Broadcast/AvaBroadcast.h  

void RemoveChangeListener ( FDelegateUserObjectConst InUserObject
)

   Broadcast/AvaBroadcast.h  

bool RemoveProfile ( FName InProfileName
)

   Broadcast/AvaBroadcast.h  

bool RenameChannel ( FName InChannelName,
FName InNewChannelName
)

   Broadcast/AvaBroadcast.h  

bool RenameProfile ( FName InProfileName,
FName InNewProfileName
)

   Broadcast/AvaBroadcast.h  

void SaveBroadcast()

   Broadcast/AvaBroadcast.h  

void SetCanShowPreview ( bool bInCanShowPreview
)

   Broadcast/AvaBroadcast.h  

void SetChannelType ( FName InChannelName,
EAvaBroadcastChannelType InChannelType
)

 Sets the type (ex: Program or Preview) of the given channel across all profiles. Broadcast/AvaBroadcast.h  

bool SetCurrentProfile ( FName InProfileName
)

   Broadcast/AvaBroadcast.h  

void StartBroadcast()

   Broadcast/AvaBroadcast.h
  • BlueprintCallable
  • Category="Motion Design Broadcast"

void StopBroadcast()

   Broadcast/AvaBroadcast.h
  • BlueprintCallable
  • Category="Motion Design Broadcast"

void UnpinChannel ( FName InChannelName
)

 Unpins the given channel (if it was pinned) so that is no longer persists across all profiles. Broadcast/AvaBroadcast.h  

void UpdateChannelNames()

   Broadcast/AvaBroadcast.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Broadcast/AvaBroadcast.h  

virtual void PostEditUndo()

   Broadcast/AvaBroadcast.h  

Protected

Name Remarks Include Path Unreal Specifiers

TArray< int32 > BuildChannelIndices()

   Broadcast/AvaBroadcast.h  

FAvaBroadcastProfile & CreateProfileInternal ( FName InProfileName
)

   Broadcast/AvaBroadcast.h  

void EnsureValidCurrentProfile()

   Broadcast/AvaBroadcast.h  

void UpdateProfileNames()

   Broadcast/AvaBroadcast.h  

Static

Name Remarks Include Path Unreal Specifiers

static UAvaBroadcast & Get()

   Broadcast/AvaBroadcast.h  

static UAvaBroadcast * GetBroadcast()

   Broadcast/AvaBroadcast.h
  • BlueprintCallable
  • Category="Motion Design Broadcast"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page