AudioStreamPlaybackPolyphonic

Documentation

Overview

Package AudioStreamPlaybackPolyphonic provides methods for working with AudioStreamPlaybackPolyphonic object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsAudioStreamPlayback() AudioStreamPlayback.Instance
  • func (self Instance) AsAudioStreamPlaybackPolyphonic() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) IsStreamPlaying(stream int) bool
  • func (self Instance) PlayStream(stream [1]gdclass.AudioStream) int
  • func (self Instance) SetStreamPitchScale(stream int, pitch_scale Float.X)
  • func (self Instance) SetStreamVolume(stream int, volume_db Float.X)
  • func (self Instance) StopStream(stream int)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsAudioStreamPlaybackPolyphonic() Instance
}

type Instance

type Instance [1]gdclass.AudioStreamPlaybackPolyphonic

Playback instance for [AudioStreamPolyphonic]. After setting the [code]stream[/code] property of [AudioStreamPlayer], [AudioStreamPlayer2D], or [AudioStreamPlayer3D], the playback instance can be obtained by calling [method AudioStreamPlayer.get_stream_playback], [method AudioStreamPlayer2D.get_stream_playback] or [method AudioStreamPlayer3D.get_stream_playback] methods.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsAudioStreamPlayback

func (self Instance) AsAudioStreamPlayback() AudioStreamPlayback.Instance

func (Instance) AsAudioStreamPlaybackPolyphonic

func (self Instance) AsAudioStreamPlaybackPolyphonic() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) IsStreamPlaying

func (self Instance) IsStreamPlaying(stream int) bool

Return true whether the stream associated with an integer ID is still playing. Check [method play_stream] for information on when this ID becomes invalid.

func (Instance) PlayStream

func (self Instance) PlayStream(stream [1]gdclass.AudioStream) int

Play an [AudioStream] at a given offset, volume, pitch scale, playback type, and bus. Playback starts immediately. The return value is a unique integer ID that is associated to this playback stream and which can be used to control it. This ID becomes invalid when the stream ends (if it does not loop), when the [AudioStreamPlaybackPolyphonic] is stopped, or when [method stop_stream] is called. This function returns [constant INVALID_ID] if the amount of streams currently playing equals [member AudioStreamPolyphonic.polyphony]. If you need a higher amount of maximum polyphony, raise this value.

func (Instance) SetStreamPitchScale

func (self Instance) SetStreamPitchScale(stream int, pitch_scale Float.X)

Change the stream pitch scale. The [param stream] argument is an integer ID returned by [method play_stream].

func (Instance) SetStreamVolume

func (self Instance) SetStreamVolume(stream int, volume_db Float.X)

Change the stream volume (in db). The [param stream] argument is an integer ID returned by [method play_stream].

func (Instance) StopStream

func (self Instance) StopStream(stream int)

Stop a stream. The [param stream] argument is an integer ID returned by [method play_stream], which becomes invalid after calling this function.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value