Class MicrophoneStream

A live microphone source backed by the current MediaStreamSound architecture. Use MicrophoneStream.request (or Cacophony.getMicrophoneStream) when the stream still needs to be acquired so permission failures remain observable.

Hierarchy (View Summary)

MediaStreamSound
- MicrophoneStream

Index

Constructors

constructor

new MicrophoneStream(
    context: BaseContext,
    stream: MediaStream,
    outputNode?: AudioNode,
    options?: MicrophoneStreamOptions,
    cacophony?: Cacophony,
): MicrophoneStream
Parameters
- context: BaseContext
- stream: MediaStream
- OptionaloutputNode: AudioNode
- options: MicrophoneStreamOptions = {}
- Optionalcacophony: Cacophony
Returns MicrophoneStream
Overrides MediaStreamSound.constructor
- Defined in src/microphone.ts:43

Properties

_filters

_filters: BiquadFilterNode[] = []

_position

_position: Position

`Protected`_routeTarget

_routeTarget: Bus | null = null

Primary route target. null is the canonical master route.

`Protected`_sends

_sends: Map<Bus, number> = ...

Additional send target to gain-value mappings.

_stereoPan

_stereoPan: number

_threeDOptions

_threeDOptions: ThreeDOptions

_volume

_volume: number

`Protected`context

context: BaseContext

`Protected`globalGainNode

globalGainNode: GainNode

playbacks

playbacks: MediaStreamPlayback[]

Accessors

cacophony

get cacophony(): Cacophony | undefined
Returns Cacophony | undefined
Inherited from MediaStreamSound.cacophony
- Defined in src/mediaStream.ts:249

filters

get filters(): BiquadFilterNode[]
Returns BiquadFilterNode[]
Inherited from MediaStreamSound.filters
- Defined in src/filters.ts:38

isPlaying

get isPlaying(): boolean
Returns boolean
Inherited from MediaStreamSound.isPlaying
- Defined in src/container.ts:56

playbackRate

get playbackRate(): number
Returns number
Inherited from MediaStreamSound.playbackRate
- Defined in src/mediaStream.ts:306
set playbackRate(_rate: number): void
Parameters
- _rate: number
Returns void
Inherited from MediaStreamSound.playbackRate
- Defined in src/mediaStream.ts:310

position

get position(): Position
Returns Position
Inherited from MediaStreamSound.position
- Defined in src/container.ts:57
set position(position: Position): void
Parameters
- position: Position
Returns void
Inherited from MediaStreamSound.position
- Defined in src/container.ts:58

stereoPan

get stereoPan(): number
Returns number
Inherited from MediaStreamSound.stereoPan
- Defined in src/container.ts:61
set stereoPan(value: number): void
Parameters
- value: number
Returns void
Inherited from MediaStreamSound.stereoPan
- Defined in src/container.ts:62

threeDOptions

get threeDOptions(): ThreeDOptions
Returns ThreeDOptions
Inherited from MediaStreamSound.threeDOptions
- Defined in src/container.ts:59
set threeDOptions(options: ThreeDOptions | Partial<HrtfPannerOptions>): void
Parameters
- options: ThreeDOptions | Partial<HrtfPannerOptions>
Returns void
Inherited from MediaStreamSound.threeDOptions
- Defined in src/container.ts:60

volume

get volume(): number
Returns number
Inherited from MediaStreamSound.volume
- Defined in src/container.ts:63
set volume(volume: number): void
Parameters
- volume: number
Returns void
Inherited from MediaStreamSound.volume
- Defined in src/container.ts:64

Methods

_onBusDrained

_onBusDrained(bus: Bus, target: Bus): void
Called by Bus.drainTo to move this source off the draining bus onto target. The source reroutes its primary route and/or any send that targeted bus.
Parameters
- bus: Bus
- target: Bus
Returns void
Inherited from MediaStreamSound._onBusDrained
- Defined in src/routableSource.ts:205

`Protected`_preparePlayback

_preparePlayback(playback: BasePlayback): void
Materialize all declared recipes, then establish this playback's sends.
Parameters
- playback: BasePlayback
Returns void
Inherited from MediaStreamSound._preparePlayback
- Defined in src/routableSource.ts:125

_resolveRouteTargetNode

_resolveRouteTargetNode(): GainNode
Resolve the node used by future playbacks for their primary output. Sources left on a subsequently destroyed bus fall back to master.

Returns GainNode
Inherited from MediaStreamSound._resolveRouteTargetNode
- Defined in src/routableSource.ts:93

`Protected`_wireRouteSends

_wireRouteSends(playback: BasePlayback): void
Establish every configured send on a newly created playback.
Parameters
- playback: BasePlayback
Returns void
Inherited from MediaStreamSound._wireRouteSends
- Defined in src/routableSource.ts:109

addEffect

addEffect(effect: CacophonyEffect): void
Parameters
- effect: CacophonyEffect
Returns void
Inherited from MediaStreamSound.addEffect
- Defined in src/routableSource.ts:32

addFilter

addFilter(filter: BiquadFilterNode): void
Adds a BiquadFilterNode to the filter chain.
Parameters
- filter: BiquadFilterNode
Returns void

Throws
If the same filter instance is added twice.
Inherited from MediaStreamSound.addFilter
- Defined in src/routableSource.ts:47

addFilters

addFilters(filters: BiquadFilterNode[]): void
Parameters
- filters: BiquadFilterNode[]
Returns void
Inherited from MediaStreamSound.addFilters
- Defined in src/filters.ts:42

cleanup

cleanup(): void
Returns void
Inherited from MediaStreamSound.cleanup
- Defined in src/mediaStream.ts:312

fadeIn

fadeIn(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Inherited from MediaStreamSound.fadeIn
- Defined in src/container.ts:66

fadeOut

fadeOut(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Inherited from MediaStreamSound.fadeOut
- Defined in src/container.ts:67

fadeTo

fadeTo(value: number, duration: number, type?: FadeType): Promise<void>
Parameters
- value: number
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Inherited from MediaStreamSound.fadeTo
- Defined in src/container.ts:65

loop

loop(_loopCount?: LoopCount): LoopCount
Parameters
- Optional_loopCount: LoopCount
Returns LoopCount
Inherited from MediaStreamSound.loop
- Defined in src/mediaStream.ts:302

pause

pause(): void
Returns void
Inherited from MediaStreamSound.pause
- Defined in src/container.ts:53

play

play(options?: PlayOptions): MediaStreamPlayback[]
Parameters
- Optionaloptions: PlayOptions
Returns MediaStreamPlayback[]
Inherited from MediaStreamSound.play
- Defined in src/mediaStream.ts:289

preplay

preplay(): MediaStreamPlayback[]
Returns MediaStreamPlayback[]
Inherited from MediaStreamSound.preplay
- Defined in src/mediaStream.ts:260

removeEffect

removeEffect(effect: CacophonyEffect): void
Parameters
- effect: CacophonyEffect
Returns void
Inherited from MediaStreamSound.removeEffect
- Defined in src/routableSource.ts:39

removeFilter

removeFilter(filter: BiquadFilterNode): void
Removes a BiquadFilterNode from the filter chain by object identity.
Parameters
- filter: BiquadFilterNode
Returns void

Throws
If the filter was never added to this container.
Inherited from MediaStreamSound.removeFilter
- Defined in src/routableSource.ts:55

resume

resume(): void
Returns void
Inherited from MediaStreamSound.resume
- Defined in src/mediaStream.ts:298

routeTo

routeTo(target: string | Bus, sendGain?: number): void
Route this source to a bus, or add an independent send when sendGain is provided.
Parameters
- target: string | Bus
- OptionalsendGain: number
Returns void
Inherited from MediaStreamSound.routeTo
- Defined in src/routableSource.ts:69

seek

seek(_time: number): void
Parameters
- _time: number
Returns void
Inherited from MediaStreamSound.seek
- Defined in src/mediaStream.ts:296

stop

stop(): void
Returns void
Inherited from MediaStreamSound.stop
- Defined in src/container.ts:52

stopWithFade

stopWithFade(duration: number, type?: FadeType): Promise<void>
Parameters
- duration: number
- Optionaltype: FadeType
Returns Promise<void>
Inherited from MediaStreamSound.stopWithFade
- Defined in src/container.ts:68

`Static`request

request(
    context: BaseContext,
    outputNode?: AudioNode,
    options?: MicrophoneStreamOptions,
    cacophony?: Cacophony,
): Promise<MicrophoneStream>
Parameters
- context: BaseContext
- OptionaloutputNode: AudioNode
- options: MicrophoneStreamOptions = {}
- Optionalcacophony: Cacophony
Returns Promise<MicrophoneStream>
- Defined in src/microphone.ts:33

Class MicrophoneStream

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MicrophoneStream

Properties

_filters

_position

Protected_routeTarget

Protected_sends

_stereoPan

_threeDOptions

_volume

Protectedcontext

ProtectedglobalGainNode

playbacks

Accessors

cacophony

Returns Cacophony | undefined

filters

Returns BiquadFilterNode[]

isPlaying

Returns boolean

playbackRate

Returns number

Parameters

Returns void

position

Returns Position

Parameters

Returns void

stereoPan

Returns number

Parameters

Returns void

threeDOptions

Returns ThreeDOptions

Parameters

Returns void

volume

Returns number

Parameters

Returns void

Methods

_onBusDrained

Parameters

Returns void

Protected_preparePlayback

Parameters

Returns void

_resolveRouteTargetNode

Returns GainNode

Protected_wireRouteSends

Parameters

Returns void

addEffect

Parameters

Returns void

addFilter

Parameters

Returns void

Throws

addFilters

Parameters

Returns void

cleanup

Returns void

fadeIn

Parameters

Returns Promise<void>

fadeOut

Parameters

Returns Promise<void>

fadeTo

`Protected`_routeTarget

`Protected`_sends

`Protected`context

`Protected`globalGainNode

`Protected`_preparePlayback

`Protected`_wireRouteSends

`Static`request