Class RtcChannelAdapterBase

Hierarchy

AGEventEmitter
- RtcChannelAdapterBase
  - RtcChannelAdapterElectron
  - RtcChannelAdapterWeb

Constructors

constructor

new RtcChannelAdapterBase(): RtcChannelAdapterBase

Inherited from AGEventEmitter.constructor
Returns RtcChannelAdapterBase

Methods

emit

emit(evt: string, ...args: any[]): RtcChannelAdapterBase

Inherited from AGEventEmitter.emit
Parameters
- evt: string
- Rest ...args: any[]
Returns RtcChannelAdapterBase

Abstract enableDualStream

enableDualStream(enable: boolean, connectionType?: AGRtcConnectionType): Promise<void>

Parameters
- enable: boolean
- Optional connectionType: AGRtcConnectionType
Returns Promise<void>

Abstract getCurrentFrameData

getCurrentFrameData(streamUuid: string): ImageData

Parameters
- streamUuid: string
Returns ImageData

Abstract getSessionId

getSessionId(): string

Returns string

Abstract join

join(token: string, streamUuid: string, connectionType: AGRtcConnectionType): Promise<void>

Parameters
- token: string
- streamUuid: string
- connectionType: AGRtcConnectionType
Returns Promise<void>

Abstract leave

leave(connectionType?: AGRtcConnectionType): Promise<void>

Parameters
- Optional connectionType: AGRtcConnectionType
Returns Promise<void>

Abstract muteLocalAudio

muteLocalAudio(mute: boolean, connectionType: AGRtcConnectionType): number

Parameters
- mute: boolean
- connectionType: AGRtcConnectionType
Returns number

Abstract muteLocalScreenShare

muteLocalScreenShare(mute: boolean, connectionType: AGRtcConnectionType): number

Parameters
- mute: boolean
- connectionType: AGRtcConnectionType
Returns number

Abstract muteLocalVideo

muteLocalVideo(mute: boolean, connectionType: AGRtcConnectionType): number

Parameters
- mute: boolean
- connectionType: AGRtcConnectionType
Returns number

Abstract muteRemoteAudio

muteRemoteAudio(streamUuid: string, mute: boolean): number

Parameters
- streamUuid: string
- mute: boolean
Returns number

Abstract muteRemoteVideo

muteRemoteVideo(streamUuid: string, mute: boolean): number

Parameters
- streamUuid: string
- mute: boolean
Returns number

Abstract muteRemoteVideoMass

muteRemoteVideoMass(streamUuid: string[], mute: boolean): Promise<string[]>

Parameters
- streamUuid: string[]
- mute: boolean
Returns Promise<string[]>

off

off(evt: string, cb: CallableFunction): RtcChannelAdapterBase

Inherited from AGEventEmitter.off
Parameters
- evt: string
- cb: CallableFunction
Returns RtcChannelAdapterBase

on

on(evt: string, cb: CallableFunction): RtcChannelAdapterBase

Inherited from AGEventEmitter.on
Parameters
- evt: string
- cb: CallableFunction
Returns RtcChannelAdapterBase

Abstract onAudioVolumeIndication

onAudioVolumeIndication(cb: (volumes: Map<string, number>) => void): number

Parameters
- cb: (volumes: Map<string, number>) => void
  - - (volumes: Map<string, number>): void
    - Parameters
      - volumes: Map<string, number>
      Returns void
Returns number

Abstract onConnectedThroughCloudProxy

onConnectedThroughCloudProxy(cb: (connectionType: AGRtcConnectionType) => void): number

Parameters
- cb: (connectionType: AGRtcConnectionType) => void
  - - (connectionType: AGRtcConnectionType): void
    - Parameters
      - connectionType: AGRtcConnectionType
      Returns void
Returns number

Abstract onConnectionStateChanged

onConnectionStateChanged(cb: (state: AGRtcState, connectionType: AGRtcConnectionType) => void): number

Parameters
- cb: (state: AGRtcState, connectionType: AGRtcConnectionType) => void
  - - (state: AGRtcState, connectionType: AGRtcConnectionType): void
    - Parameters
      - state: AGRtcState
      - connectionType: AGRtcConnectionType
      Returns void
Returns number

Abstract onNetworkStats

onNetworkStats(cb: (stats: AGNetworkStats) => void): number

Parameters
- cb: (stats: AGNetworkStats) => void
  - - (stats: AGNetworkStats): void
    - Parameters
      - stats: AGNetworkStats
      Returns void
Returns number

Abstract onPublishedThroughCloudProxy

onPublishedThroughCloudProxy(cb: (connectionType: AGRtcConnectionType, isUsingCloudProxy: boolean) => void): number

Parameters
- cb: (connectionType: AGRtcConnectionType, isUsingCloudProxy: boolean) => void
  - - (connectionType: AGRtcConnectionType, isUsingCloudProxy: boolean): void
    - Parameters
      - connectionType: AGRtcConnectionType
      - isUsingCloudProxy: boolean
      Returns void
Returns number

once

once(evt: string, cb: CallableFunction): RtcChannelAdapterBase

Inherited from AGEventEmitter.once
Parameters
- evt: string
- cb: CallableFunction
Returns RtcChannelAdapterBase

removeAllEventListeners

removeAllEventListeners(): void

Inherited from AGEventEmitter.removeAllEventListeners
Returns void

Abstract setCloudProxy

setCloudProxy(proxyType: AgoraCloudProxyType): number

Parameters
- proxyType: AgoraCloudProxyType
Returns number

Abstract setLatencyLevel

setLatencyLevel(level: AgoraLatencyLevel): void

Parameters
- level: AgoraLatencyLevel
Returns void

Abstract setLowStreamParameter

setLowStreamParameter(streamParameter: AGLowStreamParameter, connectionType?: AGRtcConnectionType): number

Parameters
- streamParameter: AGLowStreamParameter
- Optional connectionType: AGRtcConnectionType
Returns number

Abstract setRemoteTrackVolume

setRemoteTrackVolume(streamUuid: string, volume: number): number

Parameters
- streamUuid: string
- volume: number
Returns number

Abstract setRemoteVideoStreamType

setRemoteVideoStreamType(streamUuid: string, streamType: AGRemoteVideoStreamType, connectionType: AGRtcConnectionType): number

Parameters
- streamUuid: string
- streamType: AGRemoteVideoStreamType
- connectionType: AGRtcConnectionType
Returns number