1. Epic GamesDeveloper
  3. FAvaBroadcastOutputChannel

FAvaBroadcastOutputChannel

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

References

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

Syntax

USTRUCT ()  
struct FAvaBroadcastOutputChannel

Variables

  Type Name Description
Protected variable bool bInternalStateBroadcasting This internal state is used to mark the channel as "should be broadcasting".
Protected variable UProperty int32 ChannelIndex Index of this channel in the broadcast's channel names array.
Protected variable EAvaBroadcastIssueSeverity ChannelIssueSeverity  
Protected variable FText ChannelNameText  
Protected variable EAvaBroadcastChannelState ChannelState  
Protected variable TWeakObjectPtr< UTextureRenderTarget2D > CurrentRenderTarget Keep track of the active render target associated with the current playable group.
Protected variable TWeakObjectPtr< UAvaPlayableGroup > LastActivePlayableGroup Last Active Playable group associated with the current render target.
Protected variable TMap< const UMediaOutput *, FLocalMediaOutputStatus > LocalMediaOutputStatuses  
Protected variable UProperty Transient TMap< TObjectPtr< UMediaOutput >, FAvaBroadcastCapture > MediaCaptures A Map of Media Outputs with their Media Captures when Broadcast Starts, and deleted when Broadcast Stops.
Protected variable UProperty TArray< FAvaBroadcastMediaOutputInfo > MediaOutputInfos  
Protected variable UProperty TArray< TObjectPtr< UMediaOutput > > MediaOutputs  
Protected variable UProperty Transient TObjectPtr< UUserWidget > OverridePlaceholderUserWidget Optional UMG Widget that is used to replace the Default Placeholder Widget
Protected variable TSharedPtr< SWidget > OverridePlaceholderWidget  
Protected variable UProperty Transient TObjectPtr< UTextureRenderTarget2D > PlaceholderRenderTarget  
Protected variable UProperty Transient TObjectPtr< UTextureRenderTarget2D > PlaceholderRenderTargetTmp Extra render target to perform alpha inversion needed to mimic scene rendering.
Protected variable FDelegateHandle PlaceholderTickHandle  
Protected variable TSharedPtr< SAvaBroadcastPlaceholderWidget > PlaceholderWidget  
Protected variable FAvaBroadcastProfile * Profile  
Protected variable UProperty Category, EditAnywhere FAvaViewportQualitySettings QualitySettings  
Protected variable TSharedPtr< FWidgetRenderer > WidgetRenderer  

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddMediaOutput ( UMediaOutput* InMediaOutput,
const FAvaBroadcastMediaOutputInfo& InOutputInfo
)

  
Public function UMediaOutput *

AddMediaOutput ( const UClass* InMediaOutputClass,
const FAvaBroadcastMediaOutputInfo& InOutputInfo
)

  
Public function Const EPixelFormat  
Public function Const FIntPoint  
Protected function Const void  
Public function Static void

DuplicateChannel ( const FAvaBroadcastOutputChannel& InSourceChannel,
FAvaBroadcastOutputChannel& OutTargetChannel
)

  
Protected function Const FString &

EmplaceMessageForOutput ( const UMediaOutput* InMediaOutput,
EAvaBroadcastIssueSeverity InSeverity
)

  
Public function Const int32 Index of this channel in the broadcast's channel names array.
Public function Const FName  
Public function Const EAvaBroadcastChannelType  
Public function Const UTextureRenderTarget2D *

GetCurrentRenderTarget ( bool bInFallbackToPlaceholder
)

  
Public function Static EPixelFormat  
Public function Static FIntPoint  
Public function Const EAvaBroadcastIssueSeverity  
Public function Const UAvaPlayableGroup *  
Protected function Const EAvaBroadcastIssueSeverity

GetLocalSeverityForOutput ( const UMediaOutput* InMediaOutput
)

  
Protected function Const UMediaCapture *

GetMediaCaptureForOutput ( const UMediaOutput* InMediaOutput
)

  
Public function Const const FAvaBroadcastMediaOutputInfo &

GetMediaOutputInfo ( const UMediaOutput* InMediaOutput
)

  
Public function FAvaBroadcastMediaOutputInfo *

GetMediaOutputInfoMutable ( const UMediaOutput* InMediaOutput
)

  
Public function Const const TArray< FString > &

GetMediaOutputIssueMessages ( const UMediaOutput* InMediaOutput
)

  
Public function Const EAvaBroadcastIssueSeverity

GetMediaOutputIssueSeverity ( EAvaBroadcastOutputState InOutputState,
const UMediaOutput* InMediaOutput
)

  
Public function Const const TArray< UMediaOutput * > &  
Public function Const const FString &

GetMediaOutputServerName ( const UMediaOutput* InMediaOutput
)

 Returns the server name associated with the Media Output object.
Public function Const EAvaBroadcastOutputState

GetMediaOutputState ( const UMediaOutput* InMediaOutput
)

  
Public function Static FAvaBroadcastOutputChannel &  
Public function Static FOnAvaChannelChanged &  
Public function Static FMediaOutputStateChanged &  
Public function Const UTextureRenderTarget2D *  
Public function Const FAvaBroadcastProfile &  
Public function Const FName  
Public function Const TArray< UMediaOutput * > Returns the Media Output objects that are associated to a remote server.
Public function Const EAvaBroadcastChannelState  
Public function Const const FAvaViewportQualitySettings &  
Public function Const bool Returns true if this channel has a least one local media output.
Public function Const bool Returns true if this channel has a least one remote media output.
Public function Const bool  
Protected function Const bool

IsMediaOutputCompatible ( UMediaOutput* InMediaOutput,
UTextureRenderTarget2D* InRenderTarget
)

  
Public function Const bool

IsMediaOutputRemote ( const UMediaOutput* InMediaOutput
)

 Returns true if the Media Output object is associated to a remote server.
Public function Const bool  
Protected function void

OnAvaMediaCaptureStateChanged ( const UMediaCapture* InMediaCapture,
const UMediaOutput* InMediaOutput
)

  
Public function void

OnMediaOutputModified ( UMediaOutput* InMediaOutput
)

 Called when the output is modified. Propagates the configuration change accordingly.
Public function void

PostLoadMediaOutputs ( bool bInIsProfileActive,
FAvaBroadcastProfile* InProfile
)

  
Public function EAvaBroadcastChannelState  
Public function void  
Public function void  
Public function void  
Public function int32

RemoveMediaOutput ( UMediaOutput* InMediaOutput
)

  
Protected function void

ResetLocalMediaOutputStatus ( const UMediaOutput* InMediaOutput
)

  
Public function void

SetChannelIndex ( int32 InIndex
)

 Set this channel's index in the broadcast's channel names array.
Protected function void  
Public function void  
Public function bool  
Protected function void  
Protected function void

StopCaptureForOutput ( const UMediaOutput* InMediaOutput
)

  
Public function void  
Protected function void  
Protected function void

TickPlaceholder ( float
)

  
Public function void

UpdateAudioDevice ( const FAudioDeviceHandle& InAudioDeviceHandle
)

  
Public function void

UpdateChannelResources ( bool bInIsProfileActive
)

 Updates Channel's Data and Resources.
Protected function void  
Protected function void  
Protected function void  
Public function void

UpdateRenderTarget ( UAvaPlayableGroup* InPlayableGroup,
UTextureRenderTarget2D* InRenderTarget
)

  
Protected function void  

Classes

  Type Name Description
Protected struct FLocalMediaOutputStatus Keep track of the media capture/output status while starting the broadcast.  

Typedefs

Name Description
FMediaOutputStateChanged Called when the state of the capture changed.
FOnAvaChannelChanged  

Constants

Name Description
OnChannelChanged  
OnMediaOutputStateChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page