Class MemoryRenderer

Hierarchy (View Summary)

BaseRenderer
- MemoryRenderer

Constructors

constructor

new MemoryRenderer(info: RendererInfo, autoRolloff?: boolean): MemoryRenderer
Parameters
- info: RendererInfo
- autoRolloff: boolean = true
Returns MemoryRenderer
Overrides BaseRenderer.constructor
- Defined in renderers/MemoryRenderer.ts:34

Properties

`Protected` `Readonly`autoRolloff

autoRolloff: boolean = true

`Protected`contentCache

contentCache: ContentCache = ...

`Protected`dequeuedScores

dequeuedScores: { id: string; rolloff: boolean }[] = []

`Protected`dnodes

dnodes: SPDestinationNode[] = []

`Protected`effects

effects: QueuedEffect<Mutation>[] = []

`Protected`enqueuedScores

enqueuedScores: { destination: SPDestinationNode; rolloff: boolean }[] = []

`Readonly`info

info: RendererInfo

`Protected`playingState

playingState: PlayingState = PlayingState.STOPPED

`Protected`samplesElapsed

samplesElapsed: number = 0

`Static`DEFAULT_QUANTUM_SIZE

DEFAULT_QUANTUM_SIZE: number = 8192

Accessors

playing

get playing(): boolean
Returns boolean
Inherited from BaseRenderer.playing
- Defined in renderers/BaseRenderer.ts:412
set playing(state: boolean): void
Parameters
- state: boolean
Returns void
Inherited from BaseRenderer.playing
- Defined in renderers/BaseRenderer.ts:416

Methods

`Protected`ancestorsWithId

ancestorsWithId(nodeId: string): SPNode[]
Parameters
- nodeId: string
Returns SPNode[]
Inherited from BaseRenderer.ancestorsWithId
- Defined in renderers/BaseRenderer.ts:332

`Protected`commandsEffectTargets

commandsEffectTargets(payload: CommandsMutation): SPNode[]
Parameters
- payload: CommandsMutation
Returns SPNode[]
Inherited from BaseRenderer.commandsEffectTargets
- Defined in renderers/BaseRenderer.ts:340

dequeueScore

dequeueScore(graphId: string, rolloff?: boolean): Promise<void>
Parameters
- graphId: string
- rolloff: boolean = ...
Returns Promise<void>
Inherited from BaseRenderer.dequeueScore
- Defined in renderers/BaseRenderer.ts:175

dequeueScores

dequeueScores(): Promise<void[]>
Returns Promise<void[]>
Inherited from BaseRenderer.dequeueScores
- Defined in renderers/BaseRenderer.ts:257

enqueueEffect

enqueueEffect(effect: Mutation): Promise<void>
Parameters
- effect: Mutation
Returns Promise<void>
Inherited from BaseRenderer.enqueueEffect
- Defined in renderers/BaseRenderer.ts:314

enqueueScore

enqueueScore(score: Score, rolloff?: boolean): Promise<void>
Parameters
- score: Score
- rolloff: boolean = ...
Returns Promise<void>
Inherited from BaseRenderer.enqueueScore
- Defined in renderers/BaseRenderer.ts:149

getPlaybackDescription

getPlaybackDescription(renderTime: TimeInstant): NodePlaybackDescription[]
Parameters
- renderTime: TimeInstant
Returns NodePlaybackDescription[]
Inherited from BaseRenderer.getPlaybackDescription
- Defined in renderers/BaseRenderer.ts:278

getScore

getScore(graphId: string): DirectedScore | undefined
Parameters
- graphId: string
Returns DirectedScore | undefined
Inherited from BaseRenderer.getScore
- Defined in renderers/BaseRenderer.ts:264

getScores

getScores(): DirectedScore[]
Returns DirectedScore[]
Inherited from BaseRenderer.getScores
- Defined in renderers/BaseRenderer.ts:270

`Protected`processDequeuedScores

processDequeuedScores(): XAudioBuffer[] | undefined
Returns XAudioBuffer[] | undefined
Inherited from BaseRenderer.processDequeuedScores
- Defined in renderers/BaseRenderer.ts:219

`Protected`processEffect

processEffect(ee: QueuedEffect<Mutation>): void
Parameters
- ee: QueuedEffect<Mutation>
Returns void
Inherited from BaseRenderer.processEffect
- Defined in renderers/BaseRenderer.ts:382

`Protected`processEffects

processEffects(): void
Returns void
Inherited from BaseRenderer.processEffects
- Defined in renderers/BaseRenderer.ts:374

`Protected`processEnqueuedScores

processEnqueuedScores(): XAudioBuffer[] | undefined
Returns XAudioBuffer[] | undefined
Inherited from BaseRenderer.processEnqueuedScores
- Defined in renderers/BaseRenderer.ts:190

render

render(): XAudioBuffer | undefined
Render a single quantum of audio, and return the result. If the player is not playing, nothing will be rendered.

Returns XAudioBuffer | undefined
- Defined in renderers/MemoryRenderer.ts:90

renderDuration

renderDuration(sampleCount: number): XAudioBuffer
Render the specified duration, starting at current renderTime, into an XAudioBuffer. This could give more samples than expected if the quantumSize does not align with the specified sampleCount or duration!
Parameters
- sampleCount: number
Returns XAudioBuffer
- Defined in renderers/MemoryRenderer.ts:47
renderDuration(duration: TimeInstant): XAudioBuffer
Render the specified duration, starting at current renderTime, into an XAudioBuffer. This could give more samples than expected if the quantumSize does not align with the specified sampleCount or duration!
Parameters
- duration: TimeInstant
Returns XAudioBuffer
- Defined in renderers/MemoryRenderer.ts:48

renderedTime

renderedTime(): TimeInstant
Returns TimeInstant
Inherited from BaseRenderer.renderedTime
- Defined in renderers/BaseRenderer.ts:274

`Protected`renderQuantum

renderQuantum(): XAudioBuffer | undefined
Returns XAudioBuffer | undefined
Inherited from BaseRenderer.renderQuantum
- Defined in renderers/BaseRenderer.ts:102

timeChange

timeChange(renderTime: TimeInstant): Promise<void>
Parameters
- renderTime: TimeInstant
Returns Promise<void>
Inherited from BaseRenderer.timeChange
- Defined in renderers/BaseRenderer.ts:294

unsafelyReplaceContentCache

unsafelyReplaceContentCache(nextCache: ContentCache): Promise<void>
It is only "safe" to call this method if no audio is being rendered.
Parameters
- nextCache: ContentCache
Returns Promise<void>
Inherited from BaseRenderer.unsafelyReplaceContentCache
- Defined in renderers/BaseRenderer.ts:95

Class MemoryRenderer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MemoryRenderer

Properties

Protected ReadonlyautoRolloff

ProtectedcontentCache

ProtecteddequeuedScores

Protecteddnodes

Protectedeffects

ProtectedenqueuedScores

Readonlyinfo

ProtectedplayingState

ProtectedsamplesElapsed

StaticDEFAULT_QUANTUM_SIZE

Accessors

playing

Returns boolean

Parameters

Returns void

Methods

ProtectedancestorsWithId

Parameters

Returns SPNode[]

ProtectedcommandsEffectTargets

Parameters

Returns SPNode[]

dequeueScore

Parameters

Returns Promise<void>

dequeueScores

Returns Promise<void[]>

enqueueEffect

Parameters

Returns Promise<void>

enqueueScore

Parameters

Returns Promise<void>

getPlaybackDescription

Parameters

Returns NodePlaybackDescription[]

getScore

Parameters

Returns DirectedScore | undefined

getScores

Returns DirectedScore[]

ProtectedprocessDequeuedScores

Returns XAudioBuffer[] | undefined

ProtectedprocessEffect

Parameters

Returns void

ProtectedprocessEffects

Returns void

ProtectedprocessEnqueuedScores

Returns XAudioBuffer[] | undefined

render

Returns XAudioBuffer | undefined

renderDuration

Parameters

Returns XAudioBuffer

Parameters

Returns XAudioBuffer

renderedTime

Returns TimeInstant

ProtectedrenderQuantum

Returns XAudioBuffer | undefined

timeChange

Parameters

Returns Promise<void>

unsafelyReplaceContentCache

Parameters

Returns Promise<void>

Settings

`Protected` `Readonly`autoRolloff

`Protected`contentCache

`Protected`dequeuedScores

`Protected`dnodes

`Protected`effects

`Protected`enqueuedScores

`Readonly`info

`Protected`playingState

`Protected`samplesElapsed

`Static`DEFAULT_QUANTUM_SIZE

`Protected`ancestorsWithId

`Protected`commandsEffectTargets

`Protected`processDequeuedScores

`Protected`processEffect

`Protected`processEffects

`Protected`processEnqueuedScores

`Protected`renderQuantum