IXAudio2SourceVoice::Start Method

Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering voices, or to the output device.

Syntax

public:
HRESULT Start(
         UINT32 Flags,
         UINT32 OperationSet
)

Parameters

Flags
Type: UINT32

Flags that control how the voice is started. Must be 0.

OperationSet
Type: UINT32

Identifies this call as part of a deferred batch. See the XAudio2 Operation Sets overview for more information.

Return value

Type: HRESULT

Returns S_OK if successful, an error code otherwise. See XAudio2 Error Codes for descriptions of XAudio2 specific error codes.

Remarks

If the XAudio2 engine is stopped, the voice stops running. However, it remains in the started state, so that it starts running again as soon as the engine starts.

When first created, source voices are in the stopped state. Submix and mastering voices are in the started state.

After Start is called it has no further effect if called again before IXAudio2SourceVoice::Stop is called. In addition multiple calls to Start without matching calls to IXAudio2SourceVoice::Stop will result in warning messages in debug builds.

Requirements

Header: Declared in xaudio2.h.