IOSAppDelegate Class Reference

#include <IOSAppDelegate.h>

Inheritance diagram for IOSAppDelegate:

Instance Methods
(bool)	- IsIdleTimerEnabled
(void)	- EnableIdleTimer:
(void)	- StartGameThread
(void)	- NoUrlCommandLine
(void)	- LoadScreenResolutionModifiers
(int)	- GetAudioVolume
(bool)	- AreHeadphonesPluggedIn
(int)	- GetBatteryLevel
(bool)	- IsRunningOnBattery
(NSProcessInfoThermalState)	- GetThermalState
(void)	- CheckForZoomAccessibility
(float)	- GetBackgroundingMainThreadBlockTime
(void)	- OverrideBackgroundingMainThreadBlockTime:
(NSString *)	- GetPendingActivationProtocol
(void)	- SetPendingActivationProtocol:
(bool)	- IsUpdateAvailable
(void)	- didRotate:
(void)	- InitializeAudioSession
(void)	- ToggleAudioSession:
(bool)	- IsBackgroundAudioPlaying
(bool)	- HasRecordPermission
(void)	- EnableVoiceChat:
(void)	- EnableHighQualityVoiceChat:
(bool)	- IsVoiceChatEnabled
(void)	- SetFeature:Active:
(bool)	- IsFeatureActive:
(void)	- ToggleSuspend:
(void)	- ForceExit
(UIWindow *)	- window

Class Methods
(IOSAppDelegate *)	+ GetDelegate
(bool)	+ WaitAndRunOnGameThread:
(EDeviceScreenOrientation)	+ ConvertFromUIInterfaceOrientation:
(UIInterfaceOrientation)	+ GetUIInterfaceOrientationFromUIDeviceOrientation:
(UIInterfaceOrientationMask)	+ GetMaskFromUIInterfaceOrientation:
(UIInterfaceOrientationMask)	+ GetMaskFromEDeviceScreenOrientation:
(void)	+ UpdateSupportedInterfaceOrientations
(static void)	+ interruptionListener

Protected Attributes
bool	bForceExit

Properties
UIWindow *	Window
FIOSView *	IOSView
class FIOSApplication *	IOSApplication
IOSViewController *	IOSController
UIView *	RootView
int	AlertResponse
float	OSVersion
bool	bDeviceInPortraitMode
UIViewController *	viewController
NSTimer *	timer
NSTimer *	PeakMemoryTimer
NSTimer *	IdleTimerEnableTimer
float	IdleTimerEnablePeriod
NSMutableArray *	savedOpenUrlParameters
UIAlertController *	ConsoleAlertController
NSMutableArray *	ConsoleHistoryValues
int	ConsoleHistoryValuesIndex
bool	bEngineInit
bool	bPlatformInit
NSTimer *	CommandLineParseTimer
bool	bCommandLineReady
UIInterfaceOrientation	InterfaceOrientation
NSDictionary *	launchOptions
NSProcessInfoThermalState	ThermalState
bool	bBatteryState
int	BatteryLevel
float	ScreenScale
float	NativeScale
float	MobileContentScaleFactor
int	RequestedResX
int	RequestedResY
bool	bUpdateAvailable
NSString *	PendingActivationProtocol
bool	bAudioSessionInitialized
bool	bUsingBackgroundMusic
bool	bLastOtherAudioPlaying
bool	bForceEmitOtherAudioPlaying
float	LastVolume
bool	bForceEmitVolume
bool	bAudioActive
bool	bVoiceChatEnabled
bool	bIsSuspended
bool	bHasSuspended
bool	bHasStarted

Method Documentation

AreHeadphonesPluggedIn

- (bool) AreHeadphonesPluggedIn

CheckForZoomAccessibility

- (void) CheckForZoomAccessibility

ConvertFromUIInterfaceOrientation:

+ (EDeviceScreenOrientation) ConvertFromUIInterfaceOrientation:

(UIInterfaceOrientation)

Orientation

didRotate:

- (void) didRotate:

(NSNotification*)

notification

EnableHighQualityVoiceChat:

- (void) EnableHighQualityVoiceChat:

(bool)

bEnable

EnableIdleTimer:

- (void) EnableIdleTimer:

(bool)

bEnable

EnableVoiceChat:

- (void) EnableVoiceChat:

(bool)

bEnable

ForceExit

- (void) ForceExit

GetAudioVolume

- (int) GetAudioVolume

GetBackgroundingMainThreadBlockTime

- (float) GetBackgroundingMainThreadBlockTime

GetBatteryLevel

- (int) GetBatteryLevel

GetDelegate

+ (IOSAppDelegate *) GetDelegate

Returns

the single app delegate object

GetMaskFromEDeviceScreenOrientation:

+ (UIInterfaceOrientationMask) GetMaskFromEDeviceScreenOrientation:

(EDeviceScreenOrientation)

Orientation

GetMaskFromUIInterfaceOrientation:

+ (UIInterfaceOrientationMask) GetMaskFromUIInterfaceOrientation:

(UIInterfaceOrientation)

Orientation

GetPendingActivationProtocol

- (NSString *) GetPendingActivationProtocol

GetThermalState

- (NSProcessInfoThermalState) GetThermalState

GetUIInterfaceOrientationFromUIDeviceOrientation:

+ (UIInterfaceOrientation) GetUIInterfaceOrientationFromUIDeviceOrientation:

(UIDeviceOrientation)

Orientation

HasRecordPermission

- (bool) HasRecordPermission

InitializeAudioSession

- (void) InitializeAudioSession

interruptionListener

+ (static void) interruptionListener		(void *)	ClientData
		(UInt32)	Interruption

IsBackgroundAudioPlaying

- (bool) IsBackgroundAudioPlaying

IsFeatureActive:

- (bool) IsFeatureActive:

(EAudioFeature)

Mode

IsIdleTimerEnabled

- (bool) IsIdleTimerEnabled

IsRunningOnBattery

- (bool) IsRunningOnBattery

IsUpdateAvailable

- (bool) IsUpdateAvailable

IsVoiceChatEnabled

- (bool) IsVoiceChatEnabled

LoadScreenResolutionModifiers

- (void) LoadScreenResolutionModifiers

NoUrlCommandLine

- (void) NoUrlCommandLine

OverrideBackgroundingMainThreadBlockTime:

- (void) OverrideBackgroundingMainThreadBlockTime:

(float)

BlockTime

SetFeature:Active:

- (void) SetFeature:		(EAudioFeature)	Feature
Active:		(bool)	bIsActive

Enable/Disable an EAudioFeature. This is reference counted, so a feature must be disabled as many times as it has been enabled to actually be disabled.

SetPendingActivationProtocol:

- (void) SetPendingActivationProtocol:

(NSString *)

NewProtocol

StartGameThread

- (void) StartGameThread

ToggleAudioSession:

- (void) ToggleAudioSession:

(bool)

bActive

ToggleSuspend:

- (void) ToggleSuspend:

(bool)

bSuspend

UpdateSupportedInterfaceOrientations

+ (void) UpdateSupportedInterfaceOrientations

WaitAndRunOnGameThread:

+ (bool) WaitAndRunOnGameThread:

(TUniqueFunction<void()>)

Function

Uses the TaskGraph to execute a function on the game thread, and then blocks until the function is executed.

window

- (UIWindow *) window

Member Data Documentation

bForceExit

- (bool) bForceExit

protected

Property Documentation

AlertResponse

- (int) AlertResponse

readwriteatomicassign

The value of the alert response (atomically set since main thread and game thread use it

BatteryLevel

- (int) BatteryLevel

readwriteatomicassign

bAudioActive

- (bool) bAudioActive

readwriteatomicassign

bAudioSessionInitialized

- (bool) bAudioSessionInitialized

readwriteatomicassign

bBatteryState

- (bool) bBatteryState

readwriteatomicassign

bCommandLineReady

- (bool) bCommandLineReady

readwriteatomicassign

bDeviceInPortraitMode

- (bool) bDeviceInPortraitMode

readwriteatomic

bEngineInit

- (bool) bEngineInit

readwriteatomicassign

True if the engine has been initialized

bForceEmitOtherAudioPlaying

- (bool) bForceEmitOtherAudioPlaying

readwriteatomicassign

bForceEmitVolume

- (bool) bForceEmitVolume

readwriteatomicassign

bHasStarted

- (bool) bHasStarted

readwriteatomicassign

bHasSuspended

- (bool) bHasSuspended

readwriteatomicassign

bIsSuspended

- (bool) bIsSuspended

readwriteatomicassign

bLastOtherAudioPlaying

- (bool) bLastOtherAudioPlaying

readwriteatomicassign

bPlatformInit

- (bool) bPlatformInit

readwriteatomicassign

True after the end of FAppEntry::PlatformInit

bUpdateAvailable

- (bool) bUpdateAvailable

readwriteatomicassign

bUsingBackgroundMusic

- (bool) bUsingBackgroundMusic

readwriteatomicassign

TRUE if the device is playing background music and we want to allow that

bVoiceChatEnabled

- (bool) bVoiceChatEnabled

readwriteatomicassign

CommandLineParseTimer

- (NSTimer*) CommandLineParseTimer

readwriteatomicretain

Delays game initialization slightly in case we have a URL launch to handle

ConsoleAlertController

- (UIAlertController*) ConsoleAlertController

readwritenonatomicretain

Properties for managing the console

ConsoleHistoryValues

- (NSMutableArray*) ConsoleHistoryValues

readwritenonatomicretain

ConsoleHistoryValuesIndex

- (int) ConsoleHistoryValuesIndex

readwritenonatomicassign

IdleTimerEnablePeriod

- (float) IdleTimerEnablePeriod

readatomicassign

The time delay (in seconds) between idle timer enable requests and actually enabling the idle timer

IdleTimerEnableTimer

- (NSTimer*) IdleTimerEnableTimer

readwriteatomicretain

Timer used for re-enabling the idle timer

InterfaceOrientation

- (UIInterfaceOrientation) InterfaceOrientation

readwriteatomicassign

IOSApplication

- (class FIOSApplication*) IOSApplication

IOSController

- (IOSViewController*) IOSController

readwriteatomicretain

The controller for the main view

IOSView

- (FIOSView*) IOSView

readwriteatomicretain

The view containing the game contents

LastVolume

- (float) LastVolume

readwriteatomicassign

launchOptions

- (NSDictionary*) launchOptions

readwriteatomicretain

initial launch options

MobileContentScaleFactor

- (float) MobileContentScaleFactor

readwriteatomicassign

NativeScale

- (float) NativeScale

readwriteatomicassign

OSVersion

- (float) OSVersion

readatomicassign

Version of the OS we are running on (NOT compiled with)

PeakMemoryTimer

- (NSTimer*) PeakMemoryTimer

readwriteatomicretain

PendingActivationProtocol

- (NSString*) PendingActivationProtocol

readwriteatomicretain

RequestedResX

- (int) RequestedResX

readwriteatomicassign

RequestedResY

- (int) RequestedResY

readwriteatomicassign

RootView

- (UIView*) RootView

readwriteatomicretain

The view controlled by the auto-rotating controller

savedOpenUrlParameters

- (NSMutableArray*) savedOpenUrlParameters

readwritenonatomicretain

ScreenScale

- (float) ScreenScale

readwriteatomicassign

ThermalState

- (NSProcessInfoThermalState) ThermalState

readwriteatomicassign

timer

- (NSTimer*) timer

readwriteatomicretain

viewController

- (UIViewController*) viewController

readwriteatomicretain

splash screen view controller

Window

- (UIWindow*) Window

readwritenonatomicretain

Window object

---

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

• Engine/Source/Runtime/ApplicationCore/Private/IOS/IOSAppDelegate.cpp
• Engine/Source/Runtime/ApplicationCore/Public/IOS/IOSAppDelegate.h