AudioEffectRecord

Documentation

Overview

Package AudioEffectRecord provides methods for working with AudioEffectRecord object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsAudioEffect() AudioEffect.Instance
  • func (self Instance) AsAudioEffectRecord() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) Format() gdclass.AudioStreamWAVFormat
  • func (self Instance) GetRecording() [1]gdclass.AudioStreamWAV
  • func (self Instance) IsRecordingActive() bool
  • func (self Instance) SetFormat(value gdclass.AudioStreamWAVFormat)
  • func (self Instance) SetRecordingActive(record bool)
  • 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
	AsAudioEffectRecord() Instance
}

type Instance

type Instance [1]gdclass.AudioEffectRecord

Allows the user to record the sound from an audio bus into an [AudioStreamWAV]. When used on the "Master" audio bus, this includes all audio output by Godot. Unlike [AudioEffectCapture], this effect encodes the recording with the given format (8-bit, 16-bit, or compressed) instead of giving access to the raw audio samples. Can be used (with an [AudioStreamMicrophone]) to record from a microphone. [b]Note:[/b] [member ProjectSettings.audio/driver/enable_input] must be [code]true[/code] for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.

var Nil Instance

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

func New

func New() Instance

func (Instance) AsAudioEffect

func (self Instance) AsAudioEffect() AudioEffect.Instance

func (Instance) AsAudioEffectRecord

func (self Instance) AsAudioEffectRecord() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

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

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) Format

func (self Instance) Format() gdclass.AudioStreamWAVFormat

func (Instance) GetRecording

func (self Instance) GetRecording() [1]gdclass.AudioStreamWAV

Returns the recorded sample.

func (Instance) IsRecordingActive

func (self Instance) IsRecordingActive() bool

Returns whether the recording is active or not.

func (Instance) SetFormat

func (self Instance) SetFormat(value gdclass.AudioStreamWAVFormat)

func (Instance) SetRecordingActive

func (self Instance) SetRecordingActive(record bool)

If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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