import Source from '@mobilizing/library/js/Mobilizing/renderer/audio/Source.js'

public class |source

Source

Extends:

Component → Source

Constructor Summary

Public Constructor
public	constructor(params: Object)

Member Summary

Public Members
public	autoUpdateRotation: *
public	buffer: *
public	currentTime: number
public	duration: *
public	gain: *
public	is3D: *
public	loop: *
public	loopCount: number
public	mediaElement: *
public	nativeAudioSource: *
public	offsetStartTime: number
public	panner: *
public	playbackRate: number
public	playing: boolean
public	renderer: *
public	scheduleStartTime: number
public	startedTime: number
public	transform: *

Method Summary

Public Methods
public	connect(dest: AudioNode) If you need to connect WebAudio AudioNode by yourself, use this method with the access to the WebAudio Node given by getNativeSource()
public	createFromMediaStream(stream: MediaStream, autoConnect: boolean=true)
public	disconnect() Disconnects this source from it current destination
public	generateAudioBufferSource()
public	getGain(val: Number): * Get this audioContext's gain volume
public	getLoop(): Boolean get this source loop
public	getNativeSource(): AudioBufferSourceNode Return the underlying WebAudio audio source
public	getOffsetStartTime(): Number Gets the offset play of this sound
public	getPlaybackRate(): Number Get this source playback rate (speed)
public	getScheduleStartTime(): Number Gets the offset play of this sound
public	off()
public	offlinePlay()
public	on()
public	pause() pauses the Source.
public	play() Play this sound source
public	setAutoUpdateRotation(val: Boolean)
public	setBuffer(buffer: Object) set the current Source buffer
public	setConeInnerAngle(angle: Number)
public	setConeOuterAngle(angle: Number)
public	setConeOuterGain(val: Number)
public	setGain(gain: Number, rampValue: Number) Set this source's gain volume, use a 1 sec linear ramp to avoid clicks
public	setLoop(enabled: Boolean) set this source loop
public	setMaxDistance(val: Number) Sets the maximum distance for sound propagation in space
public	setOffsetStartTime(val: Number) Sets the offset play of this sound
public	setPlaybackRate(val: Number) Set this source playback rate (speed)
public	setRefDistance(val: Number) Sets the reference distance for sound attenuation through space
public	setScheduleStartTime(val: Number) Sets the start time play of this sound in current rendrer time
public	setTransform(transform: Object) set the current Transform that represents the Source position in space.
public	stop() stops the Source.
public	update() Updates the source's position in space if given from a transform

Inherited Summary

From class Component
public	active: boolean
public	context: *
public	events: *
public	id: *
public	name: *
private	_nexts: *[]
private	_setupDone: boolean
public	byPass()
public	chain(component: Component) Adds a component to this chained component array
public	getChainedComponents(): Array Returns the array of attached children components
public	off() Deactivate the component
public	on() Activate the component A call to this method calls the setup method if it has not been run yet
public	postUpdate() Run code after the update of all components is run This empty method is usually overriden to perform post-update actions for the component It is called periodically by an internal Mobilizing mechanism
public	preLoad() preLoad the component This empty method is usually overriden to perform preLoad actions for the component.
public	preUpdate() Run code before the update of all components is run This empty method is usually overriden to perform pre-update actions for the component It is called once per component by an internal Mobilizing mechanism
public	prepare() prepare the component This empty method is usually overriden to perform preparation actions for the component, from external process as a server.
public	setup() Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly
public	update() Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism

Public Constructors

public constructor(params: Object) source

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
params	Object		Parameters object, given by the constructor.
params.renderer	Renderer		the audio renderer
params.is3D	bool		is the audio source positionned in 3D ?
params.loop	bool		should the source be played in loop ?
params.autoUpdateRotation	bool		should the orientation of the source be updated automatically ?

Public Members

public autoUpdateRotation: * source

public buffer: * source

public currentTime: number source

public duration: * source

public gain: * source

public is3D: * source

public loop: * source

public loopCount: number source

public mediaElement: * source

public nativeAudioSource: * source

public offsetStartTime: number source

public panner: * source

public playbackRate: number source

public playing: boolean source

public renderer: * source

public scheduleStartTime: number source

public startedTime: number source

public transform: * source

Public Methods

public connect(dest: AudioNode) source

If you need to connect WebAudio AudioNode by yourself, use this method with the access to the WebAudio Node given by getNativeSource()

Params:

Name	Type	Attribute	Description
dest	AudioNode		the destination to connect this source to. If this param is undefined, the connection will be made automatically with the renderer's masterGain

public createFromMediaStream(stream: MediaStream, autoConnect: boolean=true) source

Params:

Name	Type	Attribute	Description
stream	MediaStream		the MediaStream from which to create this AudioSource
autoConnect	boolean=true		if false is given, this source' gain will be disconnected from the destination (renderer masterGain node). Usefull for mic stream analysis that don't need to hear but need to connect to the analyser

public disconnect() source

Disconnects this source from it current destination

public generateAudioBufferSource() source

public getGain(val: Number): * source

Get this audioContext's gain volume

Params:

Name	Type	Attribute	Description
val	Number

Return:

public getLoop(): Boolean source

get this source loop

Return:

Boolean

enabled

public getNativeSource(): AudioBufferSourceNode source

Return the underlying WebAudio audio source

Return:

AudioBufferSourceNode

webAudio source

public getOffsetStartTime(): Number source

Gets the offset play of this sound

Return:

Number

the time to start to play the sound buffer

public getPlaybackRate(): Number source

Get this source playback rate (speed)

Return:

Number

public getScheduleStartTime(): Number source

Gets the offset play of this sound

Return:

Number

the time to start to play the sound buffer

public off() source

Deactivate the component

Override:

Component#off

public offlinePlay() source

public on() source

Activate the component A call to this method calls the setup method if it has not been run yet

Override:

Component#on

public pause() source

pauses the Source.

public play() source

Play this sound source

public setAutoUpdateRotation(val: Boolean) source

Params:

Name	Type	Attribute	Description
val	Boolean

public setBuffer(buffer: Object) source

set the current Source buffer

Params:

Name	Type	Attribute	Description
buffer	Object		the AudioBuffer we want the source to play.

public setConeInnerAngle(angle: Number) source

Params:

Name	Type	Attribute	Description
angle	Number

public setConeOuterAngle(angle: Number) source

Params:

Name	Type	Attribute	Description
angle	Number

public setConeOuterGain(val: Number) source

Params:

Name	Type	Attribute	Description
val	Number

public setGain(gain: Number, rampValue: Number) source

Set this source's gain volume, use a 1 sec linear ramp to avoid clicks

Params:

Name	Type	Attribute	Description
gain	Number
rampValue	Number		in seconds

public setLoop(enabled: Boolean) source

set this source loop

Params:

Name	Type	Attribute	Description
enabled	Boolean

public setMaxDistance(val: Number) source

Sets the maximum distance for sound propagation in space

Params:

Name	Type	Attribute	Description
val	Number

public setOffsetStartTime(val: Number) source

Sets the offset play of this sound

Params:

Name	Type	Attribute	Description
val	Number		the time to start to play the sound buffer

public setPlaybackRate(val: Number) source

Set this source playback rate (speed)

Params:

Name	Type	Attribute	Description
val	Number

public setRefDistance(val: Number) source

Sets the reference distance for sound attenuation through space

Params:

Name	Type	Attribute	Description
val	Number

public setScheduleStartTime(val: Number) source

Sets the start time play of this sound in current rendrer time

Params:

Name	Type	Attribute	Description
val	Number		the time to start to play the sound buffer

public setTransform(transform: Object) source

set the current Transform that represents the Source position in space.

Params:

Name	Type	Attribute	Description
transform	Object		the Transform.

public stop() source

stops the Source.

public update() source

Updates the source's position in space if given from a transform

Override:

Component#update