Class AGRtcChannel

Hierarchy

AGRtcChannel

Constructors

constructor

new AGRtcChannel(channelName: string, adapter: RtcChannelAdapterBase): AGRtcChannel

Parameters
- channelName: string
- adapter: RtcChannelAdapterBase
Returns AGRtcChannel

Properties

channelName

channelName: string

Methods

enableDualStream

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

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

getRtcSid

getRtcSid(): string

Returns string

join

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

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

leave

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

Parameters
- Optional connectionType: AGRtcConnectionType
Returns Promise<void>

muteLocalAudioStream

muteLocalAudioStream(mute: boolean, connectionType?: AGRtcConnectionType): number

Parameters
- mute: boolean
- Optional connectionType: AGRtcConnectionType
Returns number

muteLocalScreenStream

muteLocalScreenStream(mute: boolean, connectionType?: AGRtcConnectionType): number

Parameters
- mute: boolean
- Optional connectionType: AGRtcConnectionType
Returns number

muteLocalVideoStream

muteLocalVideoStream(mute: boolean, connectionType?: AGRtcConnectionType): number

Parameters
- mute: boolean
- Optional connectionType: AGRtcConnectionType
Returns number

muteRemoteAudioStream

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

Parameters
- streamUuid: string
- mute: boolean
Returns number

muteRemoteVideoStream

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

Parameters
- streamUuid: string
- mute: boolean
Returns number

muteRemoteVideoStreamMass

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

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

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

onConnectedThroughCloudProxy

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

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

onConnectionStageChanged

onConnectionStageChanged(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

onNetworkStats

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

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

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

setCloudProxy

setCloudProxy(proxyType: AgoraCloudProxyType): number

Parameters
- proxyType: AgoraCloudProxyType
Returns number

setLatencyLevel

setLatencyLevel(level: AgoraLatencyLevel): void

Parameters
- level: AgoraLatencyLevel
Returns void

setLowStreamParameter

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

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

setRemoteTrackVolume

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

Parameters
- streamUuid: string
- volume: number
Returns void

setRemoteVideoStreamType

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

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