Class: Member

Member


new Member(conversation, params)

An individual user (i.e. conversation member).

Parameters:
Name Type Description
conversation Conversation
params object
Source:

Methods


earmuff(earmuff)

Earmuff this member

Parameters:
Name Type Description
earmuff boolean

true or false

Source:
Returns:
Type
Promise

<async> kick( [reason])

Kick this member from the conversation

Parameters:
Name Type Argument Description
reason object <optional>

the reason for kicking out a member

Properties
Name Type Argument Description
reason_code string <optional>

the code of the reason

reason_text string <optional>

the description of the reason

Source:
Returns:
Type
Promise

mute( [mute] [, streamIndex])

Mute a stream

Parameters:
Name Type Argument Default Description
mute boolean <optional>

true for mute, false for unmute

streamIndex number <optional>
null

stream index of the stream

Source:
Returns:
Type
Promise
Example

Mute audio stream

media.mute(true)

Events


media:stream:on

Member listening for audio stream on.

Properties:
Name Type Argument 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.audio_mute boolean <optional>

if the audio is muted

Source: