MediaManager | mmir Tools and Plugins v7.0.0-beta1

Hierarchy

MediaManager

Index

Properties

_addListenerObserver

_addListenerObserver: (eventName: MediaEventType, observerCallback: (actionType: "added" | "removed", eventHandler: MediaEventHandler) => void) => void

Type declaration

- (eventName: MediaEventType, observerCallback: (actionType: "added" | "removed", eventHandler: MediaEventHandler) => void): void
- Parameters
  - eventName: MediaEventType
  - observerCallback: (actionType: "added" | "removed", eventHandler: MediaEventHandler) => void
    - - (actionType: "added" | "removed", eventHandler: MediaEventHandler): void
      - Parameters
        
        actionType: "added" | "removed"
        
        eventHandler: MediaEventHandler
        
        Returns void
  Returns void

_emitEvent

_emitEvent: (eventName: MediaEventType, ...args: any[]) => void

Type declaration

- (eventName: MediaEventType, ...args: any[]): void
- Parameters
  - eventName: MediaEventType
  - Rest ...args: any[]
  Returns void

_fireEvent

_fireEvent: (eventName: MediaEventType, args: any[]) => void

deprecated: use _emitEvent instead

Type declaration

- (eventName: MediaEventType, args: any[]): void
- Parameters
  - eventName: MediaEventType
  - args: any[]
  Returns void

_notifyObservers

_notifyObservers: (eventName: MediaEventType, actionType: "added" | "removed", eventHandler: MediaEventHandler) => void

Type declaration

- (eventName: MediaEventType, actionType: "added" | "removed", eventHandler: MediaEventHandler): void
- Parameters
  - eventName: MediaEventType
  - actionType: "added" | "removed"
  - eventHandler: MediaEventHandler
  Returns void

_preparing

_preparing: (moduleName: string) => void

Type declaration

- (moduleName: string): void
- Parameters
  - moduleName: string
  Returns void

_ready

_ready: (moduleName: string) => void

Type declaration

- (moduleName: string): void
- Parameters
  - moduleName: string
  Returns void

_removeListenerObserver

_removeListenerObserver: (eventName: MediaEventType, observerCallback: (actionType: "added" | "removed", eventHandler: MediaEventHandler) => void) => void

Type declaration

- (eventName: MediaEventType, observerCallback: (actionType: "added" | "removed", eventHandler: MediaEventHandler) => void): void
- Parameters
  - eventName: MediaEventType
  - observerCallback: (actionType: "added" | "removed", eventHandler: MediaEventHandler) => void
    - - (actionType: "added" | "removed", eventHandler: MediaEventHandler): void
      - Parameters
        
        actionType: "added" | "removed"
        
        eventHandler: MediaEventHandler
        
        Returns void
  Returns void

addListener

addListener: (eventName: MediaEventType, eventHandler: MediaEventHandler) => void

Type declaration

- (eventName: MediaEventType, eventHandler: MediaEventHandler): void
- Parameters
  - eventName: MediaEventType
  - eventHandler: MediaEventHandler
  Returns void

cancelRecognition

cancelRecognition: (successCallback?: Function, failureCallback?: Function) => void

Type declaration

- (successCallback?: Function, failureCallback?: Function): void
- Parameters
  - Optional successCallback: Function
  - Optional failureCallback: Function
  Returns void

cancelSpeech

cancelSpeech: (successCallBack?: Function, failureCallBack?: Function) => void

Type declaration

- (successCallBack?: Function, failureCallBack?: Function): void
- Parameters
  - Optional successCallBack: Function
  - Optional failureCallBack: Function
  Returns void

createEmptyAudio

createEmptyAudio: () => IAudio

Type declaration

- (): IAudio
- Returns IAudio

ctx

ctx: {}

Type declaration

[ctxId: string]: any

destroyRecognition

destroyRecognition: (successCallback?: (didDestroy: boolean) => void, failureCallback?: Function) => void

Type declaration

- (successCallback?: (didDestroy: boolean) => void, failureCallback?: Function): void
- Parameters
  - Optional successCallback: (didDestroy: boolean) => void
    - - (didDestroy: boolean): void
      - Parameters
        
        didDestroy: boolean
        
        Returns void
  - Optional failureCallback: Function
  Returns void

destroySpeech

destroySpeech: (successCallback?: (didDestroy: boolean) => void, failureCallback?: Function) => void

Type declaration

- (successCallback?: (didDestroy: boolean) => void, failureCallback?: Function): void
- Parameters
  - Optional successCallback: (didDestroy: boolean) => void
    - - (didDestroy: boolean): void
      - Parameters
        
        didDestroy: boolean
        
        Returns void
  - Optional failureCallback: Function
  Returns void

getFunc

getFunc: (ctx: string, funcName: string) => any

Type declaration

- (ctx: string, funcName: string): any
- Parameters
  - ctx: string
  - funcName: string
  Returns any

getListeners

getListeners: (eventName: MediaEventType) => MediaEventHandler | void

Type declaration

- (eventName: MediaEventType): MediaEventHandler | void
- Parameters
  - eventName: MediaEventType
  Returns MediaEventHandler | void

getRecognitionLanguages

getRecognitionLanguages: ListLanguagesFunction

getSpeechLanguages

getSpeechLanguages: ListLanguagesFunction

getURLAsAudio

getURLAsAudio: (url: string, onEnd: any, failureCallback: any, successCallback: any, audioObj: IAudio, ...args: any[]) => IAudio

Type declaration

- (url: string, onEnd: any, failureCallback: any, successCallback: any, audioObj: IAudio, ...args: any[]): IAudio
- Parameters
  - url: string
  - onEnd: any
  - failureCallback: any
  - successCallback: any
  - audioObj: IAudio
  - Rest ...args: any[]
  Returns IAudio

getVoices

getVoices: ListVoicesFunction

getWAVAsAudio

getWAVAsAudio: (blob: any, callback: any, onEnd: any, failureCallback: any, onInit: any, emptyAudioObj: IAudio) => IAudio

Type declaration

- (blob: any, callback: any, onEnd: any, failureCallback: any, onInit: any, emptyAudioObj: IAudio): IAudio
- Parameters
  - blob: any
  - callback: any
  - onEnd: any
  - failureCallback: any
  - onInit: any
  - emptyAudioObj: IAudio
  Returns IAudio

hasListeners

hasListeners: (eventName: MediaEventType) => boolean

Type declaration

- (eventName: MediaEventType): boolean
- Parameters
  - eventName: MediaEventType
  Returns boolean

init

init: (successCallback?: Function, failureCallback?: Function, listenerList?: { listener: Function; name: string }[]) => any

Type declaration

- (successCallback?: Function, failureCallback?: Function, listenerList?: { listener: Function; name: string }[]): any
- Parameters
  - Optional successCallback: Function
  - Optional failureCallback: Function
  - Optional listenerList: { listener: Function; name: string }[]
  Returns any

initializeRecognition

initializeRecognition: (successCallback?: (didInitialize: boolean) => void, failureCallback?: Function) => void

Type declaration

- (successCallback?: (didInitialize: boolean) => void, failureCallback?: Function): void
- Parameters
  - Optional successCallback: (didInitialize: boolean) => void
    - - (didInitialize: boolean): void
      - Parameters
        
        didInitialize: boolean
        
        Returns void
  - Optional failureCallback: Function
  Returns void

initializeSpeech

initializeSpeech: (successCallback?: (didInitialize: boolean) => void, failureCallback?: Function) => void

Type declaration

- (successCallback?: (didInitialize: boolean) => void, failureCallback?: Function): void
- Parameters
  - Optional successCallback: (didInitialize: boolean) => void
    - - (didInitialize: boolean): void
      - Parameters
        
        didInitialize: boolean
        
        Returns void
  - Optional failureCallback: Function
  Returns void

loadFile

loadFile: (filePath: string, successCallback?: Function, failureCallback?: Function, execId?: string, config?: any) => void

Type declaration

- (filePath: string, successCallback?: Function, failureCallback?: Function, execId?: string, config?: any): void
- Parameters
  - filePath: string
  - Optional successCallback: Function
  - Optional failureCallback: Function
  - Optional execId: string
  - Optional config: any
  Returns void

off

off: (eventName: MediaEventType, eventHandler: MediaEventHandler) => boolean

Type declaration

- (eventName: MediaEventType, eventHandler: MediaEventHandler): boolean
- Parameters
  - eventName: MediaEventType
  - eventHandler: MediaEventHandler
  Returns boolean

on

on: (eventName: MediaEventType, eventHandler: MediaEventHandler) => void

Type declaration

- (eventName: MediaEventType, eventHandler: MediaEventHandler): void
- Parameters
  - eventName: MediaEventType
  - eventHandler: MediaEventHandler
  Returns void

perform

perform: (ctx: string, funcName: string, args?: any[]) => any

Type declaration

- (ctx: string, funcName: string, args?: any[]): any
- Parameters
  - ctx: string
  - funcName: string
  - Optional args: any[]
  Returns any

playURL

playURL: (url: string, onEnd?: TTSOnComplete, failureCallback?: TTSOnError, onReady?: Function) => void

Type declaration

- (url: string, onEnd?: TTSOnComplete, failureCallback?: TTSOnError, onReady?: Function): void
- Parameters
  - url: string
  - Optional onEnd: TTSOnComplete
  - Optional failureCallback: TTSOnError
  - Optional onReady: Function
  Returns void

playWAV

playWAV: (blob: any, onEnd?: TTSOnComplete, failureCallback?: TTSOnError, onReady?: Function) => void

Type declaration

- (blob: any, onEnd?: TTSOnComplete, failureCallback?: TTSOnError, onReady?: Function): void
- Parameters
  - blob: any
  - Optional onEnd: TTSOnComplete
  - Optional failureCallback: TTSOnError
  - Optional onReady: Function
  Returns void

plugins

plugins: Array<MediaManagerPluginEntry & { disabled?: true | DisabledPluginInfo }> | null

recognize

recognize: (options?: ASROptions, statusCallback?: ASROnStatus, failureCallback?: ASROnError, isIntermediateResults?: boolean) => void

Type declaration

- (options?: ASROptions, statusCallback?: ASROnStatus, failureCallback?: ASROnError, isIntermediateResults?: boolean): void
- Parameters
  - Optional options: ASROptions
  - Optional statusCallback: ASROnStatus
  - Optional failureCallback: ASROnError
  - Optional isIntermediateResults: boolean
  Returns void

removeListener

removeListener: (eventName: MediaEventType, eventHandler: MediaEventHandler) => boolean

Type declaration

- (eventName: MediaEventType, eventHandler: MediaEventHandler): boolean
- Parameters
  - eventName: MediaEventType
  - eventHandler: MediaEventHandler
  Returns boolean

setDefaultCtx

setDefaultCtx: (ctxId: string) => void

Type declaration

- (ctxId: string): void
- Parameters
  - ctxId: string
  Returns void

setTextToSpeechVolume

setTextToSpeechVolume: (newValue: number) => void

Type declaration

- (newValue: number): void
- Parameters
  - newValue: number
  Returns void

startRecord

startRecord: (options?: ASROptions, successCallback?: ASROnStatus, failureCallback?: ASROnError, intermediateResults?: boolean) => void

Type declaration

- (options?: ASROptions, successCallback?: ASROnStatus, failureCallback?: ASROnError, intermediateResults?: boolean): void
- Parameters
  - Optional options: ASROptions
  - Optional successCallback: ASROnStatus
  - Optional failureCallback: ASROnError
  - Optional intermediateResults: boolean
  Returns void

stopRecord

stopRecord: (options?: ASROptions, successCallback?: ASROnStatus, failureCallback?: ASROnError) => void

Type declaration

- (options?: ASROptions, successCallback?: ASROnStatus, failureCallback?: ASROnError): void
- Parameters
  - Optional options: ASROptions
  - Optional successCallback: ASROnStatus
  - Optional failureCallback: ASROnError
  Returns void

tts

tts: (options: string | string[] | TTSOptions, successCallback?: TTSOnComplete, failureCallback?: TTSOnError, onInit?: TTSOnReady, ...args: any[]) => void

Type declaration

- (options: string | string[] | TTSOptions, successCallback?: TTSOnComplete, failureCallback?: TTSOnError, onInit?: TTSOnReady, ...args: any[]): void
- Parameters
  - options: string | string[] | TTSOptions
  - Optional successCallback: TTSOnComplete
  - Optional failureCallback: TTSOnError
  - Optional onInit: TTSOnReady
  - Rest ...args: any[]
  Returns void

waitReadyImpl

waitReadyImpl: IWaitReadyImpl

Hierarchy

Index

Properties

Properties

_addListenerObserver

Type declaration

Parameters

eventName: MediaEventType

observerCallback: (actionType: "added" | "removed", eventHandler: MediaEventHandler) => void

Parameters

actionType: "added" | "removed"

eventHandler: MediaEventHandler

Returns void

Returns void

_emitEvent

Type declaration

Parameters

eventName: MediaEventType

Rest ...args: any[]

Returns void

_fireEvent

Type declaration

Parameters

eventName: MediaEventType

args: any[]

Returns void

_notifyObservers

Type declaration

Parameters

eventName: MediaEventType

actionType: "added" | "removed"

eventHandler: MediaEventHandler

Returns void

_preparing

Type declaration

Parameters

moduleName: string

Returns void

_ready

Type declaration

Parameters

moduleName: string

Returns void

_removeListenerObserver

Type declaration

Parameters

eventName: MediaEventType

observerCallback: (actionType: "added" | "removed", eventHandler: MediaEventHandler) => void

Parameters

actionType: "added" | "removed"

eventHandler: MediaEventHandler

Returns void

Returns void

addListener

Type declaration

Parameters

eventName: MediaEventType

eventHandler: MediaEventHandler

Returns void

cancelRecognition

Type declaration

Parameters

Optional successCallback: Function

Optional failureCallback: Function

Returns void

cancelSpeech

Type declaration

Parameters

Optional successCallBack: Function

Optional failureCallBack: Function

Returns void

createEmptyAudio

Type declaration

Returns IAudio

ctx

Type declaration

[ctxId: string]: any

destroyRecognition

Type declaration

Parameters