2.2.2.4 Add Voice Client Message

In the Peer Voice Session Subprotocol (section 1.3.3) this message is sent from the host to all voice clients in the game session to instruct them to add a voice client to their list of voice clients. In the Mixing Voice Session Subprotocol (section 1.3.4) this message is sent from the host to the voice client to indicate that the voice client has successfully joined the voice session. These messages are transmitted as ordered, guaranteed messages using the DirectPlay protocol voice message type.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Header

DVID

...

PlayerFlags

...

HostOrderID

...

Header (1 byte): The common message header (as specified in section 2.2.1). The MessageType field MUST be set to DVMSGID_CREATEVOICEPLAYER (0x01).

DVID (4 bytes): A 32-bit unsigned integer containing the DVID of the voice client that is to be added.

PlayerFlags (4 bytes): A 32-bit unsigned integer. This represents a set of bit flags representing voice client audio capabilities. This field MUST be composed of the bitwise OR of zero or more of the following values.

Value

Meaning

DVPLAYERCAPS_HALFDUPLEX

0x00000001

The voice client cannot record audio and will therefore not be transmitting any speech messages.

HostOrderID (4 bytes): A 32-bit unsigned integer representing the host order ID of the voice client. When host migration is enabled as described in section 1.3.3.1, this field MUST be set to the host order ID of the voice client to be added. Otherwise, HostOrderID SHOULD be set to 0xFFFFFFFF.