Share via

Segment.UnloadSoundData

  • Article
Windows Media Encoder SDK banner art

The UnloadSoundData method unloads instruments or wave data used by the segment. The data is released from system memory. All instruments and waves using that data fall silent.

object.UnloadSoundData [oAudiopath]

Parts

object

Required. Object expression that resolves to a Segment Object.

oAudiopath

Optional. Audiopath Object that represents the location of the segment's sound data. This must be the same path that was passed to Segment.DownloadSoundData. If this parameter is omitted, the default audiopath for the segment is used.

Remarks

Scripts should call UnloadSoundData for each call to Segment.DownloadSoundData. The data is not removed until it has been unloaded as many times as it was downloaded. There is no harm in calling this method more often than DownloadSoundData was called.

Sound data is automatically loaded and unloaded if Load all content when script is loaded is set in the Script Properties.