Stream | Video SDK v3.6.2 API Reference for Web

Hierarchy

Stream

Index

Methods

addTrack

addTrack(track: MediaStreamTrack): void

- Defined in index.d.ts:1820
Parameters
- track: MediaStreamTrack
Returns void

adjustAudioMixingVolume

adjustAudioMixingVolume(level: number): void

- Defined in index.d.ts:2119
Parameters
- level: number
Returns void

close

close(): void

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

disableAudio

disableAudio(): boolean

- Defined in index.d.ts:1677
Returns boolean

disableVideo

disableVideo(): boolean

- Defined in index.d.ts:1700
Returns boolean

enableAudio

enableAudio(): boolean

- Defined in index.d.ts:1667
Returns boolean

enableVideo

enableVideo(): boolean

- Defined in index.d.ts:1690
Returns boolean

getAudioLevel

getAudioLevel(): number | undefined

- Defined in index.d.ts:1742
Returns number | undefined

The audio level. The value range is [0,1].

getAudioMixingCurrentPosition

getAudioMixingCurrentPosition(): number | void

- Defined in index.d.ts:2133
Returns number | void

Returns the current position of the audio mixing if successful.

getAudioMixingDuration

getAudioMixingDuration(): number | void

- Defined in index.d.ts:2125
Returns number | void

Returns the audio mixing duration (ms) if successful.

getAudioTrack

getAudioTrack(): MediaStreamTrack | undefined

- Defined in index.d.ts:1749
Returns MediaStreamTrack | undefined

If the stream contains an audio track, it will be returned in a MediaStreamTrack object.

getEffectsVolume

getEffectsVolume(): Array<object>

- Defined in index.d.ts:2356
Returns Array<object>

Returns an array that contains soundId and volume. Each soundId has a correspondingvolume.
- soundId: The ID of the audio effect. Each audio effect has a unique ID. The value range is [1,10000].
- volume: Volume of the audio effect. The value range is [0,100].

getId

getId(): number | string

- Defined in index.d.ts:2511
Returns number | string

getStats

getStats(callback: function): void

- Defined in index.d.ts:2563
Parameters
- callback: function
  - - (stats: LocalStreamStats | RemoteStreamStats): void
    - Parameters
      - stats: LocalStreamStats | RemoteStreamStats
      Returns void
Returns void

getVideoTrack

getVideoTrack(): MediaStreamTrack | undefined

- Defined in index.d.ts:1756
Returns MediaStreamTrack | undefined

If the stream contains a video track, it will be returned in a MediaStreamTrack object.

hasAudio

hasAudio(): boolean

- Defined in index.d.ts:1709
Returns boolean
- true: The stream contains audio data.
- false: The stream does not contain audio data.

hasVideo

hasVideo(): boolean

- Defined in index.d.ts:1718
Returns boolean
- true: The stream contains video data.
- false: The stream does not contain video data.

init

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

- Defined in index.d.ts:1517
Parameters
- Optional onSuccess: function
  - - (): void
    - Returns void
- Optional onFailure: function
  - - (err: object): void
    - Parameters
      - err: object
        
        Optional info?: string
        
        msg: string
        
        type: "warning" | "error"
      Returns void
Returns void

isPlaying

isPlaying(): boolean

- Defined in index.d.ts:1589
Returns boolean
- true: The stream is being rendered or playing on the page.
- false: The stream is neither being rendered nor playing on the page.

muteAudio

muteAudio(): boolean

- Defined in index.d.ts:1626
Returns boolean
- true: Success.
- false: Failure. Possible reasons include no audio, stream not initialized, and audio track already disabled.

muteVideo

muteVideo(): boolean

- Defined in index.d.ts:1655
Returns boolean
- true: Success.
- false: Failure. Possible reasons include no video, stream not initialized, and video track already disabled.

on

on(event: "accessAllowed", callback: function): void
on(event: "accessDenied", callback: function): void
on(event: "stopScreenSharing", callback: function): void
on(event: "videoTrackEnded", callback: function): void
on(event: "audioTrackEnded", callback: function): void
on(event: "audioMixingPlayed", callback: function): void
on(event: "audioMixingFinished", callback: function): void
on(event: "player-status-change", callback: function): void

- Defined in index.d.ts:1411
Parameters
- event: "accessAllowed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:1413
Parameters
- event: "accessDenied"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:1415
Parameters
- event: "stopScreenSharing"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:1421
Parameters
- event: "videoTrackEnded"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:1427
Parameters
- event: "audioTrackEnded"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:1434
Parameters
- event: "audioMixingPlayed"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:1436
Parameters
- event: "audioMixingFinished"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void
- Defined in index.d.ts:1478
Parameters
- event: "player-status-change"
- callback: function
  - - (evt: any): void
    - Parameters
      - evt: any
      Returns void
Returns void

pauseAllEffects

pauseAllEffects(callback?: function): void

- Defined in index.d.ts:2407
Parameters
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

pauseAudioMixing

pauseAudioMixing(callback?: function): void

- Defined in index.d.ts:2107
Parameters
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

pauseEffect

pauseEffect(soundId: number, callback?: function): void

- Defined in index.d.ts:2249
Parameters
- soundId: number
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

play

play(HTMLElementID: string, option?: object, callback?: function): void

- Defined in index.d.ts:1543
Parameters
- HTMLElementID: string
- Optional option: object
  - Optional fit?: "cover" | "contain"
  - Optional muted?: boolean
- Optional callback: function
  - - (err: null | StreamPlayError): void
    - Parameters
      - err: null | StreamPlayError
      Returns void
Returns void

playEffect

playEffect(options: object, callback?: function): void

- Defined in index.d.ts:2186
Parameters
- options: object
  - Optional cycle?: number
  - filePath: string
  - soundId: number
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

preloadEffect

preloadEffect(soundId: number, filePath: string, callback?: function): void

- Defined in index.d.ts:2314
Parameters
- soundId: number
- filePath: string
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

removeTrack

removeTrack(track: MediaStreamTrack): void

- Defined in index.d.ts:1842
Parameters
- track: MediaStreamTrack
Returns void

replaceTrack

replaceTrack(MediaStreamTrack: MediaStreamTrack, onSuccess?: function, onFailure?: function): void

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

resume

resume(): Promise<any>

- Defined in index.d.ts:1575
Returns Promise<any>

resumeAllEffects

resumeAllEffects(callback?: function): void

- Defined in index.d.ts:2424
Parameters
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

resumeAudioMixing

resumeAudioMixing(callback?: function): void

- Defined in index.d.ts:2113
Parameters
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

resumeEffect

resumeEffect(soundId: number, callback?: function): void

- Defined in index.d.ts:2269
Parameters
- soundId: number
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

setAudioMixingPosition

setAudioMixingPosition(position: number, callback?: function): void

- Defined in index.d.ts:2141
Parameters
- position: number
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

setAudioOutput

setAudioOutput(deviceId: string, onSuccess?: function, onFailure?: function): void

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

setAudioProfile

setAudioProfile(profile: "speech_low_quality" | "speech_standard" | "music_standard" | "standard_stereo" | "high_quality" | "high_quality_stereo"): void

- Defined in index.d.ts:1866
Parameters
- profile: "speech_low_quality" | "speech_standard" | "music_standard" | "standard_stereo" | "high_quality" | "high_quality_stereo"
Returns void

setAudioVolume

setAudioVolume(volume: number): void

- Defined in index.d.ts:1876
Parameters
- volume: number
Returns void

setBeautyEffectOptions

setBeautyEffectOptions(enabled: boolean, options: object): Promise<void>

- Defined in index.d.ts:2478
Parameters
- enabled: boolean
- options: object
  - Optional lighteningContrastLevel?: number
  - Optional lighteningLevel?: number
  - Optional rednessLevel?: number
  - Optional smoothnessLevel?: number
Returns Promise<void>

A promise object, which is resolved after the method call succeeds.

setEffectsVolume

setEffectsVolume(volume: number, callback?: function): void

- Defined in index.d.ts:2372
Parameters
- volume: number
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

setScreenProfile

setScreenProfile(profile: string): void

- Defined in index.d.ts:2002
Parameters
- profile: string
Returns void

setVideoEncoderConfiguration

setVideoEncoderConfiguration(config: VideoEncoderConfiguration): void

- Defined in index.d.ts:1989
Parameters
- config: VideoEncoderConfiguration
Returns void

setVideoProfile

setVideoProfile(profile: string): void

- Defined in index.d.ts:1947
Parameters
- profile: string
Returns void

setVolumeOfEffect

setVolumeOfEffect(soundId: number, volume: number, callback?: function): void

- Defined in index.d.ts:2290
Parameters
- soundId: number
- volume: number
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

startAudioMixing

startAudioMixing(options: object, callback?: function): void

- Defined in index.d.ts:2052
Parameters
- options: object
  - Optional cacheResource?: boolean
  - Optional cycle?: number
  - filePath: string
  - Optional loop?: boolean
  - playTime: number
  - Optional replace?: boolean
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

stop

stop(): void

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

stopAllEffects

stopAllEffects(callback?: function): void

- Defined in index.d.ts:2390
Parameters
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

stopAudioMixing

stopAudioMixing(callback?: function): void

- Defined in index.d.ts:2102
Parameters
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

stopEffect

stopEffect(soundId: number, callback?: function): void

- Defined in index.d.ts:2229
Parameters
- soundId: number
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

switchDevice

switchDevice(type: "audio" | "video", deviceId: string, onSuccess?: function, onFailure?: function): void

- Defined in index.d.ts:1920
Parameters
- type: "audio" | "video"
- deviceId: string
- Optional onSuccess: function
  - - (): void
    - Returns void
- Optional onFailure: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

unloadEffect

unloadEffect(soundId: number, callback?: function): void

- Defined in index.d.ts:2336
Parameters
- soundId: number
- Optional callback: function
  - - (err: string | null): void
    - Parameters
      - err: string | null
      Returns void
Returns void

unmuteAudio

unmuteAudio(): boolean

- Defined in index.d.ts:1612
Returns boolean
- true: Success.
- false: Failure. Possible reasons include no audio, stream not initialized, and audio track already enabled.

unmuteVideo

unmuteVideo(): boolean

- Defined in index.d.ts:1641
Returns boolean
- true: Success.
- false: Failure. Possible reasons include no video, stream not initialized, and video track already enabled.

Hierarchy

Index

Methods

Methods

addTrack

Parameters

track: MediaStreamTrack

Returns void

adjustAudioMixingVolume

Parameters

level: number

Returns void

close

Returns void

disableAudio

Returns boolean

disableVideo

Returns boolean

enableAudio

Returns boolean

enableVideo

Returns boolean

getAudioLevel

Returns number | undefined

getAudioMixingCurrentPosition

Returns number | void

getAudioMixingDuration

Returns number | void

getAudioTrack

Returns MediaStreamTrack | undefined

getEffectsVolume

Returns Array<object>

getId

Returns number | string

getStats

Parameters

callback: function

Parameters

stats: LocalStreamStats | RemoteStreamStats

Returns void

Returns void

getVideoTrack

Returns MediaStreamTrack | undefined

hasAudio

Returns boolean

hasVideo

Returns boolean

init

Parameters

Optional onSuccess: function

Returns void

Optional onFailure: function

Parameters

err: object

Optional info?: string

msg: string

type: "warning" | "error"

Returns void

Returns void

isPlaying

Returns boolean

muteAudio

Returns boolean

muteVideo

Returns boolean

on

Parameters

event: "accessAllowed"

callback: function

Parameters

evt: any

Returns void

Returns void

Parameters

event: "accessDenied"

callback: function

Parameters

evt: any

Returns void

Returns void