Class TrackPublication

Hierarchy (view full)

TypedEventEmitter<PublicationEventCallbacks, this>
- TrackPublication
  - LocalTrackPublication
  - RemoteTrackPublication

Index

Constructors

Properties

dimensions? kind mimeType? simulcasted? source track? trackName trackSid

Accessors

audioTrack isEnabled isEncrypted isMuted isSubscribed videoTrack

Methods

handleMuted handleUnmuted

Constructors

constructor

new TrackPublication(kind, id, name, loggerOptions?): TrackPublication
Parameters
- kind: Kind
- id: string
- name: string
- Optional loggerOptions: LoggerOptions
Returns TrackPublication
Overrides (EventEmitter as new () => TypedEventEmitter<PublicationEventCallbacks>).constructor
- Defined in src/room/track/TrackPublication.ts:52

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` simulcasted

simulcasted?: boolean

true if track was simulcasted to server, video-only

source

source: Source

`Optional` track

track?: Track<Kind>

trackName

trackName: string

trackSid

trackSid: string

Accessors

audioTrack

get audioTrack(): undefined | LocalAudioTrack | RemoteAudioTrack
an [AudioTrack] if this publication holds an audio track

Returns undefined | LocalAudioTrack | RemoteAudioTrack
- Defined in src/room/track/TrackPublication.ts:105

isEnabled

get isEnabled(): boolean
Returns boolean
- Defined in src/room/track/TrackPublication.ts:90

isEncrypted

get isEncrypted(): boolean
Returns boolean
- Defined in src/room/track/TrackPublication.ts:98

isMuted

get isMuted(): boolean
Returns boolean
- Defined in src/room/track/TrackPublication.ts:86

isSubscribed

get isSubscribed(): boolean
Returns boolean
- Defined in src/room/track/TrackPublication.ts:94

videoTrack

get videoTrack(): undefined | LocalVideoTrack | RemoteVideoTrack
an [VideoTrack] if this publication holds a video track

Returns undefined | LocalVideoTrack | RemoteVideoTrack
- Defined in src/room/track/TrackPublication.ts:114

Methods

handleMuted

handleMuted(): void
Returns void
- Defined in src/room/track/TrackPublication.ts:120

handleUnmuted

handleUnmuted(): void
Returns void
- Defined in src/room/track/TrackPublication.ts:124

Generated using TypeDoc