Class LocalTrackPublication

Hierarchy

TrackPublication
- LocalTrackPublication

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new LocalTrackPublication(kind: Kind, ti: TrackInfo, track?: LocalTrack): LocalTrackPublication

Overrides TrackPublication.constructor
- Defined in room/track/LocalTrackPublication.ts:13
Parameters
- kind: Kind
- ti: TrackInfo
- Optional track: LocalTrack
Returns LocalTrackPublication

Properties

Optional dimensions

dimensions: Dimensions

dimension of the original published stream, video-only

kind

kind: Kind

Optional mimeType

mimeType: string

MimeType of the published track

Optional options

options: TrackPublishOptions

Optional simulcasted

simulcasted: boolean

true if track was simulcasted to server, video-only

source

source: Source

Optional track

track: LocalTrack

trackName

trackName: string

trackSid

trackSid: string

Accessors

audioTrack

get audioTrack(): undefined | LocalAudioTrack

- Defined in room/track/LocalTrackPublication.ts:41
an [AudioTrack] if this publication holds an audio track

Returns undefined | LocalAudioTrack

isEnabled

get isEnabled(): boolean

- Defined in room/track/TrackPublication.ts:63
Returns boolean

isMuted

get isMuted(): boolean

- Defined in room/track/LocalTrackPublication.ts:34
Returns boolean

isSubscribed

get isSubscribed(): boolean

- Defined in room/track/TrackPublication.ts:67
Returns boolean

videoTrack

get videoTrack(): undefined | LocalVideoTrack

- Defined in room/track/LocalTrackPublication.ts:45
an [VideoTrack] if this publication holds a video track

Returns undefined | LocalVideoTrack

Methods

handleMuted

handleMuted(): void

Inherited from TrackPublication.handleMuted
- Defined in room/track/TrackPublication.ts:89
Returns void

handleTrackEnded

handleTrackEnded(track: LocalTrack): void

- Defined in room/track/LocalTrackPublication.ts:63
Parameters
- track: LocalTrack
Returns void

handleUnmuted

handleUnmuted(): void

Inherited from TrackPublication.handleUnmuted
- Defined in room/track/TrackPublication.ts:93
Returns void

mute

mute(): Promise<undefined | LocalTrack>

- Defined in room/track/LocalTrackPublication.ts:52
Mute the track associated with this publication

Returns Promise<undefined | LocalTrack>

setTrack

setTrack(track?: Track): void

Overrides TrackPublication.setTrack
- Defined in room/track/LocalTrackPublication.ts:22
Parameters
- Optional track: Track
Returns void

unmute

unmute(): Promise<undefined | LocalTrack>

- Defined in room/track/LocalTrackPublication.ts:59
Unmute track associated with this publication

Returns Promise<undefined | LocalTrack>

Generated using TypeDoc