1. Epic GamesDeveloper
  3. UAvaBroadcast

UAvaBroadcast

Single Instance Class that manages all the Output Channels

API > API/Plugins > API/Plugins/AvalancheMedia > API/Plugins/AvalancheMedia/Broadcast

Inheritance Hierarchy

References

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

Syntax

UCLASS (NotBlueprintable)  
class UAvaBroadcast : public UObject

Remarks

Single Instance Class that manages all the Output Channels

Variables

  Type Name Description
Protected variable bool bCanShowPreview  
Protected variable UProperty TArray< FName > ChannelNames  
Protected variable UProperty TMap< FName, EAvaBroadcastChannelType > ChannelTypes List of channels types.
Protected variable UProperty FName CurrentProfile  
Protected variable FOnAvaBroadcastChanged OnBroadcastChanged Todo: Proposal - make the events static and pass in the UAvaBroadcast that caused the event.
Protected variable FOnAvaBroadcastChannelsListChanged OnChannelsListChanged  
Protected variable UProperty TMap< FName, FName > PinnedChannels Maps a channel name to a profile. Indicating which profile to use for a pinned channel.
Protected variable UProperty TMap< FName, FAvaBroadcastProfile > Profiles  
Protected variable EAvaBroadcastChange QueuedBroadcastChanges  

Functions

  Type Name Description
Public function FDelegateHandle

AddChangeListener ( FOnAvaBroadcastChanged::FDelegate&& InDelegate
)

  
Public function int32

AddChannelName ( FName InChannelName
)

 Add the given channel name to the array of channel names.
Protected function Const TArray< int32 >  
Public function Const bool

CanRenameChannel ( FName InChannelName,
FName InNewChannelName
)

  
Public function Const bool

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

  
Public function Const bool  
Public function bool

ConditionalStartBroadcastChannel ( const FName& InChannelName
)

 Starts the channel if not started. Does nothing if already started.
Public function 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.
Protected function FAvaBroadcastProfile &

CreateProfileInternal ( FName InProfileName
)

  
Public function bool

DuplicateCurrentProfile ( FName InNewProfileName,
bool bMakeCurrentProfile
)

  
Public function bool

DuplicateProfile ( FName InNewProfile,
FName InTemplateProfile,
bool bMakeCurrentProfile
)

  
Protected function void  
Public function Static UAvaBroadcast &

Get ()

  
Public function Static UFunction BlueprintCallable, Category UAvaBroadcast *  
Public function Const FString  
Public function Const int32

GetChannelIndex ( FName InChannelName
)

 Returns the index of the channel in the channel name array.
Public function Const FName

GetChannelName ( int32 ChannelIndex
)

  
Public function Const int32  
Public function Const EAvaBroadcastChannelType

GetChannelType ( FName InChannelName
)

  
Public function Const const FAvaBroadcastProfile &  
Public function FAvaBroadcastProfile &  
Public function Const FName  
Public function FOnAvaBroadcastChannelsListChanged &  
Public function FName

GetOrAddChannelName ( int32 ChannelIndex
)

  
Public function Const FName If the given channel was pinned, returns the profile it was pinned in, returns Name_None otherwise.
Public function Const const FAvaBroadcastProfile &

GetProfile ( FName InProfileName
)

  
Public function FAvaBroadcastProfile &

GetProfile ( FName InProfileName
)

  
Public function Const TArray< FName >  
Public function Const const TMap< FName, FAvaBroadcastProfile > &  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const bool

IsChannelPinned ( FName InChannelName
)

  
Public function void  
Public function void

PinChannel ( FName InChannelName,
FName InProfileName
)

 Pins the given channel from the given profile to persist across all the profiles.
Public function void Rather than Immediately calling the Broadcast Event change, it will queue all the multiple calls and dispatch it once to avoid redundancy.
Public function void Rebuilds the channel lists that might include pinned channels from other profiles.
Public function void

RemoveChangeListener ( FDelegateHandle InDelegateHandle
)

  
Public function void

RemoveChangeListener ( const void* InUserObject
)

  
Public function bool

RemoveProfile ( FName InProfileName
)

  
Public function bool

RenameChannel ( FName InChannelName,
FName InNewChannelName
)

  
Public function bool

RenameProfile ( FName InProfileName,
FName InNewProfileName
)

  
Public function void  
Public function void

SetCanShowPreview ( bool bInCanShowPreview
)

  
Public function void

SetChannelType ( FName InChannelName,
EAvaBroadcastChannelType InChannelType
)

 Sets the type (ex: Program or Preview) of the given channel across all profiles.
Public function bool

SetCurrentProfile ( FName InProfileName
)

  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function void

UnpinChannel ( FName InChannelName
)

 Unpins the given channel (if it was pinned) so that is no longer persists across all profiles.
Public function void  
Protected function void  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called after applying a transaction to the object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page