AppleVoiceOver.h File Reference

Go to the source code of this file.

Data Structures
struct	APPLE_VOICE_OVER_AUDIO_PROTOCOL_

Macros
#define	APPLE_VOICE_OVER_AUDIO_PROTOCOL_GUID
#define	APPLE_VOICE_OVER_AUDIO_PROTOCOL_REVISION   0x10000
#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"

Typedefs
typedef struct APPLE_VOICE_OVER_AUDIO_PROTOCOL_	APPLE_VOICE_OVER_AUDIO_PROTOCOL
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)

Enumerations
enum	APPLE_VOICE_OVER_AUDIO_FILE {   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 }
enum	APPLE_VOICE_OVER_LANGUAGE_CODE {   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 }

Variables
EFI_GUID	gAppleVOAudioProtocolGuid

Detailed Description

Apple VoiceOver Audio protocol.

Copyright (C) 2020, vit9696. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file AppleVoiceOver.h.

Macro Definition Documentation

APPLE_VOICE_OVER_AUDIO_FILE_ACCOUNT_LOCKED

#define APPLE_VOICE_OVER_AUDIO_FILE_ACCOUNT_LOCKED   "AccountLocked"

Definition at line 70 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_ACCOUNT_LOCKED_TRY_LATER

#define APPLE_VOICE_OVER_AUDIO_FILE_ACCOUNT_LOCKED_TRY_LATER   "AccountLockedTryLater"

Definition at line 69 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_BEEP

#define APPLE_VOICE_OVER_AUDIO_FILE_BEEP   "Beep"

Definition at line 73 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_CLICK

#define APPLE_VOICE_OVER_AUDIO_FILE_CLICK   "Click"

Definition at line 72 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_PASSWORD

#define APPLE_VOICE_OVER_AUDIO_FILE_PASSWORD   "Password"

Definition at line 67 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_USERNAME

#define APPLE_VOICE_OVER_AUDIO_FILE_USERNAME   "Username"

Definition at line 66 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_USERNAME_OR_PASSWORD_INCORRECT

#define APPLE_VOICE_OVER_AUDIO_FILE_USERNAME_OR_PASSWORD_INCORRECT   "UsernameOrPasswordIncorrect"

Definition at line 68 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_BOOT

#define APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_BOOT   "VoiceOver_Boot"

Definition at line 71 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_OFF

#define APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_OFF   "VoiceOverOff"

Definition at line 65 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_ON

#define APPLE_VOICE_OVER_AUDIO_FILE_VOICE_OVER_ON   "VoiceOverOn"

Corresponding file base names.

Definition at line 64 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_PROTOCOL_GUID

#define APPLE_VOICE_OVER_AUDIO_PROTOCOL_GUID

Value:

  { 0xF4CB0B78, 0x243B, 0x11E7,              \
    { 0xA5, 0x24, 0xB8, 0xE8, 0x56, 0x2C, 0xBA, 0xFA } }

Apple VoiceOver Audio protocol GUID. This protocol is present on Gibraltar Macs (ones with T1/T2 and custom HDA). F4CB0B78-243B-11E7-A524-B8E8562CBAFA

Definition at line 23 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_PROTOCOL_REVISION

#define APPLE_VOICE_OVER_AUDIO_PROTOCOL_REVISION   0x10000

Apple VoiceOver Audio protocol revision.

Definition at line 32 of file AppleVoiceOver.h.

Typedef Documentation

APPLE_VOICE_OVER_AUDIO_GET_LANGUAGE

typedef EFI_STATUS(EFIAPI * APPLE_VOICE_OVER_AUDIO_GET_LANGUAGE) (IN APPLE_VOICE_OVER_AUDIO_PROTOCOL *This, OUT UINT8 *LanguageCode, OUT CONST CHAR8 **LanguageString)

Get current VoiceOver language.

Parameters

[in]	This	VoiceOver protocol instance.
[out]	LanguageCode	Current language code (e.g. AppleVoiceOverLanguageRu).
[out]	LanguageString	Current language string (e.g. ru) or NULL.

Return values

EFI_SUCCESS	on successful language update.
EFI_INVALID_PARAMETER	when the language is unsupported.

Definition at line 177 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_PLAY

typedef EFI_STATUS(EFIAPI * APPLE_VOICE_OVER_AUDIO_PLAY) (IN APPLE_VOICE_OVER_AUDIO_PROTOCOL *This, IN UINT8 File)

Play audio file.

Parameters

[in]	This	VoiceOver protocol instance.
[in]	File	File to play.

Return values

EFI_SUCCESS	on successful playback startup.
EFI_NOT_FOUND	when audio device is missing.
EFI_INVALID_PARAMETER	when audio file is not valid.

Definition at line 128 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_PROTOCOL

typedef struct APPLE_VOICE_OVER_AUDIO_PROTOCOL_ APPLE_VOICE_OVER_AUDIO_PROTOCOL

Definition at line 27 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_SET_LANGUAGE_CODE

typedef EFI_STATUS(EFIAPI * APPLE_VOICE_OVER_AUDIO_SET_LANGUAGE_CODE) (IN APPLE_VOICE_OVER_AUDIO_PROTOCOL *This, IN UINT8 LanguageCode)

Set language for VoiceOver support via code.

Parameters

[in]	This	VoiceOver protocol instance.
[in]	LanguageCode	Language code (e.g. AppleVoiceOverLanguageEn).

Return values

EFI_SUCCESS	on successful language update.
EFI_INVALID_PARAMETER	when the language is unsupported.

Definition at line 144 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_AUDIO_SET_LANGUAGE_STRING

typedef EFI_STATUS(EFIAPI * APPLE_VOICE_OVER_AUDIO_SET_LANGUAGE_STRING) (IN APPLE_VOICE_OVER_AUDIO_PROTOCOL *This, IN CONST CHAR8 *LanguageString)

Set language for VoiceOver support via string.

Parameters

[in]	This	VoiceOver protocol instance.
[in]	LanguageString	Language string (e.g. ru or ru-RU).

Return values

EFI_SUCCESS	on successful language update.
EFI_INVALID_PARAMETER	when the language is unsupported.

Definition at line 160 of file AppleVoiceOver.h.

Enumeration Type Documentation

APPLE_VOICE_OVER_AUDIO_FILE

enum APPLE_VOICE_OVER_AUDIO_FILE

These files can be found either on BridgeOS volume: /System/Library/PrivateFrameworks/BridgeAccessibilitySupport.framework/AXEFIAudio_[ru]_[VoiceOverOn].aiff Here language code (ru) can be both full (ru_RU) and short (ru). For unlocalised files language code can be missing entirely, e.g. AXEFIAudio_Beep.aiff. Or in /Volumes/Preboot/.../System/Library/Caches/com.apple.corestorage/EFILoginLocalizations/sound.efires For preboot the file format is sound_SCREFIAudio.VoiceOverOn. Files marked with * are only present on BridgeOS.

Enumerator
AppleVoiceOverAudioFileIndexLocalisedMin	First valid localised file.
AppleVoiceOverAudioFileVoiceOverOn	VoiceOverOn.
AppleVoiceOverAudioFileVoiceOverOff	VoiceOverOff.
AppleVoiceOverAudioFileUsername	Username.
AppleVoiceOverAudioFilePassword	Password.
AppleVoiceOverAudioFileUsernameOrPasswordIncorrect	UsernameOrPasswordIncorrect.
AppleVoiceOverAudioFileAccountLockedTryLater	AccountLockedTryLater (*)
AppleVoiceOverAudioFileAccountLocked	AccountLocked (*)
AppleVoiceOverAudioFileIndexLocalisedMax	After last valid localised file.
AppleVoiceOverAudioFileIndexNonLocalisedMin	First valid non-localised file.
AppleVoiceOverAudioFileVoiceOverBoot	VoiceOver_Boot (*)
AppleVoiceOverAudioFileVoiceOverBoot2	VoiceOver_Boot (*)
AppleVoiceOverAudioFileClick	Click (*)
AppleVoiceOverAudioFileBeep	Beep.
AppleVoiceOverAudioFileIndexNonLocalisedMax	After last valid non-localised file.

Definition at line 43 of file AppleVoiceOver.h.

APPLE_VOICE_OVER_LANGUAGE_CODE

enum APPLE_VOICE_OVER_LANGUAGE_CODE

VoiceOver language codes.

Enumerator
AppleVoiceOverLanguageAr	ar
AppleVoiceOverLanguageCa	ca
AppleVoiceOverLanguageCs	cs
AppleVoiceOverLanguageDa	da
AppleVoiceOverLanguageDe	de
AppleVoiceOverLanguageEl	el
AppleVoiceOverLanguageEn	en
AppleVoiceOverLanguageEs	es
AppleVoiceOverLanguageEs419	es-419
AppleVoiceOverLanguageEsMx	es-MX
AppleVoiceOverLanguageFi	fi
AppleVoiceOverLanguageFr	fr
AppleVoiceOverLanguageHe	he
AppleVoiceOverLanguageHi	hi
AppleVoiceOverLanguageHr	hr
AppleVoiceOverLanguageHu	hu
AppleVoiceOverLanguageId	id
AppleVoiceOverLanguageIt	it
AppleVoiceOverLanguageJa	ja
AppleVoiceOverLanguageKo	ko
AppleVoiceOverLanguageNl	nl
AppleVoiceOverLanguageNo	no
AppleVoiceOverLanguageMy	my
AppleVoiceOverLanguagePl	pl
AppleVoiceOverLanguagePt	pt
AppleVoiceOverLanguagePtPt	pt-PT
AppleVoiceOverLanguageRo	ro
AppleVoiceOverLanguageRu	ru
AppleVoiceOverLanguageSk	sk
AppleVoiceOverLanguageSv	sv
AppleVoiceOverLanguageTh	th
AppleVoiceOverLanguageTr	tr
AppleVoiceOverLanguageUk	uk
AppleVoiceOverLanguageVi	vi
AppleVoiceOverLanguageZhHans	zh-Hans
AppleVoiceOverLanguageZhHant	zh-Hant

Definition at line 78 of file AppleVoiceOver.h.

Variable Documentation

gAppleVOAudioProtocolGuid

EFI_GUID gAppleVOAudioProtocolGuid

extern