IDirectMusicPerformance::SetParam

  • Article

This method sets data on a track inside the control segment.

HRESULT SetParam(
  REFGUID rguidType,
  DWORD dwGroupBits,
  DWORD dwIndex,
  MUSIC_TIME mtTime,
  void* pParam
);

Parameters

  • rguidType
    Reference to (C++) or address of (C) the identifier of the type of data to set. For more information, see Track Parameter Types.
  • dwGroupBits
    Group that the desired track is in.
  • dwIndex
    Index of the track in the group identified by dwGroupBits in which data is to be set.
  • mtTime
    Time at which to set the data. Unlike IDirectMusicSegment::SetParam, this time is in performance time. The start time of the segment is subtracted from this time, and the result is passed to IDirectMusicSegment::SetParam.
  • pParam
    Address of a structure containing the data. This structure must be of the appropriate kind and size for the data type identified by rguidType.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return one of the following error values:

DMUS_E_NO_MASTER_CLOCK
DMUS_E_SET_UNSUPPORTED
DMUS_E_TRACK_NOT_FOUND
E_POINTER

Remarks

Normally the primary segment is the control segment. However, a secondary segment can be designated as the control segment when it is played. For more information, see DMUS_SEGF_FLAGS.

For an explanation of dwGroupBits and dwIndex, see Identifying the Track.

Requirements

OS Versions: Windows CE .NET 4.0 and Windows CE .NET 4.1.
Header: Dmusici.h.
Link Library: Dmusic.lib.

See Also

Music Parameters | DMUS_SEGF_FLAGS | IDirectMusicPerformance::GetParam | IDirectMusicPerformance::SetGlobalParam | IDirectMusicTrack::SetParam | IDirectMusicPerformance::GetTime | IDirectMusicSegment::SetParam

 Last updated on Monday, April 12, 2004

© 1992-2002 Microsoft Corporation. All rights reserved.