NNS_SndPlayerReadDriverPlayerInfo

Syntax

#include <nnsys/snd.h>
BOOL NNS_SndPlayerReadDriverPlayerInfo(
        NNSSndHandle* handle,
        struct SNDPlayerInfo* info );

Arguments

handle The sound handle pointer.
info The pointer to the player information structure to store the obtained information.

Return Values

Returns whether the attempt to obtain the information succeeded or failed.

Description

Gets the sound driver's player information.

This function gets the player information for the sequence linked to the sound handle handle. The process fails when the sound handle is invalid.

Information at the time the sound driver information was last updated successfully with NNS_SndUpdateDriverInfo can be obtained. This function fails if the sound driver has never been successfully updated.

If obtained successfully, the player information is written to info, the SNDPlayerInfo-type structure for the player information.

See Also

NNS_SndUpdateDriverInfo, SNDPlayerInfo

Revision History

2005/02/17 Initial version.


CONFIDENTIAL