> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md). # sound.h [Macros](#define-members) | [Typedefs](#typedef-members) | [Enumerations](#enum-members) | [Functions](#func-members) `#include ` Include dependency graph for sound.h: ![](/files/mNsXvzsZJQQuNc4RVuBz) [Go to the source code of this file.](/adk-5.0-programmers-guide/sound_8h_source.md) | | | | ------- | --------------------------------------------- | | Macros | | | #define | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) | | | | | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Typedefs | | | typedef struct [SND](#a520814ffd85c7975c652a3bb5500430b) | [SND](#a520814ffd85c7975c652a3bb5500430b) | | typedef void(\* | [SNDCallback](#aca23cc022f7f576ca8a03fe66a6817bb)) (void \*data, struct [SND](#a520814ffd85c7975c652a3bb5500430b) \*handle, enum [SNDError](#a2a29b5498b5650f52341ae534f4c7df6) reason) | | | | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerations | | | enum |

SNDError {
SND\_OK =0, SND\_ERR\_FAIL =-1, SND\_ERR\_PARAMETER =-2, SND\_ERR\_NOT\_FOUND =-3,
SND\_ERR\_MEMORY =-4, SND\_ERR\_UNSUPPORTED =-5, SND\_ERR\_READ =-6
}

| | | | | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Functions | | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) struct [SND](#a520814ffd85c7975c652a3bb5500430b) \* | [sndOpenFile](#a2e0076124852060867cc4039c1719646) (const char \*filename) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) void | [sndClose](#aac877336c270fa31b7396dd9e01a0ee5) (struct [SND](#a520814ffd85c7975c652a3bb5500430b) \*handle) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) enum [SNDError](#a2a29b5498b5650f52341ae534f4c7df6) | [sndStart](#a6074c9bf1534c6e8e10ed0e3c72897cf) (struct [SND](#a520814ffd85c7975c652a3bb5500430b) \*handle) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) enum [SNDError](#a2a29b5498b5650f52341ae534f4c7df6) | [sndStop](#a3fbd83f5f49d41b445b1e9dd8bc82c0f) (struct [SND](#a520814ffd85c7975c652a3bb5500430b) \*handle) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) enum [SNDError](#a2a29b5498b5650f52341ae534f4c7df6) | [sndSeek](#a8f0945ea304cff2a5b223186b73087f7) (struct [SND](#a520814ffd85c7975c652a3bb5500430b) \*handle, double pos, int whence) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) double | [sndTell](#a701ee6a24c4fcffacf3ec555c92caf97) (struct [SND](#a520814ffd85c7975c652a3bb5500430b) \*handle) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) double | [sndLength](#ae7e8fbfe734a79cf6648515fb7758f12) (struct [SND](#a520814ffd85c7975c652a3bb5500430b) \*handle) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) void | [sndSetCallback](#a7964d1213f6f330b9cf1a16dd4973826) (struct [SND](#a520814ffd85c7975c652a3bb5500430b) \*handle, [SNDCallback](#aca23cc022f7f576ca8a03fe66a6817bb) cb, void \*data) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) int | [sndSoundSupport](#ae626fac0d0b7af4ce5a11d5d8103046f) () | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) enum [SNDError](#a2a29b5498b5650f52341ae534f4c7df6) | [sndSetMasterVolume](#ab1ab90d8fa2ebcdbb451c03514e0a62d) (int volume\_percent) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) int | [sndGetMasterVolume](#ae5bb68c7fe1cb7040fe62b859485a9a8) (void) | | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) enum [SNDError](#a2a29b5498b5650f52341ae534f4c7df6) | [sndBeep](#a86a10d01a3b4ab379531f0a029455ade) (int frequency, int duration\_ms, int volume) | ### MacroDefinition Documentation ### DllSpec \#define DllSpec ### TypedefDocumentation ### SND typedef struct \[SND]\(#a520814ffd85c7975c652a3bb5500430b) \[SND]\(#a520814ffd85c7975c652a3bb5500430b) SND handle identifying a sound file ### SNDCallback typedef void(\\\* SNDCallback) (void \\\*data, struct \[SND]\(#a520814ffd85c7975c652a3bb5500430b) \\\*handle, enum \[SNDError]\(#a2a29b5498b5650f52341ae534f4c7df6) reason) sound callback function **Parameters** \[in] **data** data pointer \[in] **handle** handle obtained by sndOpenFile() \[in] **reason** reason why the callback was invoked: At end of file, this is SND\_OK, in case of error it is the error code ### EnumerationType Documentation ### SNDError enum \[SNDError]\(#a2a29b5498b5650f52341ae534f4c7df6) error codes | | | | --------------------- | ------------------------------------ | | Enumerator | | | SND\_OK | no error | | SND\_ERR\_FAIL | generic error | | SND\_ERR\_PARAMETER | invalid parameters | | SND\_ERR\_NOT\_FOUND | file not found or cannot be accessed | | SND\_ERR\_MEMORY | out of memory | | SND\_ERR\_UNSUPPORTED | unsupported format | | SND\_ERR\_READ | read error | ### FunctionDocumentation ### sndBeep() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) enum \[SNDError]\(#a2a29b5498b5650f52341ae534f4c7df6) sndBeep play a beep tone **Parameters** \[in] **frequency** frequency in Hz \[in] **duration\_ms** duration in milliseconds \[in] **volume** volume in % (0..100) #### Returns error code {% hint style="info" %} The beep is played synchronously. {% endhint %} ### sndClose() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) void sndClose close the file opened using [sndOpenFile](#a2e0076124852060867cc4039c1719646) **Parameters** \[in] **handle** handle obtained by sndOpenFile() ### sndGetMasterVolume() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) int sndGetMasterVolume read master volume #### Returns volume in percent (range \[0..100]) or error code if less than 0. ### sndLength() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) double sndLength read the estimated length of the file **Parameters** \[in] **handle** handle obtained by sndOpenFile() #### Returns estimated length in seconds or error code if less than 0. {% hint style="info" %} The returned length is an estimate only, that can be obtained by reading the header of the file and may not represent the exact length. Obtaining the exact length may not be possible without scanning the whole file (e.g. for MP3). {% endhint %} ### sndOpenFile() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) struct \[SND]\(#a520814ffd85c7975c652a3bb5500430b)\\\* sndOpenFile open file and return handle. Playback does not start automatically, use [sndStart()](#a6074c9bf1534c6e8e10ed0e3c72897cf) to start playing the file. **Parameters** \[in] **filename** file name of a sound file. #### Returns handle or NULL if the file cannot be found or the file format is not supported or if the sound device cannot be accessed. ### sndSeek() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) enum \[SNDError]\(#a2a29b5498b5650f52341ae534f4c7df6) sndSeek change the current position **Parameters** \[in] **handle** handle obtained by sndOpenFile() \[in] **pos** position in seconds \[in] **whence** one of SEEK\_SET, SEEK\_CUR, SEEK\_END to specify whether the position pos is with respect to the file start, the current position or file end. #### Returns error code ### sndSetCallback() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) void sndSetCallback set callback that gets invoked when playback stops due to end of file or due to error. **Parameters** \[in] **handle** handle obtained by sndOpenFile() \[in] **cb** function pointer, use NULL to delete callback \[in] **data** data pointer that gets passed on to the callback ### sndSetMasterVolume() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) enum \[SNDError]\(#a2a29b5498b5650f52341ae534f4c7df6) sndSetMasterVolume set master volume in percent **Parameters** \[in] **volume\_percent** volume in the range \[0..100] return error code ### sndSoundSupport() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) int sndSoundSupport check whether the device has sound support for playback of MP3 or WAV files #### Returns 1 if sound support is present, else 0 ### sndStart() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) enum \[SNDError]\(#a2a29b5498b5650f52341ae534f4c7df6) sndStart start playback. Playback starts at the current position. **Parameters** \[in] **handle** handle obtained by sndOpenFile() #### Returns error code ### sndStop() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) enum \[SNDError]\(#a2a29b5498b5650f52341ae534f4c7df6) sndStop stop playback. Stopping does not reset the current position, i.e. invoking [sndStart()](#a6074c9bf1534c6e8e10ed0e3c72897cf) after [sndStop()](#a3fbd83f5f49d41b445b1e9dd8bc82c0f) resumes playback at the position when [sndStop()](#a3fbd83f5f49d41b445b1e9dd8bc82c0f) was invoked. **Parameters** \[in] **handle** handle obtained by sndOpenFile() #### Returns error code ### sndTell() \[DllSpec]\(#ad7c2e1cb200073ed64c64285a5f37231) double sndTell read the current position **Parameters** \[in] **handle** handle obtained by sndOpenFile() #### Returns position in seconds from the file start or error code if less than 0. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.