IOSAppDelegate.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#import <UIKit/UIKit.h>
#import <GameKit/GKGameCenterViewController.h>
 
#ifndef SWIFT_IMPORT
#import <AVFoundation/AVAudioSession.h>
#include "Delegates/Delegate.h"
#include "Logging/LogMacros.h"
#include "Containers/UnrealString.h"
#endif
 
#if PLATFORM_VISIONOS
#import <CompositorServices/CompositorServices.h>
#else
#import <UserNotifications/UserNotifications.h>
#endif
 
#define USE_MUTE_SWITCH_DETECTION 0
 
#ifndef SWIFT_IMPORT
 
#if !PLATFORM_TVOS
extern bool GIOSDelayRotationUntilPresent;
#endif
 
enum class EAudioFeature : uint8
{
    Playback, // Audio Not affected by the ringer switch
    Record, // Recording only, unless Playback or VoiceChat is also set
 
    DoNotMixWithOthers, // Do not mix audio with other applications
 
    VoiceChat, // set AVAudioSessionModeVoiceChat when both Playback and Record are enabled
    UseReceiver, // use receiver instead of speaker when both Playback and Record are enabled. Headsets will still be preferred if they are present
    DisableBluetoothSpeaker, // disable the use of Bluetooth A2DP speakers when both Playback and Record are enabled
 
    BluetoothMicrophone, // enable the use of Bluetooth HFP headsets when Record is enabled
 
    BackgroundAudio, // continue to play audio in the background. Requires an appropriate background mode to be set in Info.plist
 
    NumFeatures,
};
 
void LexFromString(EAudioFeature& OutFeature, const TCHAR* String);
FString LexToString(EAudioFeature Feature);
 
// Predicate to decide whether a push notification message should be processed
DECLARE_DELEGATE_RetVal_OneParam(bool, FPushNotificationFilter, NSDictionary*);
 
class APPLICATIONCORE_API FIOSCoreDelegates
{
public:
    // Broadcast when this application is opened from an external source.
    DECLARE_MULTICAST_DELEGATE_FourParams(FOnOpenURL, UIApplication*, NSURL*, NSString*, id);
    static FOnOpenURL OnOpenURL;
 
    static FDelegateHandle AddPushNotificationFilter(const FPushNotificationFilter& FilterDel);
 
    static void RemovePushNotificationFilter(FDelegateHandle Handle);
 
    static bool PassesPushNotificationFilters(NSDictionary* Payload);
 
    DECLARE_MULTICAST_DELEGATE(FOnWillResignActive);
    static FOnWillResignActive OnWillResignActive;
 
    DECLARE_MULTICAST_DELEGATE(FOnDidBecomeActive);
    static FOnWillResignActive OnDidBecomeActive;
    
private:
    struct FFilterDelegateAndHandle
    {
        FPushNotificationFilter Filter;
        FDelegateHandle Handle;
    };
 
    static TArray<FFilterDelegateAndHandle> PushNotificationFilters;
};
 
DECLARE_LOG_CATEGORY_EXTERN(LogIOSAudioSession, Log, All);
 
@class IOSAppDelegate;
 
namespace FAppEntry
{
    void PlatformInit();
    void PreInit(IOSAppDelegate* AppDelegate, UIApplication* Application);
    void Init();
    void Tick();
    void SuspendTick();
    void ResumeAudioContext();
    void ResetAudioContextResumeTime();
    void Shutdown();
    void Suspend(bool bIsInterrupt = false);
    void Resume(bool bIsInterrupt = false);
    void RestartAudio();
    void IncrementAudioSuspendCounters();
    void DecrementAudioSuspendCounters();
 
    bool IsStartupMoviePlaying();
 
    extern bool gAppLaunchedWithLocalNotification;
    extern FString  gLaunchLocalNotificationActivationEvent;
    extern int32    gLaunchLocalNotificationFireDate;
}
 
#endif
 
@class FIOSView;
@class IOSViewController;
 
#ifndef SWIFT_IMPORT
APPLICATIONCORE_API
#endif
@interface IOSAppDelegate : UIResponder <
    UIApplicationDelegate,
#if !UE_BUILD_SHIPPING
    UIGestureRecognizerDelegate,
#endif
    GKGameCenterControllerDelegate,
#if !PLATFORM_VISIONOS
    UNUserNotificationCenterDelegate,
#endif
    UITextFieldDelegate>
{
    bool bForceExit;
}
 
@property (strong, retain, nonatomic) UIWindow *Window;
 
// support Compositor on other platforms?
#if PLATFORM_VISIONOS
@property (strong) CP_OBJECT_cp_layer_renderer* SwiftLayer;
@property (retain) NSArray* SwiftLayerViewports;
#endif
 
@property (retain) FIOSView* IOSView;
 
#ifndef SWIFT_IMPORT
@property class FIOSApplication* IOSApplication;
#endif
 
@property (retain) IOSViewController* IOSController;
 
@property (retain) UIView* RootView;
 
@property (assign) int AlertResponse;
 
@property (readonly) float OSVersion;
 
@property bool bDeviceInPortraitMode;
 
@property (retain) UIViewController* viewController;
 
@property (retain) NSTimer* timer;
 
@property (retain) NSTimer* PeakMemoryTimer;
 
@property (retain) NSTimer* IdleTimerEnableTimer;
 
@property (readonly) float IdleTimerEnablePeriod;
 
#if WITH_ACCESSIBILITY
@property (nonatomic, retain) NSTimer* AccessibilityCacheTimer;
-(void)OnVoiceOverStatusChanged;
#endif
 
// parameters passed from openURL
@property (nonatomic, retain) NSMutableArray* savedOpenUrlParameters;
 
#if !UE_BUILD_SHIPPING && !PLATFORM_TVOS
    @property (nonatomic, retain) UIAlertController* ConsoleAlertController;
    @property (nonatomic, retain) NSMutableArray*   ConsoleHistoryValues;
    @property (nonatomic, assign) int               ConsoleHistoryValuesIndex;
#endif
 
@property (atomic) bool bEngineInit;
@property (atomic) bool bPlatformInit;
 
 
@property (retain) NSTimer* CommandLineParseTimer;
@property (atomic) bool bCommandLineReady;
 
#if !PLATFORM_TVOS
@property (assign) UIInterfaceOrientation InterfaceOrientation;
#endif
 
@property (retain) NSDictionary* launchOptions;
 
@property (assign) NSProcessInfoThermalState ThermalState;
@property (assign) bool bBatteryState;
@property (assign) int BatteryLevel;
 
@property (assign) float ScreenScale;   // UIScreen.scale
@property (assign) float NativeScale;   // UIWindow.screen.nativeScale
@property (assign) float MobileContentScaleFactor;
@property (assign) int RequestedResX;
@property (assign) int RequestedResY;
@property (assign) bool bUpdateAvailable;
@property (retain) NSString* PendingActivationProtocol;
+ (IOSAppDelegate*)GetDelegate;
 
-(bool)IsIdleTimerEnabled;
-(void)EnableIdleTimer:(bool)bEnable;
-(void)StartGameThread;
#ifndef SWIFT_IMPORT
+(bool)WaitAndRunOnGameThread:(TUniqueFunction<void()>)Function;
#endif
-(void)NoUrlCommandLine;
 
-(void)LoadScreenResolutionModifiers;
 
-(int)GetAudioVolume;
-(bool)AreHeadphonesPluggedIn;
-(int)GetBatteryLevel;
-(bool)IsRunningOnBattery;
-(NSProcessInfoThermalState)GetThermalState;
-(void)CheckForZoomAccessibility;
-(float)GetBackgroundingMainThreadBlockTime;
-(void)OverrideBackgroundingMainThreadBlockTime:(float)BlockTime;
-(NSString*)GetPendingActivationProtocol;
-(void)SetPendingActivationProtocol:(NSString *)NewProtocol;
 
#if !PLATFORM_TVOS && !PLATFORM_VISIONOS && !defined(SWIFT_IMPORT)
  +(EDeviceScreenOrientation) ConvertFromUIInterfaceOrientation:(UIInterfaceOrientation)Orientation;
  +(UIInterfaceOrientation) GetUIInterfaceOrientationFromUIDeviceOrientation:(UIDeviceOrientation)Orientation;
  +(UIInterfaceOrientationMask) GetMaskFromUIInterfaceOrientation:(UIInterfaceOrientation)Orientation;
  +(UIInterfaceOrientationMask) GetMaskFromEDeviceScreenOrientation:(EDeviceScreenOrientation)Orientation;
#endif
 
#if !PLATFORM_TVOS && !PLATFORM_VISIONOS
  +(void)UpdateSupportedInterfaceOrientations;
#endif
 
-(bool)IsUpdateAvailable;
 
-(void) didRotate:(NSNotification*)notification;
 
@property (assign) bool bAudioSessionInitialized;
 
@property (assign) bool bUsingBackgroundMusic;
@property (assign) bool bLastOtherAudioPlaying;
@property (assign) bool bForceEmitOtherAudioPlaying;
 
#if USE_MUTE_SWITCH_DETECTION
@property (assign) bool bLastMutedState;
@property (assign) bool bForceEmitMutedState;
#endif
 
@property (assign) float LastVolume;
@property (assign) bool bForceEmitVolume;
 
- (void)InitializeAudioSession;
- (void)ToggleAudioSession:(bool)bActive;
- (bool)IsBackgroundAudioPlaying;
- (bool)HasRecordPermission;
- (void)EnableVoiceChat:(bool)bEnable;
- (void)EnableHighQualityVoiceChat:(bool)bEnable;
- (bool)IsVoiceChatEnabled;
 
#ifndef SWIFT_IMPORT
- (void)SetFeature:(EAudioFeature)Feature Active:(bool)bIsActive;
- (bool)IsFeatureActive:(EAudioFeature)Mode;
#endif
 
@property (atomic) bool bAudioActive;
@property (atomic) bool bVoiceChatEnabled;
 
@property (atomic) bool bIsSuspended;
@property (atomic) bool bHasSuspended;
@property (atomic) bool bHasStarted;
- (void)ToggleSuspend:(bool)bSuspend;
 
- (void)ForceExit;
 
static void interruptionListener(void* ClientData, UInt32 Interruption);
 
-(UIWindow*)window;
 
@end
 
void InstallSignalHandlers();