Class HMSLocalAudioTrack

Represents an audio track within the HMS (100ms) system.

This class extends HMSTrack to provide functionalities specific to audio tracks. It includes a constructor that allows for the initialization of the audio track with various parameters such as track ID, source, description, mute state, ID, and type. These parameters provide detailed information about the audio track and its characteristics.

Hierarchy

Constructors

constructor

Properties

id mute? settings? source? trackDescription? trackId type?

Methods

getVolume isMute setMute

Constructors

constructor

Properties

id

id: string

A secondary identifier for the track.

Optional mute

mute?: boolean

Indicates whether the track is currently muted.

Optional settings

settings?: HMSAudioTrackSettings

Optional source

source?: HMSTrackSource

The source of the track, indicating whether it's from a plugin, regular input, or screen sharing.

Optional trackDescription

trackDescription?: string

A brief description of the track.

trackId

trackId: string

The unique identifier for the track.

Optional type

type?: HMSTrackType

The type of the track, distinguishing between audio and video.

Methods

getVolume

isMute

setMute

  • Switches Audio of current user on/off depending upon the value of isMute

    Parameters

    • isMute: boolean

    Returns void

    Memberof

    HMSLocalAudioTrack

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc