1. Epic GamesDeveloper
  3. FAvaBroadcastOutputChannel

FAvaBroadcastOutputChannel

API > API/Plugins > API/Plugins/AvalancheMedia

   
Name FAvaBroadcastOutputChannel
Type struct
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Broadcast/Channel/AvaBroadcastOutputChannel.h
Include Path #include "Broadcast/Channel/AvaBroadcastOutputChannel.h"

Syntax

USTRUCT ()  
struct FAvaBroadcastOutputChannel

Constructors

Name Remarks Include Path Unreal Specifiers
  Broadcast/Channel/AvaBroadcastOutputChannel.h  
  Broadcast/Channel/AvaBroadcastOutputChannel.h  
  Broadcast/Channel/AvaBroadcastOutputChannel.h  

FAvaBroadcastOutputChannel ( FName InProfileName,
UAvaBroadcast* InBroadcast
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAvaBroadcastOutputChannel()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

Structs

Name Remarks
FLocalMediaOutputStatus Keep track of the media capture/output status while starting the broadcast.

Typedefs

Name Type Remarks Include Path
FMediaOutputStateChanged TMulticastDelegate_TwoParams< void, const FAvaBroadcastOutputChannel &InChannel, const UMediaOutput *InMediaOutput > Called when the state of the capture changed. Broadcast/Channel/AvaBroadcastOutputChannel.h
FOnAvaChannelChanged TMulticastDelegate_TwoParams< void, const FAvaBroadcastOutputChannel &, EAvaBroadcastChannelChange >   Broadcast/Channel/AvaBroadcastOutputChannel.h

Constants

Name Type Remarks Include Path
OnChannelChanged FOnAvaChannelChanged   Broadcast/Channel/AvaBroadcastOutputChannel.h
OnMediaOutputStateChanged FMediaOutputStateChanged   Broadcast/Channel/AvaBroadcastOutputChannel.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMediaOutput ( UMediaOutput* InMediaOutput,
const FAvaBroadcastMediaOutputInfo& InOutputInfo
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

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

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

EPixelFormat DetermineRenderTargetFormat()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

FIntPoint DetermineRenderTargetSize()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

int32 GetChannelIndex ()

 Index of this channel in the broadcast's channel names array. Broadcast/Channel/AvaBroadcastOutputChannel.h  

FName GetChannelName()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

EAvaBroadcastChannelType GetChannelType()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

UTextureRenderTarget2D * GetCurrentRenderTarget ( bool bInFallbackToPlaceholder
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

EAvaBroadcastIssueSeverity GetIssueSeverity()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

UAvaPlayableGroup * GetLastActivePlayableGroup()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

const FAvaBroadcastMediaOutputInfo & GetMediaOutputInfo ( const UMediaOutput* InMediaOutput
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

FAvaBroadcastMediaOutputInfo * GetMediaOutputInfoMutable ( const UMediaOutput* InMediaOutput
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

const TArray< FString > & GetMediaOutputIssueMessages ( const UMediaOutput* InMediaOutput
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

EAvaBroadcastIssueSeverity GetMediaOutputIssueSeverity ( EAvaBroadcastOutputState InOutputState,
const UMediaOutput* InMediaOutput
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

const TArray< UMediaOutput * > & GetMediaOutputs()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

const FString & GetMediaOutputServerName ( const UMediaOutput* InMediaOutput
) const

 Returns the server name associated with the Media Output object. Broadcast/Channel/AvaBroadcastOutputChannel.h  

EAvaBroadcastOutputState GetMediaOutputState ( const UMediaOutput* InMediaOutput
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

UTextureRenderTarget2D * GetPlaceholderRenderTarget()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

FAvaBroadcastProfile & GetProfile()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

FName GetProfileName()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

TArray< UMediaOutput * > GetRemoteMediaOutputs()

 Returns the Media Output objects that are associated to a remote server. Broadcast/Channel/AvaBroadcastOutputChannel.h  
  Broadcast/Channel/AvaBroadcastOutputChannel.h  

const FAvaViewportQualitySettings & GetViewportQualitySettings()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

bool HasAnyLocalMediaOutputs()

 Returns true if this channel has a least one local media output. Broadcast/Channel/AvaBroadcastOutputChannel.h  

bool HasAnyRemoteMediaOutputs()

 Returns true if this channel has a least one remote media output. Broadcast/Channel/AvaBroadcastOutputChannel.h  

bool IsEditingEnabled()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

bool IsMediaOutputRemote ( const UMediaOutput* InMediaOutput
) const

 Returns true if the Media Output object is associated to a remote server. Broadcast/Channel/AvaBroadcastOutputChannel.h  

bool IsValidChannel()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void OnMediaOutputModified ( UMediaOutput* InMediaOutput
)

 Called when the output is modified. Propagates the configuration change accordingly. Broadcast/Channel/AvaBroadcastOutputChannel.h  

void PostLoadMediaOutputs ( bool bInIsProfileActive,
FName InProfileName,
UAvaBroadcast* InBroadcast
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void PostLoadMediaOutputs ( bool bInIsProfileActive,
FAvaBroadcastProfile* InProfile
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

EAvaBroadcastChannelState RefreshState()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void ReleaseOutputs()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void ReleasePlaceholderRenderTargets()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void ReleasePlaceholderResources()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

int32 RemoveMediaOutput ( UMediaOutput* InMediaOutput
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void SetChannelIndex ( int32 InIndex
)

 Set this channel's index in the broadcast's channel names array. Broadcast/Channel/AvaBroadcastOutputChannel.h  

void SetProfileName ( FName InProfileName
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void SetViewportQualitySettings ( const FAvaViewportQualitySettings& InQualitySettings
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

bool StartChannelBroadcast()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void StopChannelBroadcast()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void UpdateAudioDevice ( const FAudioDeviceHandle& InAudioDeviceHandle
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void UpdateChannelResources ( bool bInIsProfileActive
)

 Updates Channel's Data and Resources. Broadcast/Channel/AvaBroadcastOutputChannel.h  

void UpdateRenderTarget ( UAvaPlayableGroup* InPlayableGroup,
UTextureRenderTarget2D* InRenderTarget
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DrawPlaceholderWidget()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

FString & EmplaceMessageForOutput ( const UMediaOutput* InMediaOutput,
EAvaBroadcastIssueSeverity InSeverity
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

EAvaBroadcastIssueSeverity GetLocalSeverityForOutput ( const UMediaOutput* InMediaOutput
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

UMediaCapture * GetMediaCaptureForOutput ( const UMediaOutput* InMediaOutput
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

bool IsMediaOutputCompatible ( UMediaOutput* InMediaOutput,
UTextureRenderTarget2D* InRenderTarget
) const

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

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

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void ResetLocalMediaOutputStatus ( const UMediaOutput* InMediaOutput
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void SetState ( EAvaBroadcastChannelState InState,
EAvaBroadcastIssueSeverity InIssueSeverity
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void StartPlaceholderTick()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void StopCaptureForOutput ( const UMediaOutput* InMediaOutput
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void StopPlaceholderTick()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void TickPlaceholder ( float
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void UpdateOverridePlaceholder()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void UpdatePlaceholder()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void UpdatePlaceholderRenderTargets()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

void UpdateViewportTarget()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DuplicateChannel ( const FAvaBroadcastOutputChannel& InSourceChannel,
FAvaBroadcastOutputChannel& OutTargetChannel
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

static EPixelFormat GetDefaultMediaOutputFormat()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

static FIntPoint GetDefaultMediaOutputSize ( EAvaBroadcastChannelType InChannelType
)

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

static FAvaBroadcastOutputChannel & GetNullChannel()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

static FOnAvaChannelChanged & GetOnChannelChanged()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

static FMediaOutputStateChanged & GetOnMediaOutputStateChanged()

   Broadcast/Channel/AvaBroadcastOutputChannel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page