CoreFunctions

Index

Properties

• content
• core

Methods

• addAudios
• addManagedCoreState
• addSubtitleToAudio
• clearCoreState
• createSequence
• deleteManagedCoreState
• fadeAudio
• finishItself
• getManagedCoreState
• hideSequence
• log
• pauseAudio
• playAudio
• reportProgress
• reportStuck
• reportUnstuck
• requireQueuedTask
• seekAudio
• setAudioTrack
• setManagedCoreStateTriggers
• showSequence
• startSequence
• stopAudio
• unblockContentSwitch
• unblockNextContentSetup
• updateAudioLoop
• updateAudioVolume
• updateContentState

Properties

content

content: ContentInstance

core

core: EpisodeCore<IDefaultAdditionalEnvVariable>

Methods

addAudios

• addAudios(specs: AddAudioRequest[]): Promise<void>

• Parameters

  • specs: AddAudioRequest[]

  Returns Promise<void>

addManagedCoreState

• addManagedCoreState(state: ManagedCoreState<unknown>): void

• Parameters

  • state: ManagedCoreState<unknown>

  Returns void

addSubtitleToAudio

• addSubtitleToAudio(subtitles: AdditionalSubtitleDefine[]): void

• Parameters

  • subtitles: AdditionalSubtitleDefine[]

  Returns void

clearCoreState

• clearCoreState(): void

• Returns void

createSequence

• createSequence(id: string, assets: IAssetForClient[]): Promise<void>

• Parameters

  • id: string

  • assets: IAssetForClient[]

  Returns Promise<void>

deleteManagedCoreState

• deleteManagedCoreState(state: ManagedCoreState<unknown>): void

• Parameters

  • state: ManagedCoreState<unknown>

  Returns void

fadeAudio

• fadeAudio(id: string, startVolume: number, endVolume: number, duration: number): void

• Parameters

  • id: string

  • startVolume: number

  • endVolume: number

  • duration: number

  Returns void

finishItself

• finishItself(): void

• Returns void

getManagedCoreState

• getManagedCoreState(): Set<ManagedCoreState<unknown>>

• Returns Set<ManagedCoreState<unknown>>

hideSequence

• hideSequence(id: string): void

• Parameters

  • id: string

  Returns void

log

• log(...x: unknown[]): void

• Parameters

  • rest...x: unknown[]

  Returns void

pauseAudio

• pauseAudio(id: string): void

• Parameters

  • id: string

  Returns void

playAudio

• playAudio(id: string, resetProgress?: boolean): void

• Parameters

  • id: string

  • optionalresetProgress: boolean

  Returns void

reportProgress

• reportProgress(progress: number, time?: number): void

• Parameters

  • progress: number

  • optionaltime: number

  Returns void

reportStuck

• reportStuck(time?: number): void

• Parameters

  • optionaltime: number

  Returns void

reportUnstuck

• reportUnstuck(time?: number): void

• Parameters

  • optionaltime: number

  Returns void

requireQueuedTask

• requireQueuedTask(id: string, instanceId: string): void

• Parameters

  • id: string

  • instanceId: string

  Returns void

seekAudio

• seekAudio(id: string, time?: number): number

• Parameters

  • id: string

  • optionaltime: number

  Returns number

setAudioTrack

• setAudioTrack(init: Promise<AudioElementInit>): void

• Parameters

  • init: Promise<AudioElementInit>

  Returns void

setManagedCoreStateTriggers

• setManagedCoreStateTriggers(triggers: ManagerCoreStateTrigger<unknown>[]): void

• Parameters

  • triggers: ManagerCoreStateTrigger<unknown>[]

  Returns void

showSequence

• showSequence(id: string): void

• Parameters

  • id: string

  Returns void

startSequence

• startSequence(id: string): void

• Parameters

  • id: string

  Returns void

stopAudio

• stopAudio(id: string): void

• Parameters

  • id: string

  Returns void

unblockContentSwitch

• unblockContentSwitch(): void

• Unblock showing of the new asset instance and hiding of the old asset instance, aka the content switch or the showing

  ---

  Returns void

unblockNextContentSetup

• unblockNextContentSetup(): void

• Unblock creating and loading of the new asset instance, aka setup of next content or the preload

  ---

  Returns void

updateAudioLoop

• updateAudioLoop(id: string, loop?: boolean): boolean

• Parameters

  • id: string

  • optionalloop: boolean

  Returns boolean

updateAudioVolume

• updateAudioVolume(id: string, volume?: number): number

• Parameters

  • id: string

  • optionalvolume: number

  Returns number

updateContentState

• updateContentState(state: ContentState): void

• Parameters

  • state: ContentState

  Returns void