Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
Repository URL to install this package:
|
Version:
3.2.0 ▾
|
{!
@file AudioServices.h
@framework AudioToolbox.framework
@copyright (c) 2006-2015 by Apple, Inc., all rights reserved.
@abstract API's for general high level audio services.
@discussion
AudioServices provides a means to play audio for things such as UI sound effects.
}
{ Pascal Translation: Jonas Maebe <jonas@freepascal.org>, July 2019 }
{
Modified for use with Free Pascal
Version 308
Please report any bugs to <gpc@microbizz.nl>
}
{$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE}
{$mode macpas}
{$modeswitch cblocks}
{$packenum 1}
{$macro on}
{$inline on}
{$calling mwpascal}
unit AudioServices;
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,CFBase,CFRunLoop,AudioHardware,AudioHardwareService,CoreFoundation;
{$endc} {not MACOSALLINCLUDE}
{$ALIGN POWER}
//==================================================================================================
//#pragma mark Includes
//==================================================================================================
//CF_ASSUME_NONNULL_BEGIN
//==================================================================================================
//#pragma mark AudioServices Error Constants
{!
@enum AudioServices error codes
@abstract Error codes returned from the AudioServices portion of the API.
@constant kAudioServicesNoError
No error has occurred
@constant kAudioServicesUnsupportedPropertyError
The property is not supported.
@constant kAudioServicesBadPropertySizeError
The size of the property data was not correct.
@constant kAudioServicesBadSpecifierSizeError
The size of the specifier data was not correct.
@constant kAudioServicesSystemSoundUnspecifiedError
A SystemSound unspecified error has occurred.
@constant kAudioServicesSystemSoundClientTimedOutError
The SystemSound client message timed out
@constant kAudioServicesSystemSoundExceededMaximumDurationError
The SystemSound's duration exceeded the allowable threshold
}
const
kAudioServicesNoError = 0;
kAudioServicesUnsupportedPropertyError = FourCharCode('pty?');
kAudioServicesBadPropertySizeError = FourCharCode('!siz');
kAudioServicesBadSpecifierSizeError = FourCharCode('!spc');
kAudioServicesSystemSoundUnspecifiedError = -1500;
kAudioServicesSystemSoundClientTimedOutError = -1501;
kAudioServicesSystemSoundExceededMaximumDurationError = -1502;
//==================================================================================================
//#pragma mark AudioServices Types
{!
@typedef SystemSoundID
@abstract SystemSoundIDs are created by the System Sound client application
for playback of a provided AudioFile.
}
type
SystemSoundID = UInt32;
SystemSoundIDPtr = ^SystemSoundID;
{!
@typedef AudioServicesPropertyID
@abstract Type used for specifying an AudioServices property.
}
type
AudioServicesPropertyID = UInt32;
AudioServicesPropertyIDPtr = ^AudioServicesPropertyID;
{!
@typedef AudioServicesSystemSoundCompletionProc
@abstract A function to be executed when a SystemSoundID finishes playing.
@discussion AudioServicesSystemSoundCompletionProc may be provided by client application to be
called when a SystemSoundID has completed playback.
@param ssID
The SystemSoundID that completed playback
@param userData
Client application user data
}
type
AudioServicesSystemSoundCompletionProc = procedure( ssID: SystemSoundID; clientData: UnivPtr {__nullable} );
//==================================================================================================
//#pragma mark AudioServices Constants
{!
@enum AudioServices constants
@abstract Constants for use with System Sound portion of the AudioServices APIs.
@constant kSystemSoundID_UserPreferredAlert
Use this constant with the play sound APIs to
playback the alert sound selected by the User in System Preferences.
@constant kSystemSoundID_FlashScreen
Use this constant with the play sound APIs to flash the screen
- Desktop systems only
}
const
kSystemSoundID_UserPreferredAlert = $00001000;
kSystemSoundID_FlashScreen = $00000FFE;
// this has been renamed to be consistent
kUserPreferredAlert = kSystemSoundID_UserPreferredAlert;
//==================================================================================================
//#pragma mark AudioServices Properties
{!
@enum AudioServices property codes
@abstract These are the property codes used with the AudioServices API.
@constant kAudioServicesPropertyIsUISound
a UInt32 where 1 means that the SystemSoundID passed in the
inSpecifier parameter will respect the 'Play user interface sounds effects'
check box in System Preferences and be silent when the user turns off UI
sounds. This property is set to 1 by default. Set to 0 if it is desired for
an SystemSoundID to always be heard when passed to AudioServicesPlaySystemSound(),
regardless of user's setting in the Sound Preferences.
@constant kAudioServicesPropertyCompletePlaybackIfAppDies
a UInt32 where 1 means that the SystemSoundID passed in the
inSpecifier parameter will finish playing even if the client application goes away.
}
const
kAudioServicesPropertyIsUISound = FourCharCode('isui');
kAudioServicesPropertyCompletePlaybackIfAppDies = FourCharCode('ifdi');
//==================================================================================================
//#pragma mark AudioServices Functions
{!
@functiongroup AudioServices
}
{!
@function AudioServicesCreateSystemSoundID
@abstract Allows the application to designate an audio file for playback by the System Sound server.
@discussion Returned SystemSoundIDs are passed to AudioServicesPlayAlertSoundWithCompletion()
and AudioServicesPlaySystemSoundWithCompletion() to be played.
The maximum supported duration for a system sound is 30 secs.
@param inFileURL
A CFURLRef for an AudioFile.
@param outSystemSoundID
Returns a SystemSoundID.
}
function AudioServicesCreateSystemSoundID( inFileURL: CFURLRef; var outSystemSoundID: SystemSoundID ): OSStatus; external name '_AudioServicesCreateSystemSoundID';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
{!
@function AudioServicesDisposeSystemSoundID
@abstract Allows the System Sound server to dispose any resources needed for the provided
SystemSoundID.
@discussion Allows the application to tell the System Sound server that the resources for the
associated audio file are no longer required.
@param inSystemSoundID
A SystemSoundID that the application no longer needs to use.
}
function AudioServicesDisposeSystemSoundID( inSystemSoundID: SystemSoundID ): OSStatus; external name '_AudioServicesDisposeSystemSoundID';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
{!
@function AudioServicesPlayAlertSoundWithCompletion
@abstract Play an alert sound
@discussion Play the sound designated by the provided SystemSoundID with alert sound behavior.
@param inSystemSoundID
The SystemSoundID to be played. On the desktop the kSystemSoundID_UserPreferredAlert
constant can be passed in to play back the alert sound selected by the user
in System Preferences. On iOS there is no preferred user alert sound.
@param inCompletionBlock
The completion block gets executed for every attempt to play a system sound irrespective
of success or failure. The callbacks are issued on a serial queue and the client is
responsible for handling thread safety.
}
type
TCompletionBlock = reference to procedure; cblock;
procedure AudioServicesPlayAlertSoundWithCompletion(inSystemSoundID: SystemSoundID; inCompletionBlock: TCompletionBlock); external name '_AudioServicesPlayAlertSoundWithCompletion';
(* API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0)) *)
{!
@function AudioServicesPlaySystemSoundWithCompletion
@abstract Play a system sound
@discussion Play the sound designated by the provided SystemSoundID.
@param inSystemSoundID
The SystemSoundID to be played.
@param inCompletionBlock
The completion block gets executed for every attempt to play a system sound irrespective
of success or failure. The callbacks are issued on a serial queue and the client is
responsible for handling thread safety.
}
procedure AudioServicesPlaySystemSoundWithCompletion(inSystemSoundID: SystemSoundID; inCompletionBlock: TCompletionBlock); external name '_AudioServicesPlaySystemSoundWithCompletion';
(* API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0)) *)
{!
@function AudioServicesGetPropertyInfo
@abstract Get information about the size of an AudioServices property and whether it can
be set.
@param inPropertyID
a AudioServicesPropertyID constant.
@param inSpecifierSize
The size of the specifier data.
@param inSpecifier
A specifier is a buffer of data used as an input argument to some of the
properties.
@param outPropertyDataSize
The size in bytes of the current value of the property. In order to get the
property value, you will need a buffer of this size.
@param outWritable
Will be set to 1 if writable, or 0 if read only.
@result returns kAudioServicesNoError if successful.
}
function AudioServicesGetPropertyInfo( inPropertyID: AudioServicesPropertyID; inSpecifierSize: UInt32; {const} inSpecifier: UnivPtr {__nullable}; outPropertyDataSize: UInt32Ptr {* __nullable}; outWritable: BooleanPtr {* __nullable} ): OSStatus; external name '_AudioServicesGetPropertyInfo';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
{!
@function AudioServicesGetProperty
@abstract Retrieve the indicated property data
@param inPropertyID
a AudioServicesPropertyID constant.
@param inSpecifierSize
The size of the specifier data.
@param inSpecifier
A specifier is a buffer of data used as an input argument to some of the
properties.
@param ioPropertyDataSize
On input, the size of the outPropertyData buffer. On output the number of
bytes written to the buffer.
@param outPropertyData
The buffer in which to write the property data. May be NULL if caller only
wants ioPropertyDataSize to be filled with the amount that would have been
written.
@result returns kAudioServicesNoError if successful.
}
function AudioServicesGetProperty( inPropertyID: AudioServicesPropertyID; inSpecifierSize: UInt32; {const} inSpecifier: UnivPtr {__nullable}; var ioPropertyDataSize: UInt32; outPropertyData: UnivPtr {__nullable} ): OSStatus; external name '_AudioServicesGetProperty';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
{!
@function AudioServicesSetProperty
@abstract Set the indicated property data
@param inPropertyID
a AudioServicesPropertyID constant.
@param inSpecifierSize
The size of the specifier data.
@param inSpecifier
A specifier is a buffer of data used as an input argument to some of the
properties.
@param inPropertyDataSize
The size of the inPropertyData buffer.
@param inPropertyData
The buffer containing the property data.
@result returns kAudioServicesNoError if successful.
}
function AudioServicesSetProperty( inPropertyID: AudioServicesPropertyID; inSpecifierSize: UInt32; {const} inSpecifier: UnivPtr {__nullable}; inPropertyDataSize: UInt32; inPropertyData: {const} UnivPtr ): OSStatus; external name '_AudioServicesSetProperty';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
{!
This function will be deprecated in a future release. Use AudioServicesPlayAlertSoundWithCompletion instead.
@function AudioServicesPlayAlertSound
@abstract Play an Alert Sound
@discussion Play the provided SystemSoundID with AlertSound behavior.
@param inSystemSoundID
A SystemSoundID for the System Sound server to play. On the desktop you
can pass the kSystemSoundID_UserPreferredAlert constant to playback the alert sound
selected by the user in System Preferences. On iOS there is no preferred user alert sound.
}
procedure AudioServicesPlayAlertSound( inSystemSoundID: SystemSoundID ); external name '_AudioServicesPlayAlertSound';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
{!
This function will be deprecated in a future release. Use AudioServicesPlaySystemSoundWithCompletion instead.
@function AudioServicesPlaySystemSound
@abstract Play the sound designated by the provided SystemSoundID.
@discussion A SystemSoundID indicating the desired System Sound to be played.
@param inSystemSoundID
A SystemSoundID for the System Sound server to play.
}
procedure AudioServicesPlaySystemSound( inSystemSoundID: SystemSoundID ); external name '_AudioServicesPlaySystemSound';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
{!
This function will be deprecated in a future release. Use AudioServicesPlayAlertSoundWithCompletion
or AudioServicesPlaySystemSoundWithCompletion instead.
@function AudioServicesAddSystemSoundCompletion
@abstract Call the provided Completion Routine when provided SystemSoundID
finishes playing.
@discussion Once set, the System Sound server will send a message to the System Sound client
indicating which SystemSoundID has finished playing.
@param inSystemSoundID
The SystemSoundID to associate with the provided completion
routine.
@param inRunLoop
A CFRunLoopRef indicating the desired run loop the completion routine should
be run on. Pass NULL to use the main run loop.
@param inRunLoopMode
A CFStringRef indicating the run loop mode for the runloop where the
completion routine will be executed. Pass NULL to use kCFRunLoopDefaultMode.
@param inCompletionRoutine
An AudioServicesSystemSoundCompletionProc to be called when the provided
SystemSoundID has completed playing in the server.
@param inClientData
A void* to pass client data to the completion routine.
}
function AudioServicesAddSystemSoundCompletion( inSystemSoundID: SystemSoundID; inRunLoop: CFRunLoopRef {__nullable}; inRunLoopMode: CFStringRef {__nullable}; inCompletionRoutine: AudioServicesSystemSoundCompletionProc; inClientData: UnivPtr {__nullable} ): OSStatus; external name '_AudioServicesAddSystemSoundCompletion';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
{!
This function will be deprecated in a future release. Use AudioServicesPlayAlertSoundWithCompletion
or AudioServicesPlaySystemSoundWithCompletion instead.
@function AudioServicesRemoveSystemSoundCompletion
@abstract Disassociate any completion proc for the specified SystemSoundID
@discussion Tells the SystemSound client to remove any completion proc associated with the
provided SystemSoundID
@param inSystemSoundID
The SystemSoundID for which completion routines should be
removed.
}
procedure AudioServicesRemoveSystemSoundCompletion( inSystemSoundID: SystemSoundID ); external name '_AudioServicesRemoveSystemSoundCompletion';
(* API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) *)
//CF_ASSUME_NONNULL_END
{$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE}
end.
{$endc} {not MACOSALLINCLUDE}