DVMSGID_INPUTLEVEL Message

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

DVMSGID_INPUTLEVEL Message


Microsoft® DirectPlay® Voice generates the DVMSGID_INPUTLEVEL message periodically to notify the user of the input level from the microphone.

The DVMSG_INPUTLEVEL structure contains information for the DVMSGID_INPUTLEVEL system message.

Syntax

typedef struct {
    DWORD dwSize;
    DWORD dwPeakLevel;
    LONG lRecordVolume;
    PVOID pvLocalPlayerContext;
}  DVMSG_INPUTLEVEL *LPDVMSG_INPUTLEVEL, *PDVMSG_INPUTLEVEL;

Members

dwSize
Size of the DVMSG_INPUTLEVEL message structure.
dwPeakLevel
Integer value representing peak level across the current frame, which corresponds to approximately 1/10 second of audio stream. The current frame typically lags 50-200 ms behind real-time. This value can range from 0 through 99, with 0 being completely silent and 99 being the highest possible input level.
lRecordVolume
Current recording volume for the client. The value can range from -10,000 to 0. This member is available even when automatic gain control is active.
pvLocalPlayerContext
Pointer to the context value set for the local player. This value is set through the pvPlayerContext member of the DVMSGID_CREATEVOICEPLAYER structure.

Remarks

Return from the message callback function with DV_OK.

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. In addition, if the client is running in half duplex mode, this message is not available.

Message Information

Headerdvoice.h
Minimum operating systems Windows 98

© 2003 Microsoft Corporation. All rights reserved.