Engage Engine API  1.246.9086
Loading...
Searching...
No Matches
AppConfigurationObjects::AndroidAudio Class Reference

Default audio settings for AndroidAudio. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions

void clear ()
 
- Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void initForDocumenting ()
 
virtual std::string toString ()
 
virtual bool isDocumenting () const
 

Public Attributes

int api
 [Optional, Default 0] Android audio API version: 0=Unspecified, 1=AAudio, 2=OpenGLES
 
int sharingMode
 [Optional, Default 0] Sharing mode: 0=Exclusive, 1=Shared
 
int performanceMode
 [Optional, Default 12] Performance mode: 10=None/Default, 11=PowerSaving, 12=LowLatency
 
int usage
 [Optional, Default 2] Usage type: 1=Media 2=VoiceCommunication 3=VoiceCommunicationSignalling 4=Alarm 5=Notification 6=NotificationRingtone 10=NotificationEvent 11=AssistanceAccessibility 12=AssistanceNavigationGuidance 13=AssistanceSonification 14=Game 16=Assistant
 
int contentType
 [Optional, Default 1] Usage type: 1=Speech 2=Music 3=Movie 4=Sonification
 
int inputPreset
 [Optional, Default 7] Input preset: 1=Generic 5=Camcorder 6=VoiceRecognition 7=VoiceCommunication 9=Unprocessed 10=VoicePerformance
 
int sessionId
 [Optional, Default INVALID_SESSION_ID] A session ID from the Android AudioManager
 
int engineMode
 [Optional, Default 0] 0=use legacy low-level APIs, 1=use high-level Android APIs
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Static Public Attributes

static constexpr int INVALID_SESSION_ID = -9999
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Default audio settings for AndroidAudio.

Helper C++ class to serialize and de-serialize AndroidAudio JSON

Example:

See also
TODO: ConfigurationObjects::AndroidAudio

Definition at line 5709 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ AndroidAudio()

AppConfigurationObjects::AndroidAudio::AndroidAudio ( )
inline

Definition at line 5767 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::AndroidAudio::clear ( )
inline

Definition at line 5772 of file ConfigurationObjects.h.

Member Data Documentation

◆ api

int AppConfigurationObjects::AndroidAudio::api

[Optional, Default 0] Android audio API version: 0=Unspecified, 1=AAudio, 2=OpenGLES

Definition at line 5718 of file ConfigurationObjects.h.

◆ contentType

int AppConfigurationObjects::AndroidAudio::contentType

[Optional, Default 1] Usage type: 1=Speech 2=Music 3=Movie 4=Sonification

Definition at line 5748 of file ConfigurationObjects.h.

◆ engineMode

int AppConfigurationObjects::AndroidAudio::engineMode

[Optional, Default 0] 0=use legacy low-level APIs, 1=use high-level Android APIs

Definition at line 5764 of file ConfigurationObjects.h.

◆ inputPreset

int AppConfigurationObjects::AndroidAudio::inputPreset

[Optional, Default 7] Input preset: 1=Generic 5=Camcorder 6=VoiceRecognition 7=VoiceCommunication 9=Unprocessed 10=VoicePerformance

Definition at line 5758 of file ConfigurationObjects.h.

◆ INVALID_SESSION_ID

constexpr int AppConfigurationObjects::AndroidAudio::INVALID_SESSION_ID = -9999
staticconstexpr

Definition at line 5715 of file ConfigurationObjects.h.

◆ performanceMode

int AppConfigurationObjects::AndroidAudio::performanceMode

[Optional, Default 12] Performance mode: 10=None/Default, 11=PowerSaving, 12=LowLatency

Definition at line 5724 of file ConfigurationObjects.h.

◆ sessionId

int AppConfigurationObjects::AndroidAudio::sessionId

[Optional, Default INVALID_SESSION_ID] A session ID from the Android AudioManager

Definition at line 5761 of file ConfigurationObjects.h.

◆ sharingMode

int AppConfigurationObjects::AndroidAudio::sharingMode

[Optional, Default 0] Sharing mode: 0=Exclusive, 1=Shared

Definition at line 5721 of file ConfigurationObjects.h.

◆ usage

int AppConfigurationObjects::AndroidAudio::usage

[Optional, Default 2] Usage type: 1=Media 2=VoiceCommunication 3=VoiceCommunicationSignalling 4=Alarm 5=Notification 6=NotificationRingtone 10=NotificationEvent 11=AssistanceAccessibility 12=AssistanceNavigationGuidance 13=AssistanceSonification 14=Game 16=Assistant

Definition at line 5740 of file ConfigurationObjects.h.


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