Class: Member

Member(conversation, params)

new Member(conversation, params)

An individual user (i.e. conversation member).
Parameters:
Name Type Description
conversation Conversation
params object
Source:

Methods

earmuff(paramsopt) → {Promise}

Earmuff this member
Parameters:
Name Type Attributes Description
params boolean <optional>
Source:
Returns:
Type
Promise

kick() → {Promise}

Kick this member from the conversation
Source:
Returns:
Type
Promise

mute(muteopt, audioopt, videoopt, streamIndexopt)

Mute a stream
Parameters:
Name Type Attributes Default Description
mute boolean <optional>
true for mute, false for unmute
audio boolean <optional>
true true for audio stream
video boolean <optional>
false true for video stream
streamIndex number <optional>
stream index of the stream
Source:
Examples

Mute audio stream

media.mute(true, true, false)

Mute audio and video streams

media.mute(true, true, true)

Mute only video

media.mute(true, false, true)

Events

media:connection:fail

Member listening for rtc connection fail.
Properties:
Name Type Description
payload.rtc_id number the rtc_id / leg_id
payload.remote_member_id string the id of the Member the stream belongs to
payload.connection_event event the connection fail event
payload.streamIndex number the streamIndex of the specific stream
payload.type string the type of the connection (video or screenshare)
Source:

media:stream:on

Member listening for audio stream on.
Properties:
Name Type Attributes Description
payload.streamIndex number the index number of this stream
payload.rtc_id number <optional>
the rtc_id / leg_id
payload.remote_member_id string <optional>
the id of the Member the stream belongs to
payload.name string <optional>
the stream's display name
payload.stream MediaStream the stream that is activated
payload.video_mute boolean <optional>
if the video is hidden
payload.audio_mute boolean <optional>
if the audio is muted
Source: