Class HMSEncoder

Hierarchy

HMSEncoder

Index

Constructors

Methods

clearData encodeBrowserRecordingState encodeDate encodeHLSRecordingState encodeHLSStreamingState encodeHLSVariants encodeHMSException encodeHMSLocalAudioStats encodeHMSLocalVideoStats encodeHMSMessage encodeHMSMessageRecipient encodeHMSNetworkQuality encodeHMSQualityLimitationReasons encodeHMSRemoteAudioStats encodeHMSRemoteVideoStats encodeHMSSimulcastLayerDefinition encodeHmsAudioTrack encodeHmsAudioTrackSettings encodeHmsAuxiliaryTracks encodeHmsChangeTrackStateRequest encodeHmsLocalAudioTrack encodeHmsLocalPeer encodeHmsLocalVideoTrack encodeHmsPeer encodeHmsPeerUpdate encodeHmsPeers encodeHmsPreviewForRoleTracks encodeHmsPreviewTracks encodeHmsRemoteAudioTrack encodeHmsRemotePeer encodeHmsRemotePeers encodeHmsRemoteVideoTrack encodeHmsRole encodeHmsRoleChangeRequest encodeHmsRoles encodeHmsRoom encodeHmsSpeaker encodeHmsSpeakers encodeHmsTrack encodeHmsVideoResolution encodeHmsVideoTrack encodeHmsVideoTrackSettings encodeRTCStats encodeRTCStatsUnit encodeRTMPStreamingState encodeServerRecordingState encodeTranscriptions getHLSVariantPlaylistType transformHMSHLSCueEventData transformTranscripts

Constructors

constructor

new HMSEncoder(): HMSEncoder
Returns HMSEncoder

Methods

`Static` clearData

clearData(): void
Returns void
- Defined in src/classes/HMSEncoder.ts:53

`Static` encodeBrowserRecordingState

encodeBrowserRecordingState(data): HMSBrowserRecordingState
Parameters
- data: any
Returns HMSBrowserRecordingState
- Defined in src/classes/HMSEncoder.ts:451

`Static` encodeDate

encodeDate(dateData): undefined | Date
Parameters
- dateData: any
Returns undefined | Date
- Defined in src/classes/HMSEncoder.ts:480

`Static` encodeHLSRecordingState

encodeHLSRecordingState(data): undefined | HMSHLSRecordingState
Parameters
- data: any
Returns undefined | HMSHLSRecordingState
- Defined in src/classes/HMSEncoder.ts:503

`Static` encodeHLSStreamingState

encodeHLSStreamingState(data): HMSHLSStreamingState
Parameters
- data: any
Returns HMSHLSStreamingState
- Defined in src/classes/HMSEncoder.ts:491

`Static` encodeHLSVariants

encodeHLSVariants(data): HMSHLSVariant[]
Parameters
- data: any
Returns HMSHLSVariant[]
- Defined in src/classes/HMSEncoder.ts:516

`Static` encodeHMSException

encodeHMSException(data): HMSException
Parameters
- data: any
Returns HMSException
- Defined in src/classes/HMSEncoder.ts:581

`Static` encodeHMSLocalAudioStats

encodeHMSLocalAudioStats(data): HMSLocalAudioStats
Parameters
- data: any
Returns HMSLocalAudioStats
- Defined in src/classes/HMSEncoder.ts:593

`Static` encodeHMSLocalVideoStats

encodeHMSLocalVideoStats(data): HMSLocalVideoStats[]
Parameters
- data: any[]
Returns HMSLocalVideoStats[]
- Defined in src/classes/HMSEncoder.ts:603

`Static` encodeHMSMessage

encodeHMSMessage(data): undefined | HMSMessage
Parameters
- data: any
Returns undefined | HMSMessage
- Defined in src/classes/HMSEncoder.ts:554

`Static` encodeHMSMessageRecipient

encodeHMSMessageRecipient(data): HMSMessageRecipient
Parameters
- data: any
Returns HMSMessageRecipient
- Defined in src/classes/HMSEncoder.ts:569

`Static` encodeHMSNetworkQuality

encodeHMSNetworkQuality(data): undefined | HMSNetworkQuality
Parameters
- data: any
Returns undefined | HMSNetworkQuality
- Defined in src/classes/HMSEncoder.ts:544

`Static` encodeHMSQualityLimitationReasons

encodeHMSQualityLimitationReasons(data): HMSQualityLimitationReasons
Parameters
- data: any
Returns HMSQualityLimitationReasons
- Defined in src/classes/HMSEncoder.ts:679

`Static` encodeHMSRemoteAudioStats

encodeHMSRemoteAudioStats(data): HMSRemoteAudioStats
Parameters
- data: any
Returns HMSRemoteAudioStats
- Defined in src/classes/HMSEncoder.ts:631

`Static` encodeHMSRemoteVideoStats

encodeHMSRemoteVideoStats(data): HMSRemoteVideoStats
Parameters
- data: any
Returns HMSRemoteVideoStats
- Defined in src/classes/HMSEncoder.ts:643

`Static` encodeHMSSimulcastLayerDefinition

encodeHMSSimulcastLayerDefinition(data): HMSSimulcastLayerDefinition[]
Parameters
- data: any[]
Returns HMSSimulcastLayerDefinition[]
- Defined in src/classes/HMSEncoder.ts:667

`Static` encodeHmsAudioTrack

encodeHmsAudioTrack(track, id): HMSAudioTrack
Parameters
- track: any
- id: string
Returns HMSAudioTrack
- Defined in src/classes/HMSEncoder.ts:109

`Static` encodeHmsAudioTrackSettings

encodeHmsAudioTrackSettings(settings): HMSAudioTrackSettings
Parameters
- settings: any
Returns HMSAudioTrackSettings
- Defined in src/classes/HMSEncoder.ts:196

`Static` encodeHmsAuxiliaryTracks

encodeHmsAuxiliaryTracks(tracks, id): HMSTrack[]
Parameters
- tracks: any
- id: string
Returns HMSTrack[]
- Defined in src/classes/HMSEncoder.ts:136

`Static` encodeHmsChangeTrackStateRequest

encodeHmsChangeTrackStateRequest(data): HMSChangeTrackStateRequest
Parameters
- data: HMSChangeTrackStateRequest
Returns HMSChangeTrackStateRequest
- Defined in src/classes/HMSEncoder.ts:391

`Static` encodeHmsLocalAudioTrack

encodeHmsLocalAudioTrack(track, id): HMSLocalAudioTrack
Parameters
- track: any
- id: string
Returns HMSLocalAudioTrack
- Defined in src/classes/HMSEncoder.ts:227

`Static` encodeHmsLocalPeer

encodeHmsLocalPeer(peer, id): HMSLocalPeer
Parameters
- peer: any
- id: string
Returns HMSLocalPeer
- Defined in src/classes/HMSEncoder.ts:157

`Static` encodeHmsLocalVideoTrack

encodeHmsLocalVideoTrack(track, id): HMSLocalVideoTrack
Parameters
- track: any
- id: string
Returns HMSLocalVideoTrack
- Defined in src/classes/HMSEncoder.ts:243

`Static` encodeHmsPeer

encodeHmsPeer(peer): HMSPeer
Parameters
- peer: any
Returns HMSPeer
- Defined in src/classes/HMSEncoder.ts:96

`Static` encodeHmsPeerUpdate

encodeHmsPeerUpdate(hmsPeerUpdateOrdinal): undefined | HMSPeerUpdate
Parameters
- hmsPeerUpdateOrdinal: string
Returns undefined | HMSPeerUpdate
- Defined in src/classes/HMSEncoder.ts:105

`Static` encodeHmsPeers

encodeHmsPeers(peers): HMSPeer[]
Parameters
- peers: any
Returns HMSPeer[]
- Defined in src/classes/HMSEncoder.ts:87

`Static` encodeHmsPreviewForRoleTracks

encodeHmsPreviewForRoleTracks(previewTracks, id): (HMSLocalAudioTrack | HMSLocalVideoTrack)[]
Parameters
- previewTracks: any[]
- id: string
Returns (HMSLocalAudioTrack | HMSLocalVideoTrack)[]
- Defined in src/classes/HMSEncoder.ts:332

`Static` encodeHmsPreviewTracks

encodeHmsPreviewTracks(previewTracks, id): HMSTrack[]
Parameters
- previewTracks: any[]
- id: string
Returns HMSTrack[]
- Defined in src/classes/HMSEncoder.ts:326

`Static` encodeHmsRemoteAudioTrack

encodeHmsRemoteAudioTrack(track, id): HMSRemoteAudioTrack
Parameters
- track: any
- id: string
Returns HMSRemoteAudioTrack
- Defined in src/classes/HMSEncoder.ts:300

`Static` encodeHmsRemotePeer

encodeHmsRemotePeer(peer, id): HMSRemotePeer
Parameters
- peer: any
- id: string
Returns HMSRemotePeer
- Defined in src/classes/HMSEncoder.ts:271

`Static` encodeHmsRemotePeers

encodeHmsRemotePeers(peers, id): HMSRemotePeer[]
Parameters
- peers: any
- id: string
Returns HMSRemotePeer[]
- Defined in src/classes/HMSEncoder.ts:259

`Static` encodeHmsRemoteVideoTrack

encodeHmsRemoteVideoTrack(track, id): HMSRemoteVideoTrack
Parameters
- track: any
- id: string
Returns HMSRemoteVideoTrack
- Defined in src/classes/HMSEncoder.ts:313

`Static` encodeHmsRole

encodeHmsRole(role): HMSRole
Parameters
- role: any
Returns HMSRole
- Defined in src/classes/HMSEncoder.ts:350

`Static` encodeHmsRoleChangeRequest

encodeHmsRoleChangeRequest(data): HMSRoleChangeRequest
Parameters
- data: any
Returns HMSRoleChangeRequest
- Defined in src/classes/HMSEncoder.ts:380

`Static` encodeHmsRoles

encodeHmsRoles(roles): HMSRole[]
Parameters
- roles: any[]
Returns HMSRole[]
- Defined in src/classes/HMSEncoder.ts:340

`Static` encodeHmsRoom

encodeHmsRoom(room, id): HMSRoom
Parameters
- room: any
- id: string
Returns HMSRoom
- Defined in src/classes/HMSEncoder.ts:57

`Static` encodeHmsSpeaker

encodeHmsSpeaker(data, id): HMSSpeaker
Parameters
- data: any
- id: string
Returns HMSSpeaker
- Defined in src/classes/HMSEncoder.ts:443

`Static` encodeHmsSpeakers

encodeHmsSpeakers(data, id): HMSSpeaker[]
Parameters
- data: any
- id: string
Returns HMSSpeaker[]
- Defined in src/classes/HMSEncoder.ts:433

`Static` encodeHmsTrack

encodeHmsTrack(track, id): HMSTrack
Parameters
- track: any
- id: string
Returns HMSTrack
- Defined in src/classes/HMSEncoder.ts:144

`Static` encodeHmsVideoResolution

encodeHmsVideoResolution(resolution): HMSVideoResolution
Parameters
- resolution: any
Returns HMSVideoResolution
- Defined in src/classes/HMSEncoder.ts:218

`Static` encodeHmsVideoTrack

encodeHmsVideoTrack(track, id): HMSVideoTrack
Parameters
- track: any
- id: string
Returns HMSVideoTrack
- Defined in src/classes/HMSEncoder.ts:122

`Static` encodeHmsVideoTrackSettings

encodeHmsVideoTrackSettings(settings): HMSVideoTrackSettings
Parameters
- settings: any
Returns HMSVideoTrackSettings
- Defined in src/classes/HMSEncoder.ts:206

`Static` encodeRTCStats

encodeRTCStats(data): HMSRTCStatsReport
Parameters
- data: any
Returns HMSRTCStatsReport
- Defined in src/classes/HMSEncoder.ts:403

`Static` encodeRTCStatsUnit

encodeRTCStatsUnit(data): HMSRTCStats
Parameters
- data: any
Returns HMSRTCStats
- Defined in src/classes/HMSEncoder.ts:411

`Static` encodeRTMPStreamingState

encodeRTMPStreamingState(data): HMSRtmpStreamingState
Parameters
- data: any
Returns HMSRtmpStreamingState
- Defined in src/classes/HMSEncoder.ts:471

`Static` encodeServerRecordingState

encodeServerRecordingState(data): HMSServerRecordingState
Parameters
- data: any
Returns HMSServerRecordingState
- Defined in src/classes/HMSEncoder.ts:462

`Static` encodeTranscriptions

encodeTranscriptions(data): Transcriptions[]
Parameters
- data: any[]
Returns Transcriptions[]
- Defined in src/classes/HMSEncoder.ts:705

`Static` getHLSVariantPlaylistType

getHLSVariantPlaylistType(type): HMSHLSPlaylistType
Parameters
- type: String
Returns HMSHLSPlaylistType
- Defined in src/classes/HMSEncoder.ts:535

`Static` transformHMSHLSCueEventData

transformHMSHLSCueEventData<C, T>(data): T
Type Parameters
- C extends object
- T
Parameters
- data: C
Returns T
- Defined in src/classes/HMSEncoder.ts:691

`Static` transformTranscripts

transformTranscripts(data): void
Parameters
- data: any[]
Returns void
- Defined in src/classes/HMSEncoder.ts:729

Generated using TypeDoc