123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507 |
- {
- File: OSServices/SystemSoundPriv.h
-
- Contains: *** DEPRECATED *** SystemSound include file
-
- Copyright: (c) 2000-2011 Apple Inc. All rights reserved.
-
- Bugs?: For bug reports, consult the following page on
- the World Wide Web:
-
- http://bugs.freepascal.org
-
- }
- { Pascal Translation: Peter N Lewis, <[email protected]>, 2005 }
- { Pascal Translation Updated: Jonas Maebe, <[email protected]>, October 2009 }
- { Pascal Translation Updated: Jonas Maebe <[email protected]>, September 2012 }
- {
- Modified for use with Free Pascal
- Version 308
- Please report any bugs to <[email protected]>
- }
- {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE}
- {$mode macpas}
- {$packenum 1}
- {$macro on}
- {$inline on}
- {$calling mwpascal}
- unit SystemSound;
- interface
- {$setc UNIVERSAL_INTERFACES_VERSION := $0400}
- {$setc GAP_INTERFACES_VERSION := $0308}
- {$ifc not defined USE_CFSTR_CONSTANT_MACROS}
- {$setc USE_CFSTR_CONSTANT_MACROS := TRUE}
- {$endc}
- {$ifc defined CPUPOWERPC and defined CPUI386}
- {$error Conflicting initial definitions for CPUPOWERPC and CPUI386}
- {$endc}
- {$ifc defined FPC_BIG_ENDIAN and defined FPC_LITTLE_ENDIAN}
- {$error Conflicting initial definitions for FPC_BIG_ENDIAN and FPC_LITTLE_ENDIAN}
- {$endc}
- {$ifc not defined __ppc__ and defined CPUPOWERPC32}
- {$setc __ppc__ := 1}
- {$elsec}
- {$setc __ppc__ := 0}
- {$endc}
- {$ifc not defined __ppc64__ and defined CPUPOWERPC64}
- {$setc __ppc64__ := 1}
- {$elsec}
- {$setc __ppc64__ := 0}
- {$endc}
- {$ifc not defined __i386__ and defined CPUI386}
- {$setc __i386__ := 1}
- {$elsec}
- {$setc __i386__ := 0}
- {$endc}
- {$ifc not defined __x86_64__ and defined CPUX86_64}
- {$setc __x86_64__ := 1}
- {$elsec}
- {$setc __x86_64__ := 0}
- {$endc}
- {$ifc not defined __arm__ and defined CPUARM}
- {$setc __arm__ := 1}
- {$elsec}
- {$setc __arm__ := 0}
- {$endc}
- {$ifc not defined __arm64__ and defined CPUAARCH64}
- {$setc __arm64__ := 1}
- {$elsec}
- {$setc __arm64__ := 0}
- {$endc}
- {$ifc defined cpu64}
- {$setc __LP64__ := 1}
- {$elsec}
- {$setc __LP64__ := 0}
- {$endc}
- {$ifc defined __ppc__ and __ppc__ and defined __i386__ and __i386__}
- {$error Conflicting definitions for __ppc__ and __i386__}
- {$endc}
- {$ifc defined __ppc__ and __ppc__}
- {$setc TARGET_CPU_PPC := TRUE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_IPHONE := FALSE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$setc TARGET_OS_EMBEDDED := FALSE}
- {$elifc defined __ppc64__ and __ppc64__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := TRUE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_IPHONE := FALSE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$setc TARGET_OS_EMBEDDED := FALSE}
- {$elifc defined __i386__ and __i386__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := TRUE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- {$ifc defined(iphonesim)}
- {$setc TARGET_OS_MAC := FALSE}
- {$setc TARGET_OS_IPHONE := TRUE}
- {$setc TARGET_IPHONE_SIMULATOR := TRUE}
- {$elsec}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_IPHONE := FALSE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$endc}
- {$setc TARGET_OS_EMBEDDED := FALSE}
- {$elifc defined __x86_64__ and __x86_64__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := TRUE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- {$ifc defined(iphonesim)}
- {$setc TARGET_OS_MAC := FALSE}
- {$setc TARGET_OS_IPHONE := TRUE}
- {$setc TARGET_IPHONE_SIMULATOR := TRUE}
- {$elsec}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_IPHONE := FALSE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$endc}
- {$setc TARGET_OS_EMBEDDED := FALSE}
- {$elifc defined __arm__ and __arm__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := TRUE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- { will require compiler define when/if other Apple devices with ARM cpus ship }
- {$setc TARGET_OS_MAC := FALSE}
- {$setc TARGET_OS_IPHONE := TRUE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$setc TARGET_OS_EMBEDDED := TRUE}
- {$elifc defined __arm64__ and __arm64__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := TRUE}
- { will require compiler define when/if other Apple devices with ARM cpus ship }
- {$setc TARGET_OS_MAC := FALSE}
- {$setc TARGET_OS_IPHONE := TRUE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$setc TARGET_OS_EMBEDDED := TRUE}
- {$elsec}
- {$error __ppc__ nor __ppc64__ nor __i386__ nor __x86_64__ nor __arm__ nor __arm64__ is defined.}
- {$endc}
- {$ifc defined __LP64__ and __LP64__ }
- {$setc TARGET_CPU_64 := TRUE}
- {$elsec}
- {$setc TARGET_CPU_64 := FALSE}
- {$endc}
- {$ifc defined FPC_BIG_ENDIAN}
- {$setc TARGET_RT_BIG_ENDIAN := TRUE}
- {$setc TARGET_RT_LITTLE_ENDIAN := FALSE}
- {$elifc defined FPC_LITTLE_ENDIAN}
- {$setc TARGET_RT_BIG_ENDIAN := FALSE}
- {$setc TARGET_RT_LITTLE_ENDIAN := TRUE}
- {$elsec}
- {$error Neither FPC_BIG_ENDIAN nor FPC_LITTLE_ENDIAN are defined.}
- {$endc}
- {$setc ACCESSOR_CALLS_ARE_FUNCTIONS := TRUE}
- {$setc CALL_NOT_IN_CARBON := FALSE}
- {$setc OLDROUTINENAMES := FALSE}
- {$setc OPAQUE_TOOLBOX_STRUCTS := TRUE}
- {$setc OPAQUE_UPP_TYPES := TRUE}
- {$setc OTCARBONAPPLICATION := TRUE}
- {$setc OTKERNEL := FALSE}
- {$setc PM_USE_SESSION_APIS := TRUE}
- {$setc TARGET_API_MAC_CARBON := TRUE}
- {$setc TARGET_API_MAC_OS8 := FALSE}
- {$setc TARGET_API_MAC_OSX := TRUE}
- {$setc TARGET_CARBON := TRUE}
- {$setc TARGET_CPU_68K := FALSE}
- {$setc TARGET_CPU_MIPS := FALSE}
- {$setc TARGET_CPU_SPARC := FALSE}
- {$setc TARGET_OS_UNIX := FALSE}
- {$setc TARGET_OS_WIN32 := FALSE}
- {$setc TARGET_RT_MAC_68881 := FALSE}
- {$setc TARGET_RT_MAC_CFM := FALSE}
- {$setc TARGET_RT_MAC_MACHO := TRUE}
- {$setc TYPED_FUNCTION_POINTERS := TRUE}
- {$setc TYPE_BOOL := FALSE}
- {$setc TYPE_EXTENDED := FALSE}
- {$setc TYPE_LONGLONG := TRUE}
- uses MacTypes,Files,CFBase,CFRunLoop;
- {$endc} {not MACOSALLINCLUDE}
- {$ifc TARGET_OS_MAC}
- {$ALIGN POWER}
- { ================================================================================ }
- { Errors }
- { ================================================================================ }
- const
- kSystemSoundNoError = 0;
- kSystemSoundUnspecifiedError = -1500;
- kSystemSoundClientTimedOutError = -1501;
- { ================================================================================ }
- { Types }
- { ================================================================================ }
- type
- SystemSoundActionID = UInt32;
- SystemSoundCompletionProcPtr = function( actionID: SystemSoundActionID; userData: UnivPtr ): OSStatus;
- type
- SystemSoundCompletionUPP = SystemSoundCompletionProcPtr;
- {
- * NewSystemSoundCompletionUPP() *** DEPRECATED ***
- *
- * Availability:
- * Mac OS X: in version 10.3 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.3 and later
- * Non-Carbon CFM: available as macro/inline
- }
- function NewSystemSoundCompletionUPP( userRoutine: SystemSoundCompletionProcPtr ): SystemSoundCompletionUPP; external name '_NewSystemSoundCompletionUPP';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_3,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {
- * DisposeSystemSoundCompletionUPP() *** DEPRECATED ***
- *
- * Availability:
- * Mac OS X: in version 10.3 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.3 and later
- * Non-Carbon CFM: available as macro/inline
- }
- procedure DisposeSystemSoundCompletionUPP( userUPP: SystemSoundCompletionUPP ); external name '_DisposeSystemSoundCompletionUPP';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_3,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {
- * InvokeSystemSoundCompletionUPP() *** DEPRECATED ***
- *
- * Availability:
- * Mac OS X: in version 10.3 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.3 and later
- * Non-Carbon CFM: available as macro/inline
- }
- function InvokeSystemSoundCompletionUPP( actionID: SystemSoundActionID; userData: UnivPtr; userUPP: SystemSoundCompletionUPP ): OSStatus; external name '_InvokeSystemSoundCompletionUPP';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_3,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- { ================================================================================ }
- { Public APIs }
- { ================================================================================ }
- {
- * AlertSoundPlay() *** DEPRECATED ***
- *
- * Deprecated:
- * Use AudioServicesPlayAlertSound(). Found in
- * <AudioToolbox/AudioServices.h>
- *
- * Summary:
- * Play an Alert Sound
- *
- * Discussion:
- * Play the user's current alert sound, interrupting any previously
- * playing alert sound.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in CoreServices.framework but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x
- * Non-Carbon CFM: not available
- }
- procedure AlertSoundPlay; external name '_AlertSoundPlay';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {
- * AlertSoundPlayCustomSound() *** DEPRECATED ***
- *
- * Deprecated:
- * Use AudioServicesPlayAlertSound(). Found in
- * <AudioToolbox/AudioServices.h>
- *
- * Summary:
- * Play a User designated Alert Sound
- *
- * Discussion:
- * Play a sound, designated by a SystemSoundActionID, with the
- * behavior of AlertSoundPlay().
- *
- * Parameters:
- *
- * inAction:
- * A SystemSoundActionID indicating the desired Sound to be played
- * with AlertSound behavior.
- *
- * Availability:
- * Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x
- * Non-Carbon CFM: not available
- }
- procedure AlertSoundPlayCustomSound( inAction: SystemSoundActionID ); external name '_AlertSoundPlayCustomSound';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_3,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {
- * SystemSoundPlay() *** DEPRECATED ***
- *
- * Deprecated:
- * Use AudioServicesPlaySystemSound(). Found in
- * <AudioToolbox/AudioServices.h>
- *
- * Summary:
- * Play a System Sound
- *
- * Discussion:
- * Immediately play the sound designated by actionID. Use for one
- * time actions that do not require a duration or modification
- * during playback. Sustain loops in the sound will be ignored.
- *
- * Parameters:
- *
- * inAction:
- * A SystemSoundActionID indicating the desired System Sound to be
- * played.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in CoreServices.framework but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x
- * Non-Carbon CFM: not available
- }
- procedure SystemSoundPlay( inAction: SystemSoundActionID ); external name '_SystemSoundPlay';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {
- * SystemSoundGetActionID() *** DEPRECATED ***
- *
- * Deprecated:
- * Use AudioServicesCreateSystemSoundID(). Found in
- * <AudioToolbox/AudioServices.h>
- *
- * Summary:
- * Create a 'custom' System Sound by providing an audio file.
- *
- * Discussion:
- * If the user wants to add a sound that can be played via
- * SystemSoundPlay(), an FSRef for an audio file can be passed and a
- * SystemSoundActionID, which can be passed to SystemSoundPlay() or
- * AlertSoundPlayCustomSound(), will be returned. It is important
- * that SystemSoundRemoveActionID() be called when the action is no
- * longer needed by the client application so the System Sound
- * Server can release any resources dedicated to the returned action
- * id.
- *
- * Parameters:
- *
- * userFile:
- * An const FSRef * for the audio file to be used as a System
- * Sound. Any audio file supported by the AudioFile APIs in the
- * AudioToolbox framework may be used.
- *
- * outAction:
- * If successful, a SystemSoundActionID will be returned, which in
- * turn can be passed to SystemSoundPlay().
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in CoreServices.framework but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x
- * Non-Carbon CFM: not available
- }
- function SystemSoundGetActionID( const (*var*) userFile: FSRef; var outAction: SystemSoundActionID ): OSStatus; external name '_SystemSoundGetActionID';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {
- * SystemSoundRemoveActionID() *** DEPRECATED ***
- *
- * Deprecated:
- * Use AudioServicesDisposeSystemSoundID(). Found in
- * <AudioToolbox/AudioServices.h>
- *
- * Summary:
- * Remove a 'custom' System Sound.
- *
- * Discussion:
- * If the user no longer needs to use the custom system sound that
- * was created via SystemSoundGetActionID, this function should be
- * called so the SystemSoundServer can release resources that are no
- * longer needed.
- *
- * Parameters:
- *
- * inAction:
- * A SystemSoundActionID indicating the desired System Sound to be
- * removed.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in CoreServices.framework but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x
- * Non-Carbon CFM: not available
- }
- function SystemSoundRemoveActionID( inAction: SystemSoundActionID ): OSStatus; external name '_SystemSoundRemoveActionID';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {
- * SystemSoundSetCompletionRoutine() *** DEPRECATED ***
- *
- * Deprecated:
- * Use AudioServicesAddSystemSoundCompletion(). Found in
- * <AudioToolbox/AudioServices.h>
- *
- * Summary:
- * Call the provided Completion Routine when the provided
- * SystemSoundActionID finishes playing in the server.
- *
- * Discussion:
- * Once set, the System Sound Server will send a message to the
- * System Sound Client indicating which SystemSoundActionID has
- * finished playing.
- *
- * Parameters:
- *
- * inAction:
- * The SystemSoundActionID that the completion routine will be
- * associated with.
- *
- * inRunLoop:
- * A CFRunLoopRef indicating the desired run loop the completion
- * routine should be run on. Pass NULL for the main run loop.
- *
- * inRunLoopMode:
- * A CFStringRef indicating the run loop mode for the runloop mode
- * for the runloop where the completion routine will be executed.
- * Pass NULL to use kCFRunLoopDefaultMode.
- *
- * inCompletionRoutine:
- * A SystemSoundCompletionProc for the completion routine proc to
- * be called when the provided SystemSoundActionID has completed
- * playing in the server.
- *
- * inUserData:
- * A void * to pass user data to the completion routine.
- *
- * Availability:
- * Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x
- * Non-Carbon CFM: not available
- }
- function SystemSoundSetCompletionRoutine( inAction: SystemSoundActionID; inRunLoop: CFRunLoopRef; inRunLoopMode: CFStringRef; inCompletionRoutine: SystemSoundCompletionUPP; inUserData: UnivPtr ): OSStatus; external name '_SystemSoundSetCompletionRoutine';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_3,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {
- * SystemSoundRemoveCompletionRoutine() *** DEPRECATED ***
- *
- * Deprecated:
- * Use AudioServicesRemoveSystemSoundCompletion(). Found in
- * <AudioToolbox/AudioServices.h>
- *
- * Summary:
- * Remove the Completion Routine being used for the provided
- * SystemSoundActionID.
- *
- * Discussion:
- * To be called when it is no longer desired for the Completion
- * Routine to be called when a System Sound action has finished
- * playing.
- *
- * Parameters:
- *
- * inAction:
- * A SystemSoundActionID that currently has an associated
- * completion routine.
- *
- * Availability:
- * Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.5
- * CarbonLib: not available in CarbonLib 1.x
- * Non-Carbon CFM: not available
- }
- procedure SystemSoundRemoveCompletionRoutine( inAction: SystemSoundActionID ); external name '_SystemSoundRemoveCompletionRoutine';
- (* __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_3,__MAC_10_5,__IPHONE_NA,__IPHONE_NA) *)
- {$endc} {TARGET_OS_MAC}
- {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE}
- end.
- {$endc} {not MACOSALLINCLUDE}
|