Microsoft DirectX 9.0

IDirectMusicSegment8 Interface

The IDirectMusicSegment8 interface represents a segment, which is a playable unit of data made up of multiple tracks.

The segment object also supports the IDirectMusicObject8 and IPersistStream interfaces for loading its data.

IDirectMusicSegment8 supersedes the IDirectMusicSegment interface and introduces new methods.

In addition to the methods inherited from IUnknown, the IDirectMusicSegment8 interface exposes the following methods, arranged by category.

Instrument data

Method Description
Download Downloads band data to a performance or audiopath.
Unload Unloads instrument data from a performance or audiopath.

Notification

Method Description
AddNotificationType Adds a type of event for which notifications are required.
RemoveNotificationType Removes a a type of event for which notifications are required.

Timing and looping

Method Description
GetDefaultResolution Retrieves the default resolution of the segment. This is the value used to determine how times such as the segment start time are adjusted for synchronization with the rhythm.
GetLength Retrieves the length of the segment.
GetLoopPoints Retrieves the start and end loop points.
GetRepeats Retrieves the number of times the looping portion of the segment is set to repeat.
GetStartPoint Retrieves the point within the segment at which it starts playing.
SetDefaultResolution Sets the default resolution of the segment.
SetLength Sets the length, in music time, of the segment.
SetLoopPoints Sets the start and end points of the part of the segment that repeats.
SetRepeats Sets the number of times the looping portion of the segment is to repeat.
SetStartPoint Sets the point within the segment at which it starts playing.

Toolgraphs

Method Description
GetGraph Retrieves the segment's toolgraph.
SetGraph Assigns a toolgraph to the segment.

Track parameters

Method Description
GetParam Retrieves data from a track inside this segment.
SetParam Sets data on a track inside this segment.

Tracks

Method Description
GetTrack Searches the list of tracks for the one with the specified type, group, and index, and retrieves an interface to the track.
GetTrackGroup Retrieves the group bits set on a track inside the segment.
InsertTrack Inserts the specified track into the segment's list of tracks.
RemoveTrack Removes a track from the segment's track list.
SetTrackConfig Sets the onfiguration of a track for miscellaneous behaviors.

Miscellaneous

Method Description
Clone Copies all or part of the segment.
Compose Composes all tracks flagged as DMUS_TRACKCONFIG_COMPOSING and places the composed tracks in this segment or in a copy of this segment.
GetAudioPathConfig Retrieves an object that represents an audiopath configuration embedded in the segment.
InitPlay Initializes the play state.
SetPChannelsUsed Sets the performance channels that this segment uses.

Requirements

  Header: Declared in dmusici.h.

See Also