Class RtcChannelAdapterElectron

Hierarchy

RtcChannelAdapterBase
- RtcChannelAdapterElectron

Constructors

constructor

new RtcChannelAdapterElectron(channelName: string, configs: RtcAdapterElectronConfig, base: RtcAdapterBase): RtcChannelAdapterElectron

Overrides RtcChannelAdapterBase.constructor
Parameters
- channelName: string
- configs: RtcAdapterElectronConfig
- base: RtcAdapterBase
Returns RtcChannelAdapterElectron

Properties

base

base: RtcAdapterElectron

channelName

channelName: string

logger

logger: "agora-rte-sdk/src/core/logger/type".Logger

Optional uid

uid?: number

Accessors

isLocalAudioMuted

get isLocalAudioMuted(): boolean

Returns boolean

isLocalVideoMuted

get isLocalVideoMuted(): boolean

Returns boolean

Methods

emit

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

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

enableDualStream

enableDualStream(enable: boolean): Promise<void>

Overrides RtcChannelAdapterBase.enableDualStream
Parameters
- enable: boolean
Returns Promise<void>

getCurrentFrameData

getCurrentFrameData(_streamUuid: string): ImageData

Overrides RtcChannelAdapterBase.getCurrentFrameData
Parameters
- _streamUuid: string
Returns ImageData

getSessionId

getSessionId(): string

Overrides RtcChannelAdapterBase.getSessionId
Returns string

join

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

Overrides RtcChannelAdapterBase.join
Parameters
- token: string
- streamUuid: string
- connectionType: AGRtcConnectionType
Returns Promise<void>

leave

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

Overrides RtcChannelAdapterBase.leave
Parameters
- Optional connectionType: AGRtcConnectionType
Returns Promise<void>

muteLocalAudio

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

Overrides RtcChannelAdapterBase.muteLocalAudio
Parameters
- mute: boolean
- connectionType: AGRtcConnectionType
Returns number

muteLocalAudioStream

muteLocalAudioStream(mute: boolean): number

Parameters
- mute: boolean
Returns number

muteLocalScreenShare

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

Overrides RtcChannelAdapterBase.muteLocalScreenShare
Parameters
- mute: boolean
- connectionType: AGRtcConnectionType
Returns number

muteLocalVideo

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

Overrides RtcChannelAdapterBase.muteLocalVideo
Parameters
- mute: boolean
- connectionType: AGRtcConnectionType
Returns number

muteLocalVideoStream

muteLocalVideoStream(mute: boolean): number

Parameters
- mute: boolean
Returns number

muteRemoteAudio

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

Overrides RtcChannelAdapterBase.muteRemoteAudio
Parameters
- streamUuid: string
- mute: boolean
Returns number

muteRemoteVideo

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

Overrides RtcChannelAdapterBase.muteRemoteVideo
Parameters
- streamUuid: string
- mute: boolean
Returns number

muteRemoteVideoMass

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

Overrides RtcChannelAdapterBase.muteRemoteVideoMass
Parameters
- streamUuids: string[]
- mute: boolean
Returns Promise<string[]>

off

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

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

on

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

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

onAudioVolumeIndication

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

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

onConnectedThroughCloudProxy

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

Overrides RtcChannelAdapterBase.onConnectedThroughCloudProxy
Parameters
- cb: (connectionType: AGRtcConnectionType) => void
  - - (connectionType: AGRtcConnectionType): void
    - Parameters
      - connectionType: AGRtcConnectionType
      Returns void
Returns number

onConnectionStateChanged

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

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

onNetworkStats

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

Overrides RtcChannelAdapterBase.onNetworkStats
Parameters
- cb: (stats: AGNetworkStats) => void
  - - (stats: AGNetworkStats): void
    - Parameters
      - stats: AGNetworkStats
      Returns void
Returns number

onPublishedThroughCloudProxy

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

Overrides RtcChannelAdapterBase.onPublishedThroughCloudProxy
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): RtcChannelAdapterElectron

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

removeAllEventListeners

removeAllEventListeners(): void

Inherited from RtcChannelAdapterBase.removeAllEventListeners
Returns void

setCloudProxy

setCloudProxy(proxyType: AgoraCloudProxyType): number

Overrides RtcChannelAdapterBase.setCloudProxy
Parameters
- proxyType: AgoraCloudProxyType
Returns number

setLatencyLevel

setLatencyLevel(level: AgoraLatencyLevel): void

Overrides RtcChannelAdapterBase.setLatencyLevel
Parameters
- level: AgoraLatencyLevel
Returns void

setLowStreamParameter

setLowStreamParameter(streamParameter: AGLowStreamParameter): number

Overrides RtcChannelAdapterBase.setLowStreamParameter
Parameters
- streamParameter: AGLowStreamParameter
Returns number

setRemoteTrackVolume

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

Overrides RtcChannelAdapterBase.setRemoteTrackVolume
Parameters
- streamUuid: string
- volume: number
Returns number

setRemoteVideoStreamType

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

Overrides RtcChannelAdapterBase.setRemoteVideoStreamType
Parameters
- streamUuid: string
- streamType: AGRemoteVideoStreamType
Returns number