API Reference / Audio / audSetChannelPitch

audSetChannelPitch

Sets the playback pitch/speed of a playing channel. Takes channel (channel handle), pitch (pitch multiplier). Returns nothing.

Audio

Parameters & Returns

Parameters

channel Int
pitch Double

Returns

Void

Quick Summary

Sets the playback pitch/speed of a playing channel. Takes channel (channel handle), pitch (pitch multiplier). Returns nothing.

Technical Exegesis...

Sets the relative playback speed for the specified channel, which affects both pitch and tempo. A value of 1.0 is normal speed, 2.0 is double speed (higher pitch), 0.5 is half speed (lower pitch).

Does nothing if the channel handle is invalid or <= 0. Changes take effect immediately during playback. Implemented using setRelativePlaySpeed. Useful for sound effects variations, slow-motion effects, or tempo adjustments.

Example

Example.bam 
audSetChannelPitch(channel, pitch)
Since: 1.0 Status: Stable
← Back to Audio