LiveTranscriptionController | RingCentral Video Client SDK for Browser

Hierarchy

LiveTranscriptionEventEmitter
- LiveTranscriptionController

Index

Constructors

constructor

Events

Methods

Constructors

constructor

new LiveTranscriptionController(): LiveTranscriptionController

Inherited from LiveTranscriptionEventEmitter.constructor
Returns LiveTranscriptionController

Events

on

on(event: LIVE_TRANSCRIPTION_DATA_CHANGED, listener: ((transcript: ILiveTranscription, type: LiveTranscriptionDataType) => void)): any
on(event: LIVE_TRANSCRIPTION_GROUPED_DATA_CHANGED, listener: ((transcript: ILiveTranscription) => void)): any
on(event: LIVE_TRANSCRIPTION_SETTING_CHANGED, listener: ((settings: ILiveTranscriptionSettings) => void)): any
on(event: LIVE_TRANSCRIPTION_HISTORY_CHANGED, listener: ((histories: ILiveTranscription[]) => void)): any
on(event: LIVE_TRANSCRIPTION_GROUPED_HISTORY_CHANGED, listener: ((histories: ILiveTranscription[]) => void)): any
on(event: LIVE_TRANSCRIPTION_SUPPORTED_LANGUAGES, listener: ((languages: string[]) => void)): any
on(event: LIVE_TRANSCRIPTION_LANGUAGE_CHANGED, listener: ((language: string) => void)): any
on(event: LIVE_TRANSCRIPTION_SEARCH_CHANGED, listener: ((results: ILiveTranscriptionSearchResult[]) => void)): any

Inherited from LiveTranscriptionEventEmitter.on

Occurs when live transcriptions data changes

Parameters
- event: LIVE_TRANSCRIPTION_DATA_CHANGED
- listener: ((transcript: ILiveTranscription, type: LiveTranscriptionDataType) => void)
  - - (transcript: ILiveTranscription, type: LiveTranscriptionDataType): void
    - Parameters
      - transcript: ILiveTranscription
      - type: LiveTranscriptionDataType
      Returns void
Returns any
Occurs when live transcriptions grouped data changes

Parameters
- event: LIVE_TRANSCRIPTION_GROUPED_DATA_CHANGED
- listener: ((transcript: ILiveTranscription) => void)
  - - (transcript: ILiveTranscription): void
    - Parameters
      - transcript: ILiveTranscription
      Returns void
Returns any
Occurs when live transcriptions settings changes

Parameters
- event: LIVE_TRANSCRIPTION_SETTING_CHANGED
- listener: ((settings: ILiveTranscriptionSettings) => void)
  - - (settings: ILiveTranscriptionSettings): void
    - Parameters
      - settings: ILiveTranscriptionSettings
      Returns void
Returns any
Occurs when live transcriptions history changes

Parameters
- event: LIVE_TRANSCRIPTION_HISTORY_CHANGED
- listener: ((histories: ILiveTranscription[]) => void)
  - - (histories: ILiveTranscription[]): void
    - Parameters
      - histories: ILiveTranscription[]
      Returns void
Returns any
Occurs when live transcriptions grouped history changes

Parameters
- event: LIVE_TRANSCRIPTION_GROUPED_HISTORY_CHANGED
- listener: ((histories: ILiveTranscription[]) => void)
  - - (histories: ILiveTranscription[]): void
    - Parameters
      - histories: ILiveTranscription[]
      Returns void
Returns any
Occurs when get live transcriptions supported languages

Parameters
- event: LIVE_TRANSCRIPTION_SUPPORTED_LANGUAGES
- listener: ((languages: string[]) => void)
  - - (languages: string[]): void
    - Parameters
      - languages: string[]
      Returns void
Returns any
Occurs when live transcriptions active language changes

Parameters
- event: LIVE_TRANSCRIPTION_LANGUAGE_CHANGED
- listener: ((language: string) => void)
  - - (language: string): void
    - Parameters
      - language: string
      Returns void
Returns any
Occurs when live transcriptions search result returns

Parameters
- event: LIVE_TRANSCRIPTION_SEARCH_CHANGED
- listener: ((results: ILiveTranscriptionSearchResult[]) => void)
  - - (results: ILiveTranscriptionSearchResult[]): void
    - Parameters
      - results: ILiveTranscriptionSearchResult[]
      Returns void
Returns any

Methods

disableLiveTranscription

disableLiveTranscription(): ErrorCodeType

Disable the live transcription features in an active meeting

description
disable the live transcription feature

Returns ErrorCodeType
0 means the API call is valid or fails otherwise

enableLiveTranscription

enableLiveTranscription(timeout?: number): Promise<ErrorCodeType>

Enable the live transcription features in an active meeting

description
This method will enable the live transcription feature and init server connection.

Parameters
- timeout: number = DEFAULT_WEB_SOCKET_REQUEST_TIMEOUT_MS
  
  Timeout period for establishing connection with live transcription server.
Returns Promise<ErrorCodeType>
0 means the API call is valid or fails otherwise

getGroupedLiveTranscriptionHistory

getGroupedLiveTranscriptionHistory(): Promise<ErrorCodeType>

Send request to get grouped history recordings of live transcriptions

description
Triggers the LiveTranscriptionEvent.LIVE_TRANSCRIPTION_GROUPED_HISTORY_CHANGED event callback Attention: This "getGroupedLiveTranscriptionHistory" method is in beta version, server may not support it in some environment. In this case, this method will reject a ERR_LIVE_TRANSCRIPTION_GET_GROUPED_HISTORY_NOT_SUPPORTED error.

Returns Promise<ErrorCodeType>
0 means the API call is valid or fails otherwise

getLiveTranscriptionHistory

getLiveTranscriptionHistory(): ErrorCodeType

Send request to get history recordings of live transcriptions

description
Triggers the LiveTranscriptionEvent.LIVE_TRANSCRIPTION_HISTORY_CHANGED event callback

Returns ErrorCodeType
0 means the API call is valid or fails otherwise

getLiveTranscriptionSettings

getLiveTranscriptionSettings(): null | ILiveTranscriptionSettings

Return the settings of live transcriptions

Returns null | ILiveTranscriptionSettings
settings or null

getSupportLanguages

getSupportLanguages(): ErrorCodeType

Send a request to get supported languages of live transcriptions

description
Triggers the LiveTranscriptionEvent.LIVE_TRANSCRIPTION_SUPPORTED_LANGUAGES event callback

Returns ErrorCodeType
0 means the API call is valid or fails otherwise

off

off(eventName: LiveTranscriptionEvent, listener: TEventCB): void

Inherited from LiveTranscriptionEventEmitter.off

Removes the specified listener from the listener array for the event named eventName.

Parameters
- eventName: LiveTranscriptionEvent
- listener: TEventCB
Returns void

once

once(eventName: LiveTranscriptionEvent, listener: TEventCB): void

Inherited from LiveTranscriptionEventEmitter.once

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Parameters
- eventName: LiveTranscriptionEvent
- listener: TEventCB
Returns void

pauseLiveTranscription

pauseLiveTranscription(): ErrorCodeType

Pauses the live transcriptions in an active meeting

description
Triggers the LiveTranscriptionEvent.LIVE_TRANSCRIPTION_SETTING_CHANGED event callback

Returns ErrorCodeType
0 means the API call is valid or fails otherwise

search

search(phrase: string): ErrorCodeType

Send a request to search LT messages by the keywords

description
Triggers the LiveTranscriptionEvent.LIVE_TRANSCRIPTION_SEARCH_CHANGED event callback

Parameters
- phrase: string
  
  Search keyword.
Returns ErrorCodeType
0 means the API call is valid or fails otherwise

startLiveTranscription

startLiveTranscription(timeout?: number): Promise<ErrorCodeType>

Starts the live transcriptions in an active meeting

description
Triggers the LiveTranscriptionEvent.LIVE_TRANSCRIPTION_SETTING_CHANGED event callback

Parameters
- timeout: number = DEFAULT_WEB_SOCKET_REQUEST_TIMEOUT_MS
  
  Timeout period for establishing connection with live transcription server.
Returns Promise<ErrorCodeType>
0 means the API call is valid or fails otherwise

switchLanguage

switchLanguage(language: string): ErrorCodeType

Send a request to switch the active language

description
Triggers the LiveTranscriptionEvent.LIVE_TRANSCRIPTION_LANGUAGE_CHANGED event callback

Parameters
- language: string
Returns ErrorCodeType
0 means the API call is valid or fails otherwise

Hierarchy

Index

Constructors

Events

Methods

Constructors

constructor

Returns LiveTranscriptionController

Events

on

Parameters

event: LIVE_TRANSCRIPTION_DATA_CHANGED

listener: ((transcript: ILiveTranscription, type: LiveTranscriptionDataType) => void)

Parameters

transcript: ILiveTranscription

type: LiveTranscriptionDataType

Returns void

Returns any

Parameters

event: LIVE_TRANSCRIPTION_GROUPED_DATA_CHANGED

listener: ((transcript: ILiveTranscription) => void)

Parameters

transcript: ILiveTranscription

Returns void

Returns any

Parameters

event: LIVE_TRANSCRIPTION_SETTING_CHANGED

listener: ((settings: ILiveTranscriptionSettings) => void)

Parameters

settings: ILiveTranscriptionSettings

Returns void

Returns any

Parameters

event: LIVE_TRANSCRIPTION_HISTORY_CHANGED

listener: ((histories: ILiveTranscription[]) => void)

Parameters

histories: ILiveTranscription[]

Returns void

Returns any

Parameters

event: LIVE_TRANSCRIPTION_GROUPED_HISTORY_CHANGED

listener: ((histories: ILiveTranscription[]) => void)

Parameters

histories: ILiveTranscription[]

Returns void

Returns any

Parameters

event: LIVE_TRANSCRIPTION_SUPPORTED_LANGUAGES

listener: ((languages: string[]) => void)

Parameters

languages: string[]

Returns void

Returns any

Parameters

event: LIVE_TRANSCRIPTION_LANGUAGE_CHANGED

listener: ((language: string) => void)

Parameters

language: string

Returns void

Returns any

Parameters

event: LIVE_TRANSCRIPTION_SEARCH_CHANGED

listener: ((results: ILiveTranscriptionSearchResult[]) => void)

Parameters

results: ILiveTranscriptionSearchResult[]

Returns void

Returns any

Methods

disableLiveTranscription

Returns ErrorCodeType

enableLiveTranscription

Parameters

timeout: number = DEFAULT_WEB_SOCKET_REQUEST_TIMEOUT_MS

Returns Promise<ErrorCodeType>

getGroupedLiveTranscriptionHistory

Returns Promise<ErrorCodeType>

getLiveTranscriptionHistory

Returns ErrorCodeType

getLiveTranscriptionSettings

Returns null | ILiveTranscriptionSettings