Microsoft DirectX 8.1 (C++)

IDirectPlayVoiceServer::StartSession

Starts an initialized Microsoft® DirectPlay® Voice session within a running DirectPlay transport session. This method must be successfully called before the clients can complete a connection-to-the-voice session.

HRESULT StartSession(
PDVSESSIONDESC pSessionDesc,
DWORD dwFlags
);

Parameters

pSessionDesc
[in] Pointer to a DVSESSIONDESC structure that contains the session description.
dwFlags
[in] Reserved. Must be 0.

Return Values

Returns DV_OK if successful, or one of the following error values.

DVERR_ALREADYPENDING
DVERR_HOSTING
DVERR_INVALIDFLAGS
DVERR_INVALIDOBJECT
DVERR_INVALIDPARAM
DVERR_INVALIDPOINTER
DVERR_NOTINITIALIZED

Remarks

The IDirectPlayVoiceServer::Initialize method must be called before this method is called. The voice session can be hosted on any client in the session if the voice session is peer-to-peer. If the voice session is not peer-to-peer, it must be hosted on the transport client, which is the host of a active transport session.

The DVSESSIONDESC structure contains the type of voice session to start. The type of voice session can have a dramatic effect on the CPU and bandwidth usage for both the client and the server. You can set the guidCT member of DVSESSIONDESC to DPVCTGUID_DEFAULT.

Requirements

  Windows NT/2000/XP: Available as a redistributable for Windows 2000 and later.
  Windows 98/Me: Available as a redistributable for Windows 98 and later.
  Header: Declared in Dvoice.h.