Class CloudAvatar

云端渲染数字人

Hierarchy (view full)

RtcAvatar
- CloudAvatar

Constructors

constructor

new CloudAvatar(authParams, requestConfig?): CloudAvatar
Parameters
- authParams: TYRTCAuthParams | AxiosRequestConfig<any>
- OptionalrequestConfig: TYRequestConfig
Returns CloudAvatar
Overrides RtcAvatar.constructor

Properties

`Protected` `Optional`_authParams

_authParams?: TYRTCAuthParams

`Protected`_curDialogId

_curDialogId: string = ''

`Protected`_curState

_curState: TYVoiceChatState = TYVoiceChatState.Idle

`Protected` `Optional`_initializeData

_initializeData?: IAvatarResponseData

`Protected` `Optional`_isReadyTimer

_isReadyTimer?: Timeout

`Protected`_localMicMuted

_localMicMuted: boolean = false

`Protected`_requestConfig

_requestConfig: TYRequestConfig = ...

`Protected`_requestId

_requestId: string = ''

`Protected`_rtc

_rtc: Rtc = ...

`Static`prefixed

prefixed: string | boolean

Methods

`Protected`_dataChannelMsgHandler

_dataChannelMsgHandler(uid, msg): any
Parameters
- uid: string
- msg: {
  data: ArrayBuffer;
  }
  - data: ArrayBuffer
Returns any
Inherited from RtcAvatar._dataChannelMsgHandler

`Protected`_dataPublishStateChangedHandler

_dataPublishStateChangedHandler(oldState, newState): void
Parameters
- oldState: AliRtcPublishState
- newState: AliRtcPublishState
Returns void
Inherited from RtcAvatar._dataPublishStateChangedHandler

`Protected`_dialogStateChangedHandler

_dialogStateChangedHandler(payload): void
Parameters
- payload: IPayload
Returns void
Inherited from RtcAvatar._dialogStateChangedHandler

`Protected`_getInitializeData

_getInitializeData(): Promise<undefined | IAvatarResponseData>
Returns Promise<undefined | IAvatarResponseData>
Inherited from RtcAvatar._getInitializeData

`Protected`_readyHandler

_readyHandler(): void
Returns void
Inherited from RtcAvatar._readyHandler

`Protected`_respondingEnded

_respondingEnded(payload): void
Parameters
- payload: IPayload
Returns void
Inherited from RtcAvatar._respondingEnded

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends PlayerEventTypes | EventTypes | ProcessorEventTypes
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from RtcAvatar.addListener

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends PlayerEventTypes | EventTypes | ProcessorEventTypes
Parameters
- event: T
- Rest...args: any[]
Returns boolean
Inherited from RtcAvatar.emit

eventNames

eventNames(): (PlayerEventTypes | EventTypes | ProcessorEventTypes)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (PlayerEventTypes | EventTypes | ProcessorEventTypes)[]
Inherited from RtcAvatar.eventNames

exit

exit(): void
Returns void
Overrides RtcAvatar.exit

interrupt

interrupt(): void
Returns void
Inherited from RtcAvatar.interrupt

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: PlayerEventTypes | EventTypes | ProcessorEventTypes
Returns number
Inherited from RtcAvatar.listenerCount

listeners

listeners<T>(event): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends PlayerEventTypes | EventTypes | ProcessorEventTypes
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from RtcAvatar.listeners

muteLocalMic

muteLocalMic(mute): void
Parameters
- mute: boolean
Returns void
Inherited from RtcAvatar.muteLocalMic

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends PlayerEventTypes | EventTypes | ProcessorEventTypes
Parameters
- event: T
- Optionalfn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from RtcAvatar.off

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends PlayerEventTypes | EventTypes | ProcessorEventTypes
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from RtcAvatar.on

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends PlayerEventTypes | EventTypes | ProcessorEventTypes
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from RtcAvatar.once

onChatTimerChanged

onChatTimerChanged(func): void
Parameters
- func: ((time: number) => void)
  - - (time): void
    - Parameters
      time: number
      Returns void
Returns void
Inherited from RtcAvatar.onChatTimerChanged

onErrorReceived

onErrorReceived(func): void
Parameters
- func: ((err: TYError) => void)
  - - (err): void
    - Parameters
      err: TYError
      Returns void
Returns void
Inherited from RtcAvatar.onErrorReceived

onFirstFrameReceived

onFirstFrameReceived(func): void
Parameters
- func: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from RtcAvatar.onFirstFrameReceived

onMessageReceived

onMessageReceived(func): void
Parameters
- func: ((msg: TYVoiceChatMessage) => void)
  - - (msg): void
    - Parameters
      msg: TYVoiceChatMessage
      Returns void
Returns void
Inherited from RtcAvatar.onMessageReceived

onReadyToSpeech

onReadyToSpeech(func): void
Parameters
- func: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from RtcAvatar.onReadyToSpeech

onStateChanged

onStateChanged(func): void
Parameters
- func: ((state: TYVoiceChatState) => void)
  - - (state): void
    - Parameters
      state: TYVoiceChatState
      Returns void
Returns void
Inherited from RtcAvatar.onStateChanged

onVolumeChanged

onVolumeChanged(func): void
Parameters
- func: ((data: TYVolume) => void)
  - - (data): void
    - Parameters
      data: TYVolume
      Returns void
Returns void
Inherited from RtcAvatar.onVolumeChanged

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: PlayerEventTypes | EventTypes | ProcessorEventTypes
Returns this
Inherited from RtcAvatar.removeAllListeners

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends PlayerEventTypes | EventTypes | ProcessorEventTypes
Parameters
- event: T
- Optionalfn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from RtcAvatar.removeListener

requestToRespond

requestToRespond(type, text): void
Parameters
- type: IRequestToRespondType
- text: string
Returns void
Inherited from RtcAvatar.requestToRespond

sendSpeech

sendSpeech(): void
Returns void
Inherited from RtcAvatar.sendSpeech

setLogLevel

setLogLevel(level): void
Parameters
- level: LogLevelDesc
Returns void
Inherited from RtcAvatar.setLogLevel

setupRTCView

setupRTCView(rootContainer): void
Parameters
- rootContainer: string | HTMLVideoElement
Returns void

start

start(): Promise<void>
Returns Promise<void>

stopSpeech

stopSpeech(): void
Returns void
Inherited from RtcAvatar.stopSpeech

Class CloudAvatar

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CloudAvatar

Properties

Protected Optional_authParams

Protected_curDialogId

Protected_curState

Protected Optional_initializeData

Protected Optional_isReadyTimer

Protected_localMicMuted

Protected_requestConfig

Protected_requestId

Protected_rtc

Staticprefixed

Methods

Protected_dataChannelMsgHandler

Parameters

data: ArrayBuffer

Returns any

Protected_dataPublishStateChangedHandler

Parameters

Returns void

Protected_dialogStateChangedHandler

Parameters

Returns void

Protected_getInitializeData

Returns Promise<undefined | IAvatarResponseData>

Protected_readyHandler

Returns void

Protected_respondingEnded

Parameters

Returns void

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (PlayerEventTypes | EventTypes | ProcessorEventTypes)[]

exit

Returns void

interrupt

Returns void

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => void)[]

muteLocalMic

Parameters

Returns void

off

Type Parameters

Parameters

Parameters

Returns void

Returns this

on

Type Parameters

Parameters

Parameters

Returns void

Returns this

once

Type Parameters

Parameters

`Protected` `Optional`_authParams

`Protected`_curDialogId

`Protected`_curState

`Protected` `Optional`_initializeData

`Protected` `Optional`_isReadyTimer

`Protected`_localMicMuted

`Protected`_requestConfig

`Protected`_requestId

`Protected`_rtc

`Static`prefixed

`Protected`_dataChannelMsgHandler

`Protected`_dataPublishStateChangedHandler

`Protected`_dialogStateChangedHandler

`Protected`_getInitializeData

`Protected`_readyHandler

`Protected`_respondingEnded