DVMSGID_CREATEVOICEPLAYER Message

DirectPlay

 
Microsoft DirectX 9.0 SDK Update (Summer 2003)

DVMSGID_CREATEVOICEPLAYER Message


Microsoft® DirectPlay® Voice generates the DVMSGID_CREATEVOICEPLAYER message when a new player joins the voice session.

The DVMSG_CREATEVOICEPLAYER structure contains information for the DVMSGID_CREATEVOICEPLAYER message.

Syntax

typedef struct {
    DWORD dwSize;
    DVID dvidPlayer;
    DWORD dwFlags;
    PVOID pvPlayerContext;
}  DVMSG_CREATEVOICEPLAYER *LPDVMSG_CREATEVOICEPLAYER, *PDVMSG_CREATEVOICEPLAYER;

Members

dwSize
Size of the this message structure.
dvidPlayer
DVID of the player who connected.
dwFlags
Flag specifying information about the player:
DVPLAYERCAPS_HALFDUPLEX
The specified player is running in half duplex mode. The player will only be able to receive voice, not transmit it.
DVPLAYERCAPS_LOCAL
The player is the local player.
pvPlayerContext
Player context value for the player in the voice session. This value is set through this parameter when this message is received.

Remarks

Return from the message callback function with DV_OK.

Upon connecting to a voice session, clients receive one of these messages for each player in the voice session. These messages are sent only to clients in peer-to-peer voice sessions.

The host receives these messages when players join the voice session.

Players do not join the voice session until they have called IDirectPlayVoiceClient::Connect. Therefore, it is possible for a player to be in the transport session but not part of the voice session.

DirectPlay and DirectPlay Voice sessions are separate entities. While there are guarantees about message order for each interface, there are no guarantees about message order between interfaces.

Message Information

Headerdvoice.h
Minimum operating systems Windows 98

© 2003 Microsoft Corporation. All rights reserved.