/ fm / liveswitch / WssManager
Class: WssManager
fm.liveswitch.WssManager
Hierarchy
WssManagerBase<WssWebSocketConnection, WebRtcStream, WebRtcAudioStream, WebRtcVideoStream, WebRtcDataStream, WebRtcDataChannel>
↳ WssManager
Table of contents
Constructors
Properties
Methods
- addOnRoundTripTime
- bytesReceivedForStream
- bytesSentForStream
- connectionStateUpdate
- doEncode
- doScale
- drawAndEncode
- getAudioJitter
- getAudioStreamId
- getAudioTrackStats
- getBytesReceived
- getBytesSent
- getMessagesReceived
- getMessagesSent
- getPlisReceived
- getPlisRequested
- getRemoteAudioFrameRate
- getRemoteVideoFrameRate
- getRoundTripTime
- getServiceConnectionId
- getTypeString
- getVideoJitter
- getVideoStreamId
- getVideoTrackStats
- handleKeyFrameRequest
- messagesReceivedForStream
- messagesSentForStream
- onAudioFrame
- onAudioMaxSendBitrateChange
- onVideoFrame
- onVideoMaxSendBitrateChange
- processReceiverAudioStats
- processReceiverVideoStats
- removeOnRoundTripTime
- requestKeyFrame
- requestRemoteKeyFrame
- sendConnectionUpdate
- setMediaTrackStatsForAudio
- setMediaTrackStatsForVideo
- stop
- streamLocalMedia
- streamRemoteMedia
Constructors
constructor
+ new WssManager(openArgs: WssServiceOpenArgs, internalConnection: WssWebSocketConnection, webSocketFactory: IFunction1<string, IWebSocket>): WssManager
Parameters:
| Name | Type |
|---|---|
openArgs |
WssServiceOpenArgs |
internalConnection |
WssWebSocketConnection |
webSocketFactory |
IFunction1<string, IWebSocket> |
Returns: WssManager
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:30
Properties
__connection
• Protected __connection: WssWebSocketConnectionBase<WssWebSocketConnection, WebRtcStream, WebRtcAudioStream, WebRtcVideoStream, WebRtcDataStream, WebRtcDataChannel>
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:14
Methods
addOnRoundTripTime
▸ addOnRoundTripTime(value: IAction1<number>): void
Parameters:
| Name | Type |
|---|---|
value |
IAction1<number> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:115
bytesReceivedForStream
▸ bytesReceivedForStream(streamId: number): number
Parameters:
| Name | Type |
|---|---|
streamId |
number |
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:122
bytesSentForStream
▸ bytesSentForStream(streamId: number): number
Parameters:
| Name | Type |
|---|---|
streamId |
number |
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:130
connectionStateUpdate
▸ connectionStateUpdate(connectionState: ConnectionState): void
Parameters:
| Name | Type |
|---|---|
connectionState |
ConnectionState |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:145
doEncode
▸ PrivatedoEncode(frame: ImageData | ImageBitmap, timestampMicroseconds: number): void
Parameters:
| Name | Type |
|---|---|
frame |
ImageData | ImageBitmap |
timestampMicroseconds |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:91
doScale
▸ PrivatedoScale(frame: ImageData | ImageBitmap, timestampMicroseconds: number): void
Parameters:
| Name | Type |
|---|---|
frame |
ImageData | ImageBitmap |
timestampMicroseconds |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:111
drawAndEncode
▸ PrivatedrawAndEncode(bitmap: ImageBitmap, width: number, height: number, timestampMicroseconds: number): void
Parameters:
| Name | Type |
|---|---|
bitmap |
ImageBitmap |
width |
number |
height |
number |
timestampMicroseconds |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:138
getAudioJitter
▸ getAudioJitter(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:194
getAudioStreamId
▸ getAudioStreamId(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:201
getAudioTrackStats
▸ getAudioTrackStats(): MediaTrackStats
Returns: MediaTrackStats
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:207
getBytesReceived
▸ getBytesReceived(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:208
getBytesSent
▸ getBytesSent(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:215
getMessagesReceived
▸ getMessagesReceived(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:222
getMessagesSent
▸ getMessagesSent(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:229
getPlisReceived
▸ getPlisReceived(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:236
getPlisRequested
▸ getPlisRequested(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:243
getRemoteAudioFrameRate
▸ getRemoteAudioFrameRate(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:250
getRemoteVideoFrameRate
▸ getRemoteVideoFrameRate(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:257
getRoundTripTime
▸ getRoundTripTime(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:264
getServiceConnectionId
▸ getServiceConnectionId(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:271
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:6
getVideoJitter
▸ getVideoJitter(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:278
getVideoStreamId
▸ getVideoStreamId(): number
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:285
getVideoTrackStats
▸ getVideoTrackStats(): MediaTrackStats
Returns: MediaTrackStats
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:198
handleKeyFrameRequest
▸ handleKeyFrameRequest(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:292
messagesReceivedForStream
▸ messagesReceivedForStream(streamId: number): number
Parameters:
| Name | Type |
|---|---|
streamId |
number |
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:333
messagesSentForStream
▸ messagesSentForStream(streamId: number): number
Parameters:
| Name | Type |
|---|---|
streamId |
number |
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:341
onAudioFrame
▸ onAudioFrame(audioData: Float32Array, timestampMicroseconds: number): void
Parameters:
| Name | Type |
|---|---|
audioData |
Float32Array |
timestampMicroseconds |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:144
onAudioMaxSendBitrateChange
▸ PrivateonAudioMaxSendBitrateChange(bitrateKbps: number): void
Parameters:
| Name | Type |
|---|---|
bitrateKbps |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:257
onVideoFrame
▸ onVideoFrame(frame: ImageData | ImageBitmap, timestampMicroseconds: number): void
Parameters:
| Name | Type |
|---|---|
frame |
ImageData | ImageBitmap |
timestampMicroseconds |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:81
onVideoMaxSendBitrateChange
▸ PrivateonVideoMaxSendBitrateChange(bitrateKbps: number): void
Parameters:
| Name | Type |
|---|---|
bitrateKbps |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:251
processReceiverAudioStats
▸ processReceiverAudioStats(mediaReceiverStats: MediaReceiverStats): Future<Object>
Parameters:
| Name | Type |
|---|---|
mediaReceiverStats |
MediaReceiverStats |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:279
processReceiverVideoStats
▸ processReceiverVideoStats(mediaReceiverStats: MediaReceiverStats): Future<Object>
Parameters:
| Name | Type |
|---|---|
mediaReceiverStats |
MediaReceiverStats |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:297
removeOnRoundTripTime
▸ removeOnRoundTripTime(value: IAction1<number>): void
Parameters:
| Name | Type |
|---|---|
value |
IAction1<number> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:448
requestKeyFrame
▸ requestKeyFrame(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:49
requestRemoteKeyFrame
▸ requestRemoteKeyFrame(streamId: number): void
Parameters:
| Name | Type |
|---|---|
streamId |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:457
sendConnectionUpdate
▸ sendConnectionUpdate(promise: Promise<Object>, updateMuteLocalAudio: boolean, muteLocalAudio: boolean, updateDisableLocalAudio: boolean, disableLocalAudio: boolean, updateDisableRemoteAudio: boolean, disableRemoteAudio: boolean, updateMuteLocalVideo: boolean, muteLocalVideo: boolean, updateDisableLocalVideo: boolean, disableLocalVideo: boolean, updateDisableRemoteVideo: boolean, disableRemoteVideo: boolean): void
Parameters:
| Name | Type |
|---|---|
promise |
Promise<Object> |
updateMuteLocalAudio |
boolean |
muteLocalAudio |
boolean |
updateDisableLocalAudio |
boolean |
disableLocalAudio |
boolean |
updateDisableRemoteAudio |
boolean |
disableRemoteAudio |
boolean |
updateMuteLocalVideo |
boolean |
muteLocalVideo |
boolean |
updateDisableLocalVideo |
boolean |
disableLocalVideo |
boolean |
updateDisableRemoteVideo |
boolean |
disableRemoteVideo |
boolean |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:491
setMediaTrackStatsForAudio
▸ setMediaTrackStatsForAudio(mediaTrackStats: MediaTrackStats): Future<Object>
Parameters:
| Name | Type |
|---|---|
mediaTrackStats |
MediaTrackStats |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:263
setMediaTrackStatsForVideo
▸ setMediaTrackStatsForVideo(mediaTrackStats: MediaTrackStats): Future<Object>
Parameters:
| Name | Type |
|---|---|
mediaTrackStats |
MediaTrackStats |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:271
stop
▸ stop(): Future<WebSocketCloseCompleteArgs>
Returns: Future<WebSocketCloseCompleteArgs>
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:155
streamLocalMedia
▸ streamLocalMedia(localMediaForAudio: LocalMedia, localMediaForVideo: LocalMedia, audioStreamId: number, videoStreamId: number, audioBitrate: number, videoBitrate: number): void
Parameters:
| Name | Type |
|---|---|
localMediaForAudio |
LocalMedia |
localMediaForVideo |
LocalMedia |
audioStreamId |
number |
videoStreamId |
number |
audioBitrate |
number |
videoBitrate |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManager.ts:55
streamRemoteMedia
▸ streamRemoteMedia(remoteMedia: RemoteMedia, audioStreamId: number, videoStreamId: number, videoStreamInfo: MediaStreamInfo): void
Parameters:
| Name | Type |
|---|---|
remoteMedia |
RemoteMedia |
audioStreamId |
number |
videoStreamId |
number |
videoStreamInfo |
MediaStreamInfo |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/WssManagerBase.ts:657