AudioStreamPlayer3D

Documentation

Overview

Package AudioStreamPlayer3D provides methods for working with AudioStreamPlayer3D object instances.

Index

• type Advanced
• type Any
• type AttenuationModel
• type DopplerTracking
• type Instance
  • func New() Instance
  • func (self Instance) AreaMask() int
  • func (self Instance) AsAudioStreamPlayer3D() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AttenuationFilterCutoffHz() Float.X
  • func (self Instance) AttenuationFilterDb() Float.X
  • func (self Instance) AttenuationModel() gdclass.AudioStreamPlayer3DAttenuationModel
  • func (self Instance) Autoplay() bool
  • func (self Instance) Bus() string
  • func (self Instance) DopplerTracking() gdclass.AudioStreamPlayer3DDopplerTracking
  • func (self Instance) EmissionAngleDegrees() Float.X
  • func (self Instance) EmissionAngleEnabled() bool
  • func (self Instance) EmissionAngleFilterAttenuationDb() Float.X
  • func (self Instance) GetPlaybackPosition() Float.X
  • func (self Instance) GetStreamPlayback() [1]gdclass.AudioStreamPlayback
  • func (self Instance) HasStreamPlayback() bool
  • func (self Instance) MaxDb() Float.X
  • func (self Instance) MaxDistance() Float.X
  • func (self Instance) MaxPolyphony() int
  • func (self Instance) OnFinished(cb func())
  • func (self Instance) PanningStrength() Float.X
  • func (self Instance) PitchScale() Float.X
  • func (self Instance) Play()
  • func (self Instance) PlaybackType() gdclass.AudioServerPlaybackType
  • func (self Instance) Playing() bool
  • func (self Instance) SeekTo(to_position Float.X)
  • func (self Instance) SetAreaMask(value int)
  • func (self Instance) SetAttenuationFilterCutoffHz(value Float.X)
  • func (self Instance) SetAttenuationFilterDb(value Float.X)
  • func (self Instance) SetAttenuationModel(value gdclass.AudioStreamPlayer3DAttenuationModel)
  • func (self Instance) SetAutoplay(value bool)
  • func (self Instance) SetBus(value string)
  • func (self Instance) SetDopplerTracking(value gdclass.AudioStreamPlayer3DDopplerTracking)
  • func (self Instance) SetEmissionAngleDegrees(value Float.X)
  • func (self Instance) SetEmissionAngleEnabled(value bool)
  • func (self Instance) SetEmissionAngleFilterAttenuationDb(value Float.X)
  • func (self Instance) SetMaxDb(value Float.X)
  • func (self Instance) SetMaxDistance(value Float.X)
  • func (self Instance) SetMaxPolyphony(value int)
  • func (self Instance) SetPanningStrength(value Float.X)
  • func (self Instance) SetPitchScale(value Float.X)
  • func (self Instance) SetPlaybackType(value gdclass.AudioServerPlaybackType)
  • func (self Instance) SetStream(value [1]gdclass.AudioStream)
  • func (self Instance) SetStreamPaused(value bool)
  • func (self Instance) SetUnitSize(value Float.X)
  • func (self Instance) SetVolumeDb(value Float.X)
  • func (self Instance) Stop()
  • func (self Instance) Stream() [1]gdclass.AudioStream
  • func (self Instance) StreamPaused() bool
  • func (self Instance) UnitSize() Float.X
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
  • func (self Instance) VolumeDb() Float.X

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
	AsAudioStreamPlayer3D() Instance
}

type AttenuationModel

type AttenuationModel = gdclass.AudioStreamPlayer3DAttenuationModel //gd:AudioStreamPlayer3D.AttenuationModel

const (
	/*Attenuation of loudness according to linear distance.*/
	AttenuationInverseDistance AttenuationModel = 0
	/*Attenuation of loudness according to squared distance.*/
	AttenuationInverseSquareDistance AttenuationModel = 1
	/*Attenuation of loudness according to logarithmic distance.*/
	AttenuationLogarithmic AttenuationModel = 2
	/*No attenuation of loudness according to distance. The sound will still be heard positionally, unlike an [AudioStreamPlayer]. [constant ATTENUATION_DISABLED] can be combined with a [member max_distance] value greater than [code]0.0[/code] to achieve linear attenuation clamped to a sphere of a defined size.*/
	AttenuationDisabled AttenuationModel = 3
)

type DopplerTracking

type DopplerTracking = gdclass.AudioStreamPlayer3DDopplerTracking //gd:AudioStreamPlayer3D.DopplerTracking

const (
	/*Disables doppler tracking.*/
	DopplerTrackingDisabled DopplerTracking = 0
	/*Executes doppler tracking during process frames (see [constant Node.NOTIFICATION_INTERNAL_PROCESS]).*/
	DopplerTrackingIdleStep DopplerTracking = 1
	/*Executes doppler tracking during physics frames (see [constant Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS]).*/
	DopplerTrackingPhysicsStep DopplerTracking = 2
)

type Instance

type Instance [1]gdclass.AudioStreamPlayer3D

Plays audio with positional sound effects, based on the relative position of the audio listener. Positional effects include distance attenuation, directionality, and the Doppler effect. For greater realism, a low-pass filter is applied to distant sounds. This can be disabled by setting [member attenuation_filter_cutoff_hz] to [code]20500[/code]. By default, audio is heard from the camera position. This can be changed by adding an [AudioListener3D] node to the scene and enabling it by calling [method AudioListener3D.make_current] on it. See also [AudioStreamPlayer] to play a sound non-positionally. [b]Note:[/b] Hiding an [AudioStreamPlayer3D] node does not disable its audio output. To temporarily disable an [AudioStreamPlayer3D]'s audio output, set [member volume_db] to a very low value like [code]-100[/code] (which isn't audible to human hearing).

var Nil Instance

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

func New

func New() Instance

func (Instance) AreaMask

func (self Instance) AreaMask() int

func (Instance) AsAudioStreamPlayer3D

func (self Instance) AsAudioStreamPlayer3D() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

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

func (Instance) AttenuationFilterCutoffHz

func (self Instance) AttenuationFilterCutoffHz() Float.X

func (Instance) AttenuationFilterDb

func (self Instance) AttenuationFilterDb() Float.X

func (Instance) AttenuationModel

func (self Instance) AttenuationModel() gdclass.AudioStreamPlayer3DAttenuationModel

func (Instance) Autoplay

func (self Instance) Autoplay() bool

func (Instance) Bus

func (self Instance) Bus() string

func (Instance) DopplerTracking

func (self Instance) DopplerTracking() gdclass.AudioStreamPlayer3DDopplerTracking

func (Instance) EmissionAngleDegrees

func (self Instance) EmissionAngleDegrees() Float.X

func (Instance) EmissionAngleEnabled

func (self Instance) EmissionAngleEnabled() bool

func (Instance) EmissionAngleFilterAttenuationDb

func (self Instance) EmissionAngleFilterAttenuationDb() Float.X

func (Instance) GetPlaybackPosition

func (self Instance) GetPlaybackPosition() Float.X

Returns the position in the [AudioStream].

func (Instance) GetStreamPlayback

func (self Instance) GetStreamPlayback() [1]gdclass.AudioStreamPlayback

Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer3D].

func (Instance) HasStreamPlayback

func (self Instance) HasStreamPlayback() bool

Returns whether the [AudioStreamPlayer] can return the [AudioStreamPlayback] object or not.

func (Instance) MaxDb

func (self Instance) MaxDb() Float.X

func (Instance) MaxDistance

func (self Instance) MaxDistance() Float.X

func (Instance) MaxPolyphony

func (self Instance) MaxPolyphony() int

func (Instance) OnFinished

func (self Instance) OnFinished(cb func())

func (Instance) PanningStrength

func (self Instance) PanningStrength() Float.X

func (Instance) PitchScale

func (self Instance) PitchScale() Float.X

func (Instance) Play

func (self Instance) Play()

Queues the audio to play on the next physics frame, from the given position [param from_position], in seconds.

func (Instance) PlaybackType

func (self Instance) PlaybackType() gdclass.AudioServerPlaybackType

func (Instance) Playing

func (self Instance) Playing() bool

func (Instance) SeekTo

func (self Instance) SeekTo(to_position Float.X)

Sets the position from which audio will be played, in seconds.

func (Instance) SetAreaMask

func (self Instance) SetAreaMask(value int)

func (Instance) SetAttenuationFilterCutoffHz

func (self Instance) SetAttenuationFilterCutoffHz(value Float.X)

func (Instance) SetAttenuationFilterDb

func (self Instance) SetAttenuationFilterDb(value Float.X)

func (Instance) SetAttenuationModel

func (self Instance) SetAttenuationModel(value gdclass.AudioStreamPlayer3DAttenuationModel)

func (Instance) SetAutoplay

func (self Instance) SetAutoplay(value bool)

func (Instance) SetBus

func (self Instance) SetBus(value string)

func (Instance) SetDopplerTracking

func (self Instance) SetDopplerTracking(value gdclass.AudioStreamPlayer3DDopplerTracking)

func (Instance) SetEmissionAngleDegrees

func (self Instance) SetEmissionAngleDegrees(value Float.X)

func (Instance) SetEmissionAngleEnabled

func (self Instance) SetEmissionAngleEnabled(value bool)

func (Instance) SetEmissionAngleFilterAttenuationDb

func (self Instance) SetEmissionAngleFilterAttenuationDb(value Float.X)

func (Instance) SetMaxDb

func (self Instance) SetMaxDb(value Float.X)

func (Instance) SetMaxDistance

func (self Instance) SetMaxDistance(value Float.X)

func (Instance) SetMaxPolyphony

func (self Instance) SetMaxPolyphony(value int)

func (Instance) SetPanningStrength

func (self Instance) SetPanningStrength(value Float.X)

func (Instance) SetPitchScale

func (self Instance) SetPitchScale(value Float.X)

func (Instance) SetPlaybackType

func (self Instance) SetPlaybackType(value gdclass.AudioServerPlaybackType)

func (Instance) SetStream

func (self Instance) SetStream(value [1]gdclass.AudioStream)

func (Instance) SetStreamPaused

func (self Instance) SetStreamPaused(value bool)

func (Instance) SetUnitSize

func (self Instance) SetUnitSize(value Float.X)

func (Instance) SetVolumeDb

func (self Instance) SetVolumeDb(value Float.X)

func (Instance) Stop

func (self Instance) Stop()

Stops the audio.

func (Instance) Stream

func (self Instance) Stream() [1]gdclass.AudioStream

func (Instance) StreamPaused

func (self Instance) StreamPaused() bool

func (Instance) UnitSize

func (self Instance) UnitSize() Float.X

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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

func (Instance) VolumeDb

func (self Instance) VolumeDb() Float.X