Class AliRtcPlugin`Abstract`

Hierarchy

EventEmitter<AliRtcPluginListener>
- AliRtcPlugin

Index

Constructors

Properties

lastInputAudioTrack? lastInputVideoTrack? lastOutputAudioTrack? lastOutputVideoTrack? name options streamType trackType type zIndex

Accessors

initOptions isEnable

Methods

clear disable enable execute getOptions init isSupported process setOptions shouldUpdate

Constructors

constructor

new AliRtcPlugin(name, streamType?, trackType?): AliRtcPlugin
Parameters
- name: string
- streamType: AliRtcRawDataStreamType = AliRtcRawDataStreamType.AliRtcSdkStreamTypeCapture
- trackType: AliRtcPluginTrackType = AliRtcPluginTrackType.VIDEO
Returns AliRtcPlugin
Overrides EventEmitter<AliRtcPluginListener>.constructor

Properties

`Optional` lastInputAudioTrack

lastInputAudioTrack?: MediaStreamTrack

`Optional` lastInputVideoTrack

lastInputVideoTrack?: MediaStreamTrack

`Optional` lastOutputAudioTrack

lastOutputAudioTrack?: MediaStreamTrack

`Optional` lastOutputVideoTrack

lastOutputVideoTrack?: MediaStreamTrack

name

name: string

options

options: any

streamType

streamType: AliRtcRawDataStreamType

trackType

trackType: AliRtcPluginTrackType

type

type: AliRtcPluginType = AliRtcPluginType.PRE_PROCESSER

zIndex

zIndex: number = 1

Accessors

initOptions

get initOptions(): {}
Returns {}

isEnable

get isEnable(): boolean
Returns boolean

Methods

clear

clear(_streamInfo?): void
Parameters
- Optional _streamInfo: LocalStreamInfo
Returns void

disable

disable(): void
Returns void

enable

enable(): void
Returns void

execute

execute(streamInfo, streamInfos): Promise<void>
Parameters
- streamInfo: LocalStreamInfo
- streamInfos: LocalStreamInfo[]
Returns Promise<void>

getOptions

getOptions(): any
Returns any

init

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

`Abstract` isSupported

isSupported(version): boolean
Parameters
- version: string
Returns boolean

`Abstract` process

process(streamInfo, streamInfos): Promise<void>
Parameters
- streamInfo: LocalStreamInfo
- streamInfos: LocalStreamInfo[]
Returns Promise<void>

`Abstract` setOptions

setOptions(options): void
Parameters
- options: any
Returns void

`Abstract` shouldUpdate

shouldUpdate(streamInfo, streamInfos): boolean
Parameters
- streamInfo: LocalStreamInfo
- streamInfos: LocalStreamInfo[]
Returns boolean