Microsoft DirectX 8.1 (C++)

IDirectMusicSong8::Compose

Not implemented in DirectX 8.1.

The Compose method creates playable segments from the source material in the song.

Syntax

HRESULT Compose();

Parameters

None.

Return Values

If the method succeeds, it returns one of the success codes shown in the following table.

Return code Description
S_OK The song was composed.
S_FALSE There were no tracks to be composed.
DMUS_S_GARBAGE_COLLECTED See Garbage Collection.

If it fails, the method can return one of the error values shown in the following table.

Return code
DMUS_E_TRACK_NOT_FOUND
E_INVALIDARG
E_POINTER
E_OUTOFMEMORY

Remarks

The method finds all composing tracks in all segments in the song, joins tracks with the same class identifier and group bits into master composing tracks, composes new tracks from the master composing tracks in priority order, breaks these new tracks up so that they correspond to the original tracks, and inserts the smaller composed tracks into segments of the song in the appropriate places.

Requirements

  Header: Declared in dmusici.h.

See Also