Web SDK API Reference

toDataURL(options?: {scaleFactor?:number}): string
toPNG(options?: {scaleFactor?:number}): Uint8Array

getChannelId(): number
getConfig(): IDataChannelConfig

send(data: ArrayBuffer): void

getMediaStreamTrack(): MediaStreamTrack
getRTCRtpTransceiver(type?: StreamType): RTCRtpTransceiver|undefined
getTrackId(): string
play(element?: string|HTMLElement): void
stop(): void

close(): void
getStats(): LocalVideoTrackStats|LocalAudioTrackStats
getTrackLabel(): string
setEnabled(enabled: boolean): Promise<void>
setMuted(muted: boolean): Promise<void>

addReferenceTrack(track: ILocalAudioTrack|IRemoteAudioTrack): void
getStats(): LocalAudioTrackStats
getVolumeLevel(): number
pipe(processor: IAudioProcessor): IAudioProcessor
play(): void
removeExtension(extension: IAudioExtension): boolean
removeReferenceTrack(track: ILocalAudioTrack|IRemoteAudioTrack): boolean
setAudioFrameCallback(audioFrameCallback: null|((buffer:AudioBuffer)=>void), frameSize?: number): void
setPlaybackDevice(deviceId: string): Promise<void>
setVolume(volume: number): void
unpipe(): void
useExtension(extensionCtor: AudioExtensionConstructor<T>, extensionOptions?: Record<string,unknown>): T

clone(config?: VideoEncoderConfiguration|VideoEncoderConfigurationPreset, cloneTrack?: boolean): ILocalVideoTrack
getCurrentFrameData(): ImageData
getCurrentFrameImage(imageType: string, quality: number): Promise<ImageTypedData>
getStats(): LocalVideoTrackStats
getVideoElementVisibleStatus(): CheckVideoVisibleResult|undefined
pipe(processor: IBaseProcessor): IBaseProcessor
play(element: string|HTMLElement, config?: VideoPlayerConfig): void
removeExtension(extension: IVideoExtension): boolean
replaceTrack(track: MediaStreamTrack, stopOldTrack: boolean): Promise<void>
sendSeiData(sei: Uint8Array): void
setBeautyEffect(enabled: boolean, options?: BeautyEffectOptions): Promise<void>
setEncoderConfiguration(config: VideoEncoderConfiguration|VideoEncoderConfigurationPreset): Promise<void>
setOptimizationMode(mode: OptimizationMode): Promise<void>
unpipe(): void
useExtension(extensionCtor: T, options?: {extensionOptions?:Record<string,unknown>;moduleURL?:string;registrationName?:string}): InstanceType<T>

setDevice(deviceId: string): Promise<void>
setEnabled(enabled: boolean): Promise<void>

clone(config?: VideoEncoderConfiguration|VideoEncoderConfigurationPreset, cloneTrack?: boolean): ICameraVideoTrack
setDevice(deviceId: string|RequiredOnlyOneOf<{facingMode:VideoFacingModeEnum;deviceId:string}>): Promise<void>
setEnabled(enabled: boolean): Promise<void>

getCurrentTime(): number
getDuration(): number
on(event: string, listener: Function): void
pause(): void
resume(): void
seek(offset: number): void
start(): void
stop(): void

getStats(): RemoteAudioTrackStats|RemoteVideoTrackStats
getUserId(): UID

addReferenceTrack(track: ILocalAudioTrack|IRemoteAudioTrack): void
getStats(): RemoteAudioTrackStats
getVolume(): number
getVolumeLevel(): number
pipe(processor: IAudioProcessor): IAudioProcessor
play(): void
removeExtension(extension: IAudioExtension): boolean
removeReferenceTrack(track: ILocalAudioTrack|IRemoteAudioTrack): boolean
setAmplifiedVolume(volume: number): void
setAudioFrameCallback(audioFrameCallback: null|((buffer:AudioBuffer)=>void), frameSize?: number): void
setPlaybackDevice(deviceId: string): Promise<void>
setVolume(volume: number): void
unpipe(): void
useExtension(extensionCtor: AudioExtensionConstructor<T>): T

getCurrentFrameData(): ImageData
getStats(): RemoteVideoTrackStats
getVideoElementVisibleStatus(): CheckVideoVisibleResult|undefined
pipe(processor: IBaseProcessor): IBaseProcessor
play(element: string|HTMLElement, config?: VideoPlayerConfig): void
removeExtension(extension: IVideoExtension): boolean
unpipe(): void
useExtension(extensionCtor: T, options?: {extensionOptions?:Record<string,unknown>;moduleURL?:string;registrationName?:string}): InstanceType<T>

getDestChannelInfo(channelName: string): ChannelMediaRelayInfo
getSrcChannelInfo(): ChannelMediaRelayInfo
removeDestChannelInfo(channelName: string): void
setDestChannelInfo(channelName: string, info: ChannelMediaRelayInfo): void
setSrcChannelInfo(info: ChannelMediaRelayInfo): void

disableDualStream(): Promise<void>
enableAudioVolumeIndicator(): void
enableDualStream(): Promise<void>
getLocalAudioStats(): LocalAudioTrackStats
getLocalVideoStats(): LocalVideoTrackStats
getNetworkQuality(): NetworkQuality
getNtpWallTimeInMs(): number
getRTCStats(): AgoraRTCStats
getRemoteAudioStats(): {[uid:string]:RemoteAudioTrackStats}
getRemoteNetworkQuality(): {[uid:string]:NetworkQuality}
getRemoteVideoStats(): {[uid:string]:RemoteVideoTrackStats}
join(appid: string, channel: string, token: string|null, uid?: UID|null, options?: {autoSubscribe?:boolean;autoReceiveAndPlayAudio?:boolean;networkQualityProbe?:boolean}): Promise<UID>
leave(): Promise<void>
massSubscribe(subscribeList: {user:IAgoraRTCRemoteUser;mediaType:"audio"|"video"}[]): Promise<{user:IAgoraRTCRemoteUser;mediaType:"audio"|"video";track?:IRemoteTrack;error?:AgoraRTCError}[]>
massUnsubscribe(unsubscribeList: {user:IAgoraRTCRemoteUser;mediaType?:"audio"|"video"}[]): Promise<void>
on(event: string, listener: Function): void
pickSVCLayer(uid: UID, layerOptions: {spatialLayer:0|1|2|3;temporalLayer:0|1|2|3}): Promise<void>
presubscribe(uid: UID, mediaType: "audio"): Promise<IRemoteAudioTrack>
presubscribe(uid: UID, mediaType: "video"): Promise<IRemoteVideoTrack>
presubscribe(uid: UID, mediaType: "video"|"audio"): Promise<IRemoteTrack>
publish(tracks: ILocalTrack|ILocalTrack[]): Promise<void>
publish(config: IDataChannelConfig): Promise<ILocalDataChannel>
publish(params: ILocalTrack|ILocalTrack[]|IDataChannelConfig): Promise<ILocalDataChannel|void>
renewToken(token: string): Promise<void>
sendCustomReportMessage(reports: EventCustomReportParams[]|EventCustomReportParams): Promise<void>
setClientRole(role: ClientRole, options?: ClientRoleOptions): Promise<void>
setDualStreamMode(mode: SIMULCAST_STREAM_MODE, streamParameter?: LowStreamParameter): Promise<void>
setEncryptionConfig(encryptionMode: EncryptionMode, secret: string, salt?: Uint8Array, encryptDataStream?: boolean): void
setLicense(license: string): void
setLiveTranscoding(config: LiveStreamingTranscodingConfig): Promise<void>
setLocalAccessPointsV2(config: LocalAccessPointConfig): void
setLowStreamParameter(streamParameter: LowStreamParameter): void
setProxyServer(proxyServer: string): void
setRTMConfig(config: RTMConfiguration): Promise<void>
setRemoteDefaultVideoStreamType(streamType: RemoteStreamType): Promise<void>
setRemoteVideoStreamType(uid: UID, streamType: RemoteStreamType): Promise<void>
setStreamFallbackOption(uid: UID, fallbackType: RemoteStreamFallbackType): Promise<void>
setTurnServer(turnServer: TurnServerConfig): void
startChannelMediaRelay(config: IChannelMediaRelayConfiguration): Promise<void>
startLiveStreaming(url: string, transcodingEnabled?: boolean): Promise<void>
startProxyServer(mode?: number): void
stopChannelMediaRelay(): Promise<void>
stopLiveStreaming(url: string): Promise<void>
stopProxyServer(): void
subscribe(user: IAgoraRTCRemoteUser|UID, mediaType: "video"): Promise<IRemoteVideoTrack>
subscribe(user: IAgoraRTCRemoteUser|UID, mediaType: "audio"): Promise<IRemoteAudioTrack>
subscribe(user: IAgoraRTCRemoteUser|UID, mediaType: "datachannel", channelId: number): Promise<IRemoteDataChannel>
subscribe(user: IAgoraRTCRemoteUser|UID, mediaType: "video"|"audio"|"datachannel", channelId?: number): Promise<IRemoteTrack|IRemoteDataChannel>
unpublish(tracks?: ILocalTrack|ILocalTrack[]): Promise<void>
unpublish(dataChannel?: ILocalDataChannel): Promise<void>
unpublish(params?: ILocalTrack|ILocalTrack[]|ILocalDataChannel): Promise<void>
unsubscribe(user: IAgoraRTCRemoteUser|UID, mediaType?: "video"|"audio"|"datachannel", channelId?: number): Promise<void>
updateChannelMediaRelay(config: IChannelMediaRelayConfiguration): Promise<void>

checkAudioTrackIsActive(track: ILocalAudioTrack|IRemoteAudioTrack, timeout?: number): Promise<boolean>
checkSystemRequirements(): boolean
checkVideoTrackIsActive(track: ILocalVideoTrack|IRemoteVideoTrack, timeout?: number): Promise<boolean>
createBufferSourceAudioTrack(config: BufferSourceAudioTrackInitConfig): Promise<IBufferSourceAudioTrack>
createCameraVideoTrack(config?: CameraVideoTrackInitConfig): Promise<ICameraVideoTrack>
createChannelMediaRelayConfiguration(): IChannelMediaRelayConfiguration
createClient(config: ClientConfig): IAgoraRTCClient
createCustomAudioTrack(config: CustomAudioTrackInitConfig): ILocalAudioTrack
createCustomVideoTrack(config: CustomVideoTrackInitConfig): ILocalVideoTrack
createMicrophoneAndCameraTracks(audioConfig?: MicrophoneAudioTrackInitConfig, videoConfig?: CameraVideoTrackInitConfig): Promise<[IMicrophoneAudioTrack,ICameraVideoTrack]>
createMicrophoneAudioTrack(config?: MicrophoneAudioTrackInitConfig): Promise<IMicrophoneAudioTrack>
createScreenVideoTrack(config: ScreenVideoTrackInitConfig, withAudio: "enable"): Promise<[ILocalVideoTrack,ILocalAudioTrack]>
createScreenVideoTrack(config: ScreenVideoTrackInitConfig, withAudio: "disable"): Promise<ILocalVideoTrack>
createScreenVideoTrack(config: ScreenVideoTrackInitConfig, withAudio?: "enable"|"disable"|"auto"|ScreenAudioTrackInitConfig): Promise<[ILocalVideoTrack,ILocalAudioTrack]|ILocalVideoTrack>
disableLogUpload(): void
enableLogUpload(): void
getCameras(skipPermissionCheck?: boolean): Promise<MediaDeviceInfo[]>
getDevices(skipPermissionCheck?: boolean): Promise<MediaDeviceInfo[]>
getElectronScreenSources(type?: ScreenSourceType): Promise<ElectronDesktopCapturerSource[]>
getMicrophones(skipPermissionCheck?: boolean): Promise<MediaDeviceInfo[]>
getPlaybackDevices(skipPermissionCheck?: boolean): Promise<MediaDeviceInfo[]>
getSupportedCodec(): Promise<{video:string[];audio:string[]}>
preload(appid: string, channel: string, token: string|null, uid?: UID|null): Promise<void>
processExternalMediaAEC(element: HTMLMediaElement): void
registerExtensions(extensions: IExtension<any>[]): void
resumeAudioContext(): void
setAppType(type: AppType): void
setArea(area: AREAS[]|{areaCode:AREAS[];excludedArea?:AREAS}): void
setLogLevel(level: number): void
startLastmileProbeTest(appid: string, channel: string, token: string|null, uid?: UID|null): Promise<LastmileProbeResult>
use(plugin: IAgoraRTCServicePlugin): IAgoraRTC