Miles Sound System SDK 7.2a

AIL_set_stream_user_data

The function AIL_set_stream_user_data sets a value for one of eight user data entries associated with each stream handle.

void AIL_set_stream_user_data(
  HSTREAM stream,
  U32 index,
  SINTa value
);

In Parameters

stream: indicates the stream for which a user data entry value is to be set.
index: is a number from 0 to 7, indicating which user data entry is to be set.
value: is the user data value to set.

Discussion

Stream user data entries are provided to assist application programs in keeping track of its allocated stream handles. They are especially useful for communicating with the callback function to which only stream handles are passed, without resorting to the use of global variables.

The MSS system never alters or initializes user data values under any circumstances.

Group: Digital Audio Streaming Services
Related Functions: AIL_stream_user_data
Related Basic Types: HSTREAM, SINTa, U32, void