UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IAudioLinkSynchronizer Class Referenceabstract

#include <IAudioLink.h>

Classes

struct  FOnOpenStreamParams
 
struct  FOnRenderParams
 

Public Member Functions

virtual ~IAudioLinkSynchronizer ()=default
 
 DECLARE_MULTICAST_DELEGATE (FOnSuspend)
 
virtual FDelegateHandle RegisterSuspendDelegate (const FOnSuspend::FDelegate &)=0
 
virtual bool RemoveSuspendDelegate (const FDelegateHandle &)=0
 
 DECLARE_MULTICAST_DELEGATE (FOnResume)
 
virtual FDelegateHandle RegisterResumeDelegate (const FOnResume::FDelegate &)=0
 
virtual bool RemoveResumeDelegate (const FDelegateHandle &)=0
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnOpenStream, const FOnOpenStreamParams &)
 
virtual FDelegateHandle RegisterOpenStreamDelegate (const FOnOpenStream::FDelegate &)=0
 
virtual bool RemoveOpenStreamDelegate (const FDelegateHandle &)=0
 
 DECLARE_MULTICAST_DELEGATE (FOnCloseStream)
 
virtual FDelegateHandle RegisterCloseStreamDelegate (const FOnCloseStream::FDelegate &)=0
 
virtual bool RemoveCloseStreamDelegate (const FDelegateHandle &)=0
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnBeginRender, const FOnRenderParams &)
 
virtual FDelegateHandle RegisterBeginRenderDelegate (const FOnBeginRender::FDelegate &)=0
 
virtual bool RemoveBeginRenderDelegate (const FDelegateHandle &)=0
 
 DECLARE_MULTICAST_DELEGATE_OneParam (FOnEndRender, const FOnRenderParams &)
 
virtual FDelegateHandle RegisterEndRenderDelegate (const FOnEndRender::FDelegate &)=0
 
virtual bool RemoveEndRenderDelegate (const FDelegateHandle &)=0
 
virtual TOptional< FOnOpenStreamParamsGetCachedOpenStreamParams () const
 

Protected Member Functions

 IAudioLinkSynchronizer ()=default
 

Detailed Description

IAudioLinkSynchronizer Provides delegates for hooking and external AudioLinks synchronization callbacks.

Constructor & Destructor Documentation

◆ IAudioLinkSynchronizer()

IAudioLinkSynchronizer::IAudioLinkSynchronizer ( )
protecteddefault

◆ ~IAudioLinkSynchronizer()

virtual IAudioLinkSynchronizer::~IAudioLinkSynchronizer ( )
virtualdefault

Member Function Documentation

◆ DECLARE_MULTICAST_DELEGATE() [1/3]

IAudioLinkSynchronizer::DECLARE_MULTICAST_DELEGATE ( FOnCloseStream  )

◆ DECLARE_MULTICAST_DELEGATE() [2/3]

IAudioLinkSynchronizer::DECLARE_MULTICAST_DELEGATE ( FOnResume  )

◆ DECLARE_MULTICAST_DELEGATE() [3/3]

IAudioLinkSynchronizer::DECLARE_MULTICAST_DELEGATE ( FOnSuspend  )

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [1/3]

IAudioLinkSynchronizer::DECLARE_MULTICAST_DELEGATE_OneParam ( FOnBeginRender  ,
const FOnRenderParams  
)

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [2/3]

IAudioLinkSynchronizer::DECLARE_MULTICAST_DELEGATE_OneParam ( FOnEndRender  ,
const FOnRenderParams  
)

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [3/3]

IAudioLinkSynchronizer::DECLARE_MULTICAST_DELEGATE_OneParam ( FOnOpenStream  ,
const FOnOpenStreamParams  
)

◆ GetCachedOpenStreamParams()

virtual TOptional< FOnOpenStreamParams > IAudioLinkSynchronizer::GetCachedOpenStreamParams ( ) const
inlinevirtual

Gets any OpenStreamParams that were sent ahead of synchronizing existing.

Returns
TOptional<FOpenStreamParams> (set if data is available).

◆ RegisterBeginRenderDelegate()

virtual FDelegateHandle IAudioLinkSynchronizer::RegisterBeginRenderDelegate ( const FOnBeginRender::FDelegate &  )
pure virtual

◆ RegisterCloseStreamDelegate()

virtual FDelegateHandle IAudioLinkSynchronizer::RegisterCloseStreamDelegate ( const FOnCloseStream::FDelegate &  )
pure virtual

◆ RegisterEndRenderDelegate()

virtual FDelegateHandle IAudioLinkSynchronizer::RegisterEndRenderDelegate ( const FOnEndRender::FDelegate &  )
pure virtual

◆ RegisterOpenStreamDelegate()

virtual FDelegateHandle IAudioLinkSynchronizer::RegisterOpenStreamDelegate ( const FOnOpenStream::FDelegate &  )
pure virtual

◆ RegisterResumeDelegate()

virtual FDelegateHandle IAudioLinkSynchronizer::RegisterResumeDelegate ( const FOnResume::FDelegate &  )
pure virtual

◆ RegisterSuspendDelegate()

virtual FDelegateHandle IAudioLinkSynchronizer::RegisterSuspendDelegate ( const FOnSuspend::FDelegate &  )
pure virtual

◆ RemoveBeginRenderDelegate()

virtual bool IAudioLinkSynchronizer::RemoveBeginRenderDelegate ( const FDelegateHandle )
pure virtual

◆ RemoveCloseStreamDelegate()

virtual bool IAudioLinkSynchronizer::RemoveCloseStreamDelegate ( const FDelegateHandle )
pure virtual

◆ RemoveEndRenderDelegate()

virtual bool IAudioLinkSynchronizer::RemoveEndRenderDelegate ( const FDelegateHandle )
pure virtual

◆ RemoveOpenStreamDelegate()

virtual bool IAudioLinkSynchronizer::RemoveOpenStreamDelegate ( const FDelegateHandle )
pure virtual

◆ RemoveResumeDelegate()

virtual bool IAudioLinkSynchronizer::RemoveResumeDelegate ( const FDelegateHandle )
pure virtual

◆ RemoveSuspendDelegate()

virtual bool IAudioLinkSynchronizer::RemoveSuspendDelegate ( const FDelegateHandle )
pure virtual

The documentation for this class was generated from the following file: