Miles Sound System SDK 7.2a

MSS_PLATFORM_PROPERTY

The basic type MSS_PLATFORM_PROPERTY is a list of available platform-specific property identifiers for use with the AIL_platform_property function.

Fundamental Values

Value	Description
WIN32_TIMER_THREAD	Windows Read-only property returning the HANDLE to the thread used by Miles for all of its background mixing, callback, and user timer function processing. The object parameter is ignored. May be queried only after the first MSS timer function has been registered (typically by opening a digital or XMIDI driver).
WIN32_STREAM_THREAD	Windows Read-only property returning the HANDLE to the thread used by Miles do perform background disk IO for the streaming API. The object parameter is ignored. May be queried after the first stream is opened.
WIN32_HWAVEOUT	Windows Read-only property returning the HWAVEOUT handle to the waveOut audio driver in use, or NULL if DirectSound is in use. The object parameter should be an HDIGDRIVER handle to a digital driver open in waveOut mode.
WIN32_HWAVEIN	Windows Read-only property returning the HWAVEIN handle to the waveIn audio driver opened by the AIL_open_input function. The object parameter should be a valid HDIGINPUT handle returned by AIL_open_input.
WIN32_LPDS	Windows Read-only property corresponding to the IDirectSound object used by an HDIGDRIVER. The object parameter should be an HDIGDRIVER handle to a digital driver open in DirectSound mode.
WIN32_LPDSB	Windows Read-only property corresponding to the IDirectSoundBuffer object used by an HDIGDRIVER as its mixer target buffer. The object parameter should be an HDIGDRIVER handle to a digital driver open in DirectSound mode. Because a DirectSoundBuffer object may not be assigned until a sample or stream is actually played, you must play at least one sample or stream before querying this property.
WIN32_HWND	Windows Readable/writable property corresponding to the HWND that MSS will pass to DirectSound when establishing focus control in future calls to AIL_open_digital_driver. The object parameter is ignored and should be NULL. (Altering the WIN32_HWND property is necessary only if MSS guesses incorrectly when it tries to locate your application's main window).
XB_TIMER_THREAD	Xbox 1 Read-only property returning the HANDLE to the thread used by Miles to perform all background audio, user-timer, and callback processing. This thread is also used to service the XBox hardware mixer. The object parameter is ignored. May be queried only after the first MSS timer function has been registered (typically by opening a digital or XMIDI driver).
XB_STREAM_THREAD	Xbox 1 Read-only property returning the HANDLE to the thread used by Miles do perform background disk IO for the streaming API. The object parameter is ignored. May be queried after the first stream is opened.
XB_LPDS	Xbox 1 Read-only property corresponding to the IDirectSound object used by an HDIGDRIVER. The object parameter should be an HDIGDRIVER handle to a digital driver open in DirectSound mode.
XB_LPDSB	Xbox 1 Read-only property corresponding to the IDirectSoundBuffer object used by an HSAMPLE as its output target buffer. The object parameter should be the HSAMPLE to query. On the Xbox 1, DirectSoundBuffer objects are allocated by AIL_open_digital_driver, so it is not necessary to play any sounds before querying this property.
XB360_TIMER_THREAD	Xbox 360 Read-only property returning the HANDLE to the thread used by Miles for all of its background mixing, callback, and user timer function processing. The object parameter is ignored. May be queried only after the first MSS timer function has been registered (typically by opening a digital or XMIDI driver).
XB360_STREAM_THREAD	Xbox 360 Read-only property returning the HANDLE to the thread used by Miles do perform background disk IO for the streaming API. The object parameter is ignored. May be queried after the first stream is opened.
XB360_LPXAB	Xbox 360 Read-only property corresponding to the IXAudioSourceVoice object used by an HDIGDRIVER as its mixer target buffer. The object parameter should be an HDIGDRIVER handle to a digital driver. Because an IXAudioSourceVoice object may not be assigned to the driver until a sample or stream is actually played, you must play at least one sample or stream before querying this property.
PS3_TIMER_THREAD	PS3 Read-only property returning the HANDLE to the thread used by Miles for all of its background mixing, callback, and user timer function processing. The object parameter is ignored. May be queried only after the first MSS timer function has been registered (typically by opening a digital or XMIDI driver).
PS3_STREAM_THREAD	PS3 Read-only property returning the HANDLE to the thread used by Miles do perform background disk IO for the streaming API. The object parameter is ignored. May be queried after the first stream is opened.
PS3_AUDIO_PORT	PS3 Read-only property corresponding to the cellAudio port used by an HDIGDRIVER as its mixer target buffer. The object parameter should be an HDIGDRIVER handle to a digital driver.
PS3_AUDIO_ADDRESS	PS3 Read-only property corresponding to the memory address of the cellAudio sound buffer used by an HDIGDRIVER as its mixer target buffer. The object parameter should be an HDIGDRIVER handle to a digital driver.
PS3_AUDIO_LENGTH	PS3 Read-only property corresponding to the length of the cellAudio sound buffer used by an HDIGDRIVER as its mixer target buffer. The object parameter should be an HDIGDRIVER handle to a digital driver.
PS3_AUDIO_POSITION	PS3 Read-only property corresponding to the current position offset within the cellAudio sound buffer used by an HDIGDRIVER as its mixer target buffer. The object parameter should be an HDIGDRIVER handle to a digital driver.

Discussion

Before calling AIL_platform_property for any of these values, be sure you understand what object parameter (if any) is required to access the property, when the property value may be queried or modified, and how long it will remain valid. Most applications should not attempt to use MSS_PLATFORM_PROPERTY values or the AIL_platform_property function.

Group: System Services
Related Functions: AIL_open_digital_driver, AIL_open_input, AIL_platform_property