DVMSGID_PLAYEROUTPUTLEVEL Message

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

DVMSGID_PLAYEROUTPUTLEVEL Message


Microsoft® DirectPlay® Voice generates the DVMSGID_PLAYEROUTPUTLEVEL message periodically to notify the user of the output level of an individual player's voice stream.

The DVMSG_PLAYEROUTPUTLEVEL structure contains information for the DVMSGID_PLAYEROUTPUTLEVEL system message.

Syntax

typedef struct {
    DWORD dwSize;
    DVID dvidSourcePlayerID;
    DWORD dwPeakLevel;
    PVOID pvPlayerContext;
}  DVMSG_PLAYEROUTPUTLEVEL *LPDVMSG_PLAYEROUTPUTLEVEL, *PDVMSG_PLAYEROUTPUTLEVEL;

Members

dwSize
Size of the DVMSG_PLAYEROUTPUTLEVEL message structure.
dvidSourcePlayerID
DVID of the player whose voice is being played back.
dwPeakLevel
Integer representing the current output level of the player's voice stream. This value must be in the range from 0 through 99, with 0 being completely silent and 99 being the highest possible output level.
pvPlayerContext
Pointer to the context value set for the player. This value is set through the pvPlayerContext member of the DVMSGID_CREATEVOICEPLAYER message structure.

Remarks

Return from the message callback function with DV_OK.

This message is generated while voice is being played back for an individual player. If multiple player voices are being played, one message for each player speaking will be sent each notification period.

The period of notification is set by the dwNotifyPeriod member of the DVCLIENTCONFIG structure. If the notification period is set to 0, this message will not be sent.

Message Information

Headerdvoice.h
Minimum operating systems Windows 98

© 2003 Microsoft Corporation. All rights reserved.