Suggestions

close search

StringeeVideoTrack

Represents a video track in room.

Properties

trackId: string

Id of the video track.

publisher: StringeeRoomUser

The user who publish this video track.

audioEnable: boolean

Checks whether the video track has audio.

videoEnable: boolean

Checks whether the video track has video.

isScreenCapture: boolean

Checks whether the video track is screen capture.

isLocal: boolean

Checks whether the video track is local track.

Functions

mute(mute: boolean, callback: (status, code, message))

Toggle audio on or off.
- mute:
    + true - audio off.
    + false - audio on.
- callback: The result
    + status = true, code = 0, message = "Success"
    + status = false, code = -1, message = "StringeeClient is not initialized or connected".
    + status = false, code = -2, message = "Generic error".

enableVideo(enable: boolean, callback: (status, code, message))

Enables or disables the video stream.
- enable:
    + true - video enables.
    + false - audio disables.
- callback: The result
    + status = true, code = 0, message = "Success"
    + status = false, code = -1, message = "StringeeClient is not initialized or connected".
    + status = false, code = -2, message = "Generic error".

switchCamera(callback: (status, code, message))

Switches the device's camera. By default, Stringee SDK uses the front camera.
- callback: The result:
    + status = true, code = 0, message = "Register successfully."
    + status = false, code = -1, message = "StringeeClient is not initialized or connected".
    + status = false, code = -2, message = "Generic error".

close(callback: (status, code, message))

Release video track.
- callback: The result:
    + status = true, code = 0, message = "Register successfully."
    + status = false, code = -1, message = "StringeeClient is not initialized or connected".
    + status = false, code = -2, message = "Generic error".