AZ::Android::AndroidEnv Class Reference

Classes
struct	Descriptor
	Creation POD for the AndroidEnv. More...

Public Member Functions
	AZ_CLASS_ALLOCATOR (AndroidEnv, AZ::OSAllocator)
JNIEnv *	GetJniEnv () const
jclass	GetActivityClassRef () const
	Request the global reference to the activity class.
jobject	GetActivityRef () const
	Request the global reference to the activity instance.
AAssetManager *	GetAssetManager () const
	Get the global pointer to the Android asset manager, which is used for APK file i/o.
AConfiguration *	GetConfiguration () const
	Get the global pointer to the device/application configuration,.
void	SetWindow (ANativeWindow *window)
	Set the global pointer to the Android window surface.
ANativeWindow *	GetWindow () const
	Get the global pointer to the Android window surface.
const char *	GetAppPrivateStoragePath () const
const char *	GetAppPublicStoragePath () const
const char *	GetObbStoragePath () const
const char *	GetPackageName () const
int	GetAppVersionCode () const
	Get the app version code (android:versionCode in the manifest).
const char *	GetObbFileName (bool mainFile) const
	Get the filename of the obb. This doesn't include the path to the obb folder.
bool	IsReady () const
	Check if the AndroidEnv has been initialized.
void	SetIsRunning (bool isRunning)
	Set wheather or not the application should be running.
bool	IsRunning () const
	Check if the application has been backgrounded (false) or not (true)
void	UpdateConfiguration ()
jclass	LoadClass (const char *classPath)

Static Public Member Functions
static AndroidEnv *	Get ()
	Public accessor to the global AndroidEnv instance.
static bool	Create (const Descriptor &descriptor)
	The preferred entry point for the construction of the global AndroidEnv instance.
static void	Destroy ()
	Public accessor to destroy the AndroidEnv global instance.

Member Function Documentation

GetAppPrivateStoragePath()

const char * AZ::Android::AndroidEnv::GetAppPrivateStoragePath ( ) const

inline

Get the hidden internal storage, typically this is where the application is installed on the device. e.g. /data/data/<package_name/files

GetAppPublicStoragePath()

const char * AZ::Android::AndroidEnv::GetAppPublicStoragePath ( ) const

inline

Get the application specific directory for public storage. e.g. <public_storage>/Android/data/<package_name/files

GetJniEnv()

JNIEnv * AZ::Android::AndroidEnv::GetJniEnv

(

)

const

Request a thread specific JNIEnv pointer from the JVM.

Returns

A pointer to the JNIEnv on the current thread.

GetObbStoragePath()

const char * AZ::Android::AndroidEnv::GetObbStoragePath ( ) const

inline

Get the application specific directory for obb files. e.g. <public_storage>/Android/obb/<package_name/files

GetPackageName()

const char * AZ::Android::AndroidEnv::GetPackageName ( ) const

inline

Get the dot separated package name for the current application. e.g. org.o3de.samples for SamplesProject

LoadClass()

jclass AZ::Android::AndroidEnv::LoadClass

(

const char *

classPath

)

Loads a Java class as opposed to attempting to find a loaded class from the call stack.

Parameters

classPath

The fully qualified forward slash separated Java class path.

Returns

A global reference to the desired jclass. Caller is responsible for making a call to DeleteGlobalJniRef when the jclass is no longer needed.

UpdateConfiguration()

void AZ::Android::AndroidEnv::UpdateConfiguration

(

)

If the AndroidEnv owns the native configuration, it will be updated with the latest configuration information, otherwise nothing will happen.

---

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

• Code/Framework/AzCore/Platform/Android/AzCore/Android/AndroidEnv.h