PlatformMethod enum

platformmethods to use to interact with specific platform

Inheritance
Available extensions

Values

join → const PlatformMethod

join meeting using this.

leave → const PlatformMethod

leave meeting

onLeave → const PlatformMethod
onJoinRoom → const PlatformMethod

when onJoin callback is called

onUpdateRoom → const PlatformMethod

when room is updated.

onPeerUpdate → const PlatformMethod

when there is any change in peer in a room.

onTrackUpdate → const PlatformMethod

when there is track updates

onError → const PlatformMethod

when onError update is called

onMessage → const PlatformMethod
sendBroadcastMessage → const PlatformMethod

when you want to send a broadcast message.

sendDirectMessage → const PlatformMethod

when you want to send a direct message.

sendGroupMessage → const PlatformMethod

when you want to send a group message.

onUpdateSpeaker → const PlatformMethod
onReconnecting → const PlatformMethod

when reconnecting update method is called.

onReconnected → const PlatformMethod

when reconnected update method is called.

switchAudio → const PlatformMethod

switch mic on/off.

switchVideo → const PlatformMethod

switch video on/off

switchCamera → const PlatformMethod

switch your camera.

isAudioMute → const PlatformMethod

check whether audio is mute or not.

isVideoMute → const PlatformMethod

check whether video is mute or not.

preview → const PlatformMethod

get tracks for preview.

acceptChangeRole → const PlatformMethod

accept role changes suggestedBy any peer.

changeRole → const PlatformMethod

change your peer role.

changeRoleOfPeer → const PlatformMethod

change role for peer.

startScreenShare → const PlatformMethod
stopScreenShare → const PlatformMethod
isScreenShareActive → const PlatformMethod
getRoles → const PlatformMethod

get list of roles using this.

changeTrackState → const PlatformMethod
endRoom → const PlatformMethod

end room

removePeer → const PlatformMethod

remove peer from room

muteRoomAudioLocally → const PlatformMethod
unMuteRoomAudioLocally → const PlatformMethod
muteRoomVideoLocally → const PlatformMethod
unMuteRoomVideoLocally → const PlatformMethod
getLocalPeer → const PlatformMethod
getRemotePeers → const PlatformMethod
getPeers → const PlatformMethod
unknown → const PlatformMethod
startHMSLogger → const PlatformMethod
removeHMSLogger → const PlatformMethod
changeTrackStateForRole → const PlatformMethod
startRtmpOrRecording → const PlatformMethod

start rtmp or recording

stopRtmpAndRecording → const PlatformMethod

stop rtmp and recording

build → const PlatformMethod
getRoom → const PlatformMethod
changeMetadata → const PlatformMethod

change metadata for local peer

setVolume → const PlatformMethod
changeName → const PlatformMethod

change name of local peer

startHlsStreaming → const PlatformMethod

start HLS Streaming

stopHlsStreaming → const PlatformMethod

stop HLS Streaming

getAllTracks → const PlatformMethod

Get List all tracks

getTrackById → const PlatformMethod

Get track with the help of trackId

startStatsListener → const PlatformMethod
removeStatsListener → const PlatformMethod
getAudioDevicesList → const PlatformMethod
getCurrentAudioDevice → const PlatformMethod
switchAudioOutput → const PlatformMethod
startAudioShare → const PlatformMethod
stopAudioShare → const PlatformMethod
setAudioMixingMode → const PlatformMethod
pauseAudioShare → const PlatformMethod
playAudioShare → const PlatformMethod
resumeAudioShare → const PlatformMethod
setAudioShareVolume → const PlatformMethod
audioSharePlaying → const PlatformMethod
audioShareCurrentTime → const PlatformMethod
audioShareDuration → const PlatformMethod
getTrackSettings → const PlatformMethod
destroy → const PlatformMethod
setPlaybackAllowedForTrack → const PlatformMethod
enterPipMode → const PlatformMethod
isPipActive → const PlatformMethod
isPipAvailable → const PlatformMethod
changeRoleOfPeersWithRoles → const PlatformMethod
setSimulcastLayer → const PlatformMethod
getLayer → const PlatformMethod
getLayerDefinition → const PlatformMethod
setupPIP → const PlatformMethod
startPIP → const PlatformMethod
stopPIP → const PlatformMethod
changeTrackPIP → const PlatformMethod
changeTextPIP → const PlatformMethod
destroyPIP → const PlatformMethod
toggleMicMuteState → const PlatformMethod
toggleCameraMuteState → const PlatformMethod
captureSnapshot → const PlatformMethod
getAllLogs → const PlatformMethod
getAuthTokenByRoomCode → const PlatformMethod
captureImageAtMaxSupportedResolution → const PlatformMethod

Camera Controls

isFlashSupported → const PlatformMethod
toggleFlash → const PlatformMethod
isZoomSupported → const PlatformMethod
setZoom → const PlatformMethod
resetZoom → const PlatformMethod
getMaxZoom → const PlatformMethod
getMinZoom → const PlatformMethod
getSessionMetadataForKey → const PlatformMethod
setSessionMetadataForKey → const PlatformMethod
addKeyChangeListener → const PlatformMethod
removeKeyChangeListener → const PlatformMethod
start → const PlatformMethod

HLS Player methods

stop → const PlatformMethod
pause → const PlatformMethod
resume → const PlatformMethod
seekToLivePosition → const PlatformMethod
seekForward → const PlatformMethod
seekBackward → const PlatformMethod
setHLSPlayerVolume → const PlatformMethod
addHLSStatsListener → const PlatformMethod
removeHLSStatsListener → const PlatformMethod
areClosedCaptionsSupported → const PlatformMethod
enableClosedCaptions → const PlatformMethod
disableClosedCaptions → const PlatformMethod
getStreamProperties → const PlatformMethod
getHLSLayers → const PlatformMethod
setHLSLayer → const PlatformMethod
getCurrentHLSLayer → const PlatformMethod
switchAudioOutputUsingiOSUI → const PlatformMethod
sendHLSTimedMetadata → const PlatformMethod
toggleAlwaysScreenOn → const PlatformMethod
getRoomLayout → const PlatformMethod
previewForRole → const PlatformMethod
cancelPreview → const PlatformMethod
getPeerListIterator → const PlatformMethod

PeerListIteratorMethods

peerListIteratorHasNext → const PlatformMethod
peerListIteratorNext → const PlatformMethod
lowerLocalPeerHand → const PlatformMethod

Raise/Lower Hand

lowerRemotePeerHand → const PlatformMethod
raiseLocalPeerHand → const PlatformMethod
createTextureView → const PlatformMethod

TextureView methods

disposeTextureView → const PlatformMethod
addTrack → const PlatformMethod
removeTrack → const PlatformMethod
setDisplayResolution → const PlatformMethod
addPollUpdateListener → const PlatformMethod

Poll methods

removePollUpdateListener → const PlatformMethod
quickStartPoll → const PlatformMethod
addSingleChoicePollResponse → const PlatformMethod
addMultiChoicePollResponse → const PlatformMethod
stopPoll → const PlatformMethod
fetchLeaderboard → const PlatformMethod
fetchPollList → const PlatformMethod
fetchPollQuestions → const PlatformMethod
getPollResults → const PlatformMethod
enableNoiseCancellation → const PlatformMethod

Noise cancellation methods

disableNoiseCancellation → const PlatformMethod
isNoiseCancellationEnabled → const PlatformMethod
isNoiseCancellationAvailable → const PlatformMethod
startWhiteboard → const PlatformMethod

Whiteboard methods

stopWhiteboard → const PlatformMethod
addWhiteboardUpdateListener → const PlatformMethod
removeWhiteboardUpdateListener → const PlatformMethod
enableVirtualBackground → const PlatformMethod

Virtual background methods

disableVirtualBackground → const PlatformMethod
changeVirtualBackground → const PlatformMethod
enableBlurBackground → const PlatformMethod
disableBlurBackground → const PlatformMethod
isVirtualBackgroundSupported → const PlatformMethod
startRealTimeTranscription → const PlatformMethod

Transcription methods

stopRealTimeTranscription → const PlatformMethod
addTranscriptListener → const PlatformMethod
removeTranscriptListener → const PlatformMethod

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
name String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<PlatformMethod>
A constant List of the values in this enum, in order of their declaration.