AppleVoiceOver.h

Go to the documentation of this file.

 
#ifndef APPLE_VO_AUDIO_H
#define APPLE_VO_AUDIO_H
 
#define APPLE_VOICE_OVER_AUDIO_PROTOCOL_GUID \
  { 0xF4CB0B78, 0x243B, 0x11E7,              \
    { 0xA5, 0x24, 0xB8, 0xE8, 0x56, 0x2C, 0xBA, 0xFA } }
 
typedef struct APPLE_VOICE_OVER_AUDIO_PROTOCOL_ APPLE_VOICE_OVER_AUDIO_PROTOCOL;
 
#define APPLE_VOICE_OVER_AUDIO_PROTOCOL_REVISION  0x10000
 
typedef enum {
  AppleVoiceOverAudioFileIndexLocalisedMin           = 0x01, 
  AppleVoiceOverAudioFileVoiceOverOn                 = 0x01, 
  AppleVoiceOverAudioFileVoiceOverOff                = 0x02, 
  AppleVoiceOverAudioFileUsername                    = 0x03, 
  AppleVoiceOverAudioFilePassword                    = 0x04, 
  AppleVoiceOverAudioFileUsernameOrPasswordIncorrect = 0x05, 
  AppleVoiceOverAudioFileAccountLockedTryLater       = 0x06, 
  AppleVoiceOverAudioFileAccountLocked               = 0x07, 
  AppleVoiceOverAudioFileIndexLocalisedMax           = 0x08, 
  AppleVoiceOverAudioFileIndexNonLocalisedMin        = 0x3B, 
  AppleVoiceOverAudioFileVoiceOverBoot               = 0x3B, 
  AppleVoiceOverAudioFileVoiceOverBoot2              = 0x3C, 
  AppleVoiceOverAudioFileClick                       = 0x3D, 
  AppleVoiceOverAudioFileBeep                        = 0x3E, 
  AppleVoiceOverAudioFileIndexNonLocalisedMax        = 0x3F, 
} APPLE_VOICE_OVER_AUDIO_FILE;
 
#define APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_ON                   "VoiceOverOn"
#define APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_OFF                  "VoiceOverOff"
#define APPLE_VOICE_OVER_AUDIO_FILE_USERNAME                        "Username"
#define APPLE_VOICE_OVER_AUDIO_FILE_PASSWORD                        "Password"
#define APPLE_VOICE_OVER_AUDIO_FILE_USERNAME_OR_PASSWORD_INCORRECT  "UsernameOrPasswordIncorrect"
#define APPLE_VOICE_OVER_AUDIO_FILE_ACCOUNT_LOCKED_TRY_LATER        "AccountLockedTryLater"
#define APPLE_VOICE_OVER_AUDIO_FILE_ACCOUNT_LOCKED                  "AccountLocked"
#define APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_BOOT                 "VoiceOver_Boot"
#define APPLE_VOICE_OVER_AUDIO_FILE_CLICK                           "Click"
#define APPLE_VOICE_OVER_AUDIO_FILE_BEEP                            "Beep"
 
typedef enum {
  AppleVoiceOverLanguageAr     = 0x01, 
  AppleVoiceOverLanguageCa     = 0x02, 
  AppleVoiceOverLanguageCs     = 0x03, 
  AppleVoiceOverLanguageDa     = 0x04, 
  AppleVoiceOverLanguageDe     = 0x05, 
  AppleVoiceOverLanguageEl     = 0x06, 
  AppleVoiceOverLanguageEn     = 0x07, 
  AppleVoiceOverLanguageEs     = 0x08, 
  AppleVoiceOverLanguageEs419  = 0x09, 
  AppleVoiceOverLanguageEsMx   = 0x0A, 
  AppleVoiceOverLanguageFi     = 0x0B, 
  AppleVoiceOverLanguageFr     = 0x0C, 
  AppleVoiceOverLanguageHe     = 0x0D, 
  AppleVoiceOverLanguageHi     = 0x0E, 
  AppleVoiceOverLanguageHr     = 0x0F, 
  AppleVoiceOverLanguageHu     = 0x10, 
  AppleVoiceOverLanguageId     = 0x11, 
  AppleVoiceOverLanguageIt     = 0x12, 
  AppleVoiceOverLanguageJa     = 0x13, 
  AppleVoiceOverLanguageKo     = 0x14, 
  AppleVoiceOverLanguageNl     = 0x15, 
  AppleVoiceOverLanguageNo     = 0x16, 
  AppleVoiceOverLanguageMy     = 0x17, 
  AppleVoiceOverLanguagePl     = 0x18, 
  AppleVoiceOverLanguagePt     = 0x19, 
  AppleVoiceOverLanguagePtPt   = 0x1A, 
  AppleVoiceOverLanguageRo     = 0x1B, 
  AppleVoiceOverLanguageRu     = 0x1C, 
  AppleVoiceOverLanguageSk     = 0x1D, 
  AppleVoiceOverLanguageSv     = 0x1E, 
  AppleVoiceOverLanguageTh     = 0x1F, 
  AppleVoiceOverLanguageTr     = 0x20, 
  AppleVoiceOverLanguageUk     = 0x21, 
  AppleVoiceOverLanguageVi     = 0x22, 
  AppleVoiceOverLanguageZhHans = 0x23, 
  AppleVoiceOverLanguageZhHant = 0x24, 
} APPLE_VOICE_OVER_LANGUAGE_CODE;
 
typedef
EFI_STATUS
(EFIAPI *APPLE_VOICE_OVER_AUDIO_PLAY)(
  IN     APPLE_VOICE_OVER_AUDIO_PROTOCOL  *This,
  IN     UINT8                            File
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_VOICE_OVER_AUDIO_SET_LANGUAGE_CODE)(
  IN     APPLE_VOICE_OVER_AUDIO_PROTOCOL  *This,
  IN     UINT8                            LanguageCode
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_VOICE_OVER_AUDIO_SET_LANGUAGE_STRING)(
  IN     APPLE_VOICE_OVER_AUDIO_PROTOCOL  *This,
  IN     CONST CHAR8                      *LanguageString
  );
 
typedef
EFI_STATUS
(EFIAPI *APPLE_VOICE_OVER_AUDIO_GET_LANGUAGE)(
  IN     APPLE_VOICE_OVER_AUDIO_PROTOCOL  *This,
  OUT    UINT8                            *LanguageCode,
  OUT    CONST CHAR8                      **LanguageString
  );
 
struct APPLE_VOICE_OVER_AUDIO_PROTOCOL_ {
  UINTN                                         Revision;
  APPLE_VOICE_OVER_AUDIO_PLAY                   Play;
  APPLE_VOICE_OVER_AUDIO_SET_LANGUAGE_CODE      SetLanguageCode;
  APPLE_VOICE_OVER_AUDIO_SET_LANGUAGE_STRING    SetLanguageString;
  APPLE_VOICE_OVER_AUDIO_GET_LANGUAGE           GetLanguage;
};
 
extern EFI_GUID  gAppleVOAudioProtocolGuid;
 
#endif // APPLE_VO_AUDIO_H