The EnxStream is a derived Class from EnxRtc. It handles all the Media Stream-related functions to initiate, configure, and transport Streams to the portal Media Servers. It is also used for receiving Stream endpoints to be played.
References: Attributes – Methods – Observers
Properties
streamId
– Unique Stream ID.isLocal
– Boolean. True for Local Stream, False for Remote Stream.screen
– Boolean. True if the stream carries Screen Share.isSelfAudioMuted
– Boolean. True if Local Stream’s Audio is muted.isSelfVideoMuted
– Boolean. True if Local Stream’s Video is muted.
Methods
A categorized listing of Stream Handler methods is as given below:
Stream Information
hasAudio()
– To know if the stream has an Audio track.hasVideo()
– To know if the stream has a Video track.hasData()
– To know if the stream has Text Data.
Stream Controls
muteSelfAudio()
– To mute/unmute audio of the Local Stream.muteSelfVideo()
– To mute/unmute video of the Local Stream.switchCamera()
– To switch the Stream source from rear to front Camera or vice-versa.updateConfiguration()
– To reconfigure a Stream by adding new or updating existing attributes of the Stream.
Moderator Controls
hardMuteAudio()
– To hard mute a Participant’s audio.hardMuteVideo()
– To hard mute a Participant’s video.hardUnMuteAudio()
– To lift the audio hard-mute restriction from the Participant.hardUnMuteVideo()
– To lift the video hard-mute restriction from the Participant.
Play Stream
attachRenderer()
– To attach a Stream to the PlayerView.detachRenderer()
– To detach a Stream from the PlayerView.
Delegate Methods
Given below is a category-wise listing of delegate methods based on their functions:
Streaming
didAudioEvents
– Notification to the stream publisher when Local Stream’s Video Audio is muted/unmuted.didVideoEvents
– Notification to the stream publisher when Local Stream’s Video is muted/unmuted.stream:didSelfMuteVideo
– Notification to the stream publisher when Local Stream’s Video is muted.stream:didSelfUnmuteVideo
– Notification to the stream publisher when Local Stream’s Video is unmuted.stream:didSelfMuteAudio
– Notification to the stream publisher when Local Stream’s Audio is muted.stream:didSelfUnmuteAudio
– Notification to the stream publisher when Local Stream’s Audio is unmuted.
Messaging
didReceiveData:
– When text messages are received.
Hard Mute Audio
didhardMuteAudio
– Acknowledgment to the Moderator when the Participant’s Audio Stream is hard-muted.didhardUnMuteAudio
– Acknowledgment to the Moderator when the hard-mute restriction is lifted from the Participant’s Audio Stream.didRecievedHardMutedAudio
– Notification to the Participant when the Moderator hard-mutes their Audio Stream.didRecievedHardUnmutedAudio
– Notification to the Participant when the Moderator lifts the hard-mute restriction from their Audio Stream.
Hard Mute Video
stream:didHardVideoMute
– Acknowledgment to the Moderator when the Participant’s Video Stream is hard-muted.stream:didHardVideoUnMute
– Acknowledgment to the Moderator when the hard-mute restriction is lifted from the Participant’s Video Stream.stream:didReceivehardMuteVideo
– Notification to the Participant when the Moderator hard-mutes their Video Stream.stream:didReceivehardUnmuteVideo
– Notification to the Participant when the Moderator lifts the hard-mute restriction from their Video Stream.