Client | Video SDK v3.6.2 API Reference for Web

Hierarchy

Client

Index

Methods

addInjectStreamUrl

addInjectStreamUrl(url: string, config: InjectStreamConfig): void

- Defined in index.d.ts:3880
Parameters
- url: string
- config: InjectStreamConfig
Returns void

configPublisher

configPublisher(width: number, height: number, framerate: number, bitrate: number, publisherUrl: string): void

- Defined in index.d.ts:3813
Parameters
- width: number
- height: number
- framerate: number
- bitrate: number
- publisherUrl: string
Returns void

disableDualStream

disableDualStream(onSuccess?: function, onFailure?: function): void

- Defined in index.d.ts:3754
Parameters
- Optional onSuccess: function
  - - (): void
    - Returns void
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

enableAudioVolumeIndicator

enableAudioVolumeIndicator(): void

- Defined in index.d.ts:3778
Returns void

enableDualStream

enableDualStream(onSuccess?: function, onFailure?: function): void

- Defined in index.d.ts:3627
Parameters
- Optional onSuccess: function
  - - (): void
    - Returns void
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

getCameras

getCameras(callback: function): void

- Defined in index.d.ts:4088
Parameters
- callback: function
  - - (devices: MediaDeviceInfo[]): void
    - Parameters
      - devices: MediaDeviceInfo[]
      Returns void
Returns void

getConnectionState

getConnectionState(): string

- Defined in index.d.ts:4294
Returns string

The connection state:
- DISCONNECTED: The SDK is disconnected from Agora's edge server.
  - This is the initial state before Client.join.
  - The SDK also enters this state after the app calls Client.leave.
- CONNECTING: The SDK is connecting to Agora's edge server. The SDK enters this state when calling Client.join or reconnecting to Agora's edge server automatically after the connection is lost.
- CONNECTED: The SDK is connected to Agora's edge server and joins a channel. You can now publish or subscribe to a stream in the channel.
- DISCONNECTING: The SDK is disconnecting from Agora's edge server. The SDK enters this state when calling Client.leave.

getLocalAudioStats

getLocalAudioStats(callback: function): void

- Defined in index.d.ts:4151
Parameters
- callback: function
  - - (stats: LocalAudioStatsMap): void
    - Parameters
      - stats: LocalAudioStatsMap
      Returns void
Returns void

getLocalVideoStats

getLocalVideoStats(callback: function): void

- Defined in index.d.ts:4224
Parameters
- callback: function
  - - (stats: LocalVideoStatsMap): void
    - Parameters
      - stats: LocalVideoStatsMap
      Returns void
Returns void

getNetworkStats

getNetworkStats(callback: function): void

- Defined in index.d.ts:4038
Parameters
- callback: function
  - - (stats: NetworkStats): void
    - Parameters
      - stats: NetworkStats
      Returns void
Returns void

getPlayoutDevices

getPlayoutDevices(callback: function): void

- Defined in index.d.ts:4080
Parameters
- callback: function
  - - (devices: MediaDeviceInfo[]): void
    - Parameters
      - devices: MediaDeviceInfo[]
      Returns void
Returns void

getRecordingDevices

getRecordingDevices(callback: function): void

- Defined in index.d.ts:4068
Parameters
- callback: function
  - - (devices: MediaDeviceInfo[]): void
    - Parameters
      - devices: MediaDeviceInfo[]
      Returns void
Returns void

getRemoteAudioStats

getRemoteAudioStats(callback: function): void

- Defined in index.d.ts:4121
Parameters
- callback: function
  - - (stats: RemoteAudioStatsMap): void
    - Parameters
      - stats: RemoteAudioStatsMap
      Returns void
Returns void

getRemoteVideoStats

getRemoteVideoStats(callback: function): void

- Defined in index.d.ts:4188
Parameters
- callback: function
  - - (stats: RemoteVideoStatsMap): void
    - Parameters
      - stats: RemoteVideoStatsMap
      Returns void
Returns void

getSessionStats

getSessionStats(callback: function): void

- Defined in index.d.ts:4277
Parameters
- callback: function
  - - (stats: SessionStats): void
    - Parameters
      - stats: SessionStats
      Returns void
Returns void

getSystemStats

getSystemStats(callback: function): void

- Defined in index.d.ts:4060
Parameters
- callback: function
  - - (stats: SystemStats): void
    - Parameters
      - stats: SystemStats
      Returns void
Returns void

getTransportStats

getTransportStats(callback: function): void

- Defined in index.d.ts:4249
Parameters
- callback: function
  - - (stats: TransportStats): void
    - Parameters
      - stats: TransportStats
      Returns void
Returns void

init

init(appId: string, onSuccess?: function, onFailure?: function): void

- Defined in index.d.ts:3330
Parameters
- appId: string
- Optional onSuccess: function
  - - (): void
    - Returns void
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

join

join(tokenOrKey: string | null, channel: string, uid: number | string | null, optionalInfo?: string, onSuccess?: function, onFailure?: function): void

- Defined in index.d.ts:3384
Parameters
- tokenOrKey: string | null
- channel: string
- uid: number | string | null
- Optional optionalInfo: string
- Optional onSuccess: function
  - - (uid: number): void
    - Parameters
      - uid: number
      Returns void
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

leave

leave(onSuccess?: function, onFailure?: function): void

- Defined in index.d.ts:3417
Parameters
- Optional onSuccess: function
  - - (): void
    - Returns void
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

off

off(eventType: string, callback: any): void

- Defined in index.d.ts:3309
Parameters
- eventType: string
- callback: any
Returns void

on

on(event: "first-audio-frame-decode", callback: function): void
on(event: "first-video-frame-decode", callback: function): void
on(event: "stream-published", callback: function): void
on(event: "stream-unpublished", callback: function): void
on(event: "stream-added", callback: function): void
on(event: "stream-removed", callback: function): void
on(event: "stream-subscribed", callback: function): void
on(event: "peer-online", callback: function): void
on(event: "peer-leave", callback: function): void
on(event: "mute-audio", callback: function): void
on(event: "unmute-audio", callback: function): void
on(event: "mute-video", callback: function): void
on(event: "unmute-video", callback: function): void
on(event: "crypt-error", callback: function): void
on(event: "client-banned", callback: function): void
on(event: "active-speaker", callback: function): void
on(event: "volume-indicator", callback: function): void
on(event: "liveStreamingStarted", callback: function): void
on(event: "liveStreamingFailed", callback: function): void
on(event: "liveStreamingStopped", callback: function): void
on(event: "liveTranscodingUpdated", callback: function): void
on(event: "streamInjectedStatus", callback: function): void
on(event: "onTokenPrivilegeWillExpire", callback: function): void
on(event: "onTokenPrivilegeDidExpire", callback: function): void
on(event: "error", callback: function): void
on(event: "network-type-changed", callback: function): void
on(event: "recording-device-changed", callback: function): void
on(event: "playout-device-changed", callback: function): void
on(event: "camera-changed", callback: function): void
on(event: "stream-type-changed", callback: function): void
on(event: "connection-state-change", callback: function): void
on(event: "stream-reconnect-start", callback: function): void
on(event: "stream-reconnect-end", callback: function): void
on(event: "client-role-changed", callback: function): void
on(event: "reconnect", callback: function): void
on(event: "rejoin", callback: function): void
on(event: "connected", callback: function): void
on(event: "network-quality", callback: function): void
on(event: "stream-fallback", callback: function): void
on(event: "stream-updated", callback: function): void
on(event: "exception", callback: function): void
on(event: "enable-local-video", callback: function): void
on(event: "disable-local-video", callback: function): void
on(event: "channel-media-relay-event", callback: function): void
on(event: "channel-media-relay-state", callback: function): void

- Defined in index.d.ts:2586
Parameters
- event: "first-audio-frame-decode"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2600
Parameters
- event: "first-video-frame-decode"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2611
Parameters
- event: "stream-published"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2623
Parameters
- event: "stream-unpublished"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2641
Parameters
- event: "stream-added"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2654
Parameters
- event: "stream-removed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2667
Parameters
- event: "stream-subscribed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2691
Parameters
- event: "peer-online"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        uid: string
      Returns void
Returns void
- Defined in index.d.ts:2717
Parameters
- event: "peer-leave"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        reason: string
        
        uid: string
      Returns void
Returns void
- Defined in index.d.ts:2738
Parameters
- event: "mute-audio"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2750
Parameters
- event: "unmute-audio"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2762
Parameters
- event: "mute-video"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2773
Parameters
- event: "unmute-video"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2789
Parameters
- event: "crypt-error"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2806
Parameters
- event: "client-banned"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2820
Parameters
- event: "active-speaker"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2837
Parameters
- event: "volume-indicator"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2841
Parameters
- event: "liveStreamingStarted"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        type: "liveStreamingStarted"
        
        url: string
      Returns void
Returns void
- Defined in index.d.ts:2850
Parameters
- event: "liveStreamingFailed"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        reason: string
        
        type: "liveStreamingFailed"
        
        Optional url?: string
      Returns void
Returns void
- Defined in index.d.ts:2873
Parameters
- event: "liveStreamingStopped"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        type: "liveStreamingStopped"
        
        url: string
      Returns void
Returns void
- Defined in index.d.ts:2884
Parameters
- event: "liveTranscodingUpdated"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        type: "liveTranscodingUpdated"
      Returns void
Returns void
- Defined in index.d.ts:2890
Parameters
- event: "streamInjectedStatus"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2904
Parameters
- event: "onTokenPrivilegeWillExpire"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2918
Parameters
- event: "onTokenPrivilegeDidExpire"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2933
Parameters
- event: "error"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        reason: any
        
        type: "error"
      Returns void
Returns void
- Defined in index.d.ts:2949
Parameters
- event: "network-type-changed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2961
Parameters
- event: "recording-device-changed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2976
Parameters
- event: "playout-device-changed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:2988
Parameters
- event: "camera-changed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:3008
Parameters
- event: "stream-type-changed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:3031
Parameters
- event: "connection-state-change"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        curState: string
        
        prevState: string
      Returns void
Returns void
- Defined in index.d.ts:3048
Parameters
- event: "stream-reconnect-start"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        uid: number | string
      Returns void
Returns void
- Defined in index.d.ts:3063
Parameters
- event: "stream-reconnect-end"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        reason: string
        
        success: boolean
        
        uid: number | string
      Returns void
Returns void
- Defined in index.d.ts:3090
Parameters
- event: "client-role-changed"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        role: string
      Returns void
Returns void
- Defined in index.d.ts:3104
Parameters
- event: "reconnect"
- callback: function
  - - (): void
    - Returns void
Returns void
- Defined in index.d.ts:3115
Parameters
- event: "rejoin"
- callback: function
  - - (): void
    - Returns void
Returns void
- Defined in index.d.ts:3127
Parameters
- event: "connected"
- callback: function
  - - (): void
    - Returns void
Returns void
- Defined in index.d.ts:3146
Parameters
- event: "network-quality"
- callback: function
  - - (stats: NetworkQualityStats): void
    - Parameters
      - stats: NetworkQualityStats
      Returns void
Returns void
- Defined in index.d.ts:3160
Parameters
- event: "stream-fallback"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        attr: number
        
        uid: string | number
      Returns void
Returns void
- Defined in index.d.ts:3176
Parameters
- event: "stream-updated"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        stream: Stream
      Returns void
Returns void
- Defined in index.d.ts:3206
Parameters
- event: "exception"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        code: number
        
        msg: string
        
        uid: string
      Returns void
Returns void
- Defined in index.d.ts:3220
Parameters
- event: "enable-local-video"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        uid: string
      Returns void
Returns void
- Defined in index.d.ts:3230
Parameters
- event: "disable-local-video"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        uid: string
      Returns void
Returns void
- Defined in index.d.ts:3240
Parameters
- event: "channel-media-relay-event"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        code: number
      Returns void
Returns void
- Defined in index.d.ts:3262
Parameters
- event: "channel-media-relay-state"
- callback: function
  - - (evt: object): void
    - Parameters
      - evt: object
        
        code: number
        
        state: number
      Returns void
Returns void

publish

publish(stream: Stream, onFailure?: function): void

- Defined in index.d.ts:3446
Parameters
- stream: Stream
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

removeInjectStreamUrl

removeInjectStreamUrl(url: string): void

- Defined in index.d.ts:3889
Parameters
- url: string
Returns void

renewChannelKey

renewChannelKey(key: string, onSuccess?: function, onFailure?: function): void

- Defined in index.d.ts:4009
Parameters
- key: string
- Optional onSuccess: function
  - - (): void
    - Returns void
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

renewToken

renewToken(token: string): void

- Defined in index.d.ts:3993
Parameters
- token: string
Returns void

setClientRole

setClientRole(role: "audience" | "host", callback?: function): void

- Defined in index.d.ts:3592
Parameters
- role: "audience" | "host"
- Optional callback: function
  - - (err?: string | null): void
    - Parameters
      - Optional err: string | null
      Returns void
Returns void

setEncryptionMode

setEncryptionMode(encryptionMode: "aes-128-xts" | "aes-256-xts" | "aes-128-ecb" | "sm4-128-ecb" | "aes-128-gcm" | "aes-256-gcm" | "aes-128-gcm2" | "aes-256-gcm2" | "none", salt?: Uint8Array): void

- Defined in index.d.ts:3979
Parameters
- encryptionMode: "aes-128-xts" | "aes-256-xts" | "aes-128-ecb" | "sm4-128-ecb" | "aes-128-gcm" | "aes-256-gcm" | "aes-128-gcm2" | "aes-256-gcm2" | "none"
- Optional salt: Uint8Array
Returns void

setEncryptionSecret

setEncryptionSecret(password: string): void

- Defined in index.d.ts:3952
Parameters
- password: string
Returns void

setLiveTranscoding

setLiveTranscoding(coding: LiveTranscoding): void

- Defined in index.d.ts:3848
Parameters
- coding: LiveTranscoding
Returns void

setLowStreamParameter

setLowStreamParameter(param: object): void

- Defined in index.d.ts:3651
Parameters
- param: object
  - Optional bitrate?: number
  - Optional framerate?: number
  - Optional height?: number
  - Optional width?: number
Returns void

setProxyServer

setProxyServer(proxyServer: string): void

- Defined in index.d.ts:3922
Parameters
- proxyServer: string
Returns void

setRemoteVideoStreamType

setRemoteVideoStreamType(stream: Stream, streamType: 0 | 1): void

- Defined in index.d.ts:3708
Parameters
- stream: Stream
- streamType: 0 | 1
Returns void

setStreamFallbackOption

setStreamFallbackOption(stream: Stream, fallbackType: 0 | 1 | 2): void

- Defined in index.d.ts:3736
Parameters
- stream: Stream
- fallbackType: 0 | 1 | 2
Returns void

setTurnServer

setTurnServer(turnServer: TurnServer[]): void

- Defined in index.d.ts:3936
Parameters
- turnServer: TurnServer[]
Returns void

startChannelMediaRelay

startChannelMediaRelay(config: ChannelMediaRelayConfiguration, callback: function): void

- Defined in index.d.ts:4334
Parameters
- config: ChannelMediaRelayConfiguration
- callback: function
  - - (err: null | ChannelMediaError): void
    - Parameters
      - err: null | ChannelMediaError
      Returns void
Returns void

startLiveStreaming

startLiveStreaming(url: string, enableTranscoding?: boolean): void

- Defined in index.d.ts:3835
Parameters
- url: string
- Optional enableTranscoding: boolean
Returns void

startProxyServer

startProxyServer(type?: number): void

- Defined in index.d.ts:3898
Parameters
- Optional type: number
Returns void

stopChannelMediaRelay

stopChannelMediaRelay(callback: function): void

- Defined in index.d.ts:4403
Parameters
- callback: function
  - - (err: null | ChannelMediaError): void
    - Parameters
      - err: null | ChannelMediaError
      Returns void
Returns void

stopLiveStreaming

stopLiveStreaming(url: string): void

- Defined in index.d.ts:3856
Parameters
- url: string
Returns void

stopProxyServer

stopProxyServer(): void

- Defined in index.d.ts:3906
Returns void

subscribe(stream: Stream, options?: object, onFailure?: function): void

- Defined in index.d.ts:3515
Parameters
- stream: Stream
- Optional options: object
  - Optional audio?: boolean
  - Optional video?: boolean
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

unpublish

unpublish(stream: Stream, onFailure?: function): void

- Defined in index.d.ts:3471
Parameters
- stream: Stream
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

unsubscribe

unsubscribe(stream: Stream, onFailure?: function): void

- Defined in index.d.ts:3551
Parameters
- stream: Stream
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

updateChannelMediaRelay

updateChannelMediaRelay(config: ChannelMediaRelayConfiguration, callback: function): void

- Defined in index.d.ts:4370
Parameters
- config: ChannelMediaRelayConfiguration
- callback: function
  - - (err: null | ChannelMediaError): void
    - Parameters
      - err: null | ChannelMediaError
      Returns void
Returns void

Hierarchy

Index

Methods

Methods

addInjectStreamUrl

Parameters

url: string

config: InjectStreamConfig

Returns void

configPublisher

Parameters

width: number

height: number

framerate: number

bitrate: number

publisherUrl: string

Returns void

disableDualStream

Parameters

Optional onSuccess: function

Returns void

Optional onFailure: function

Parameters

err: string

Returns void

Returns void

enableAudioVolumeIndicator

Returns void

enableDualStream

Parameters

Optional onSuccess: function

Returns void

Optional onFailure: function

Parameters

err: string

Returns void

Returns void

getCameras

Parameters

callback: function

Parameters

devices: MediaDeviceInfo[]

Returns void

Returns void

getConnectionState

Returns string

getLocalAudioStats

Parameters

callback: function

Parameters

stats: LocalAudioStatsMap

Returns void

Returns void

getLocalVideoStats

Parameters

callback: function

Parameters

stats: LocalVideoStatsMap

Returns void

Returns void

getNetworkStats

Parameters

callback: function

Parameters

stats: NetworkStats

Returns void

Returns void

getPlayoutDevices

Parameters

callback: function

Parameters

devices: MediaDeviceInfo[]

Returns void

Returns void

getRecordingDevices

Parameters

callback: function

Parameters

devices: MediaDeviceInfo[]

Returns void