`nw::snd::StreamSoundHandle::ReadStreamDataInfo` Member Function

Syntax

#include <nw/snd/snd_StreamSoundHandle.h>
bool ReadStreamDataInfo(
     StreamDataInfo * pInfo
) const;

Arguments

	Name	Description
out	pInfo	Stream data information structure used to store results

Return Values

Returns TRUE if the stream data information is retrieved successfully; otherwise, returns FALSE.

Description

Obtains stream data information.

Gets information about the stream data being played for the sound associated with handle. Returns false if the handle is invalid.

Returns FALSE if the stream data information cannot be retrieved because preparation for the stream is not complete. IsPrepared can be used to get whether the preparation is complete.

Revision History

2010/01/22: Initial version.

CONFIDENTIAL