MediaAccessCallFeature interface

Package:

@azure/communication-calling

Feature for media access.

Extends

CallFeature

Inherited Properties

name	The feature name.

Methods

forbidAudio(CommunicationIdentifier[])	disable audio for the attendees
forbidOthersAudio()	Send request to disable audio for all attendees on the call
forbidOthersVideo()	Send request to disable video for all attendees on the call
forbidVideo(CommunicationIdentifier[])	disable video for the attendees
getAllOthersMediaAccess()	Get the media access for all attendees
getMeetingMediaAccess()	Get the meeting setting media access
off("mediaAccessChanged", MediaAccessChangedListener)	Unsubscribe function for mediaAccessChanged event
off("meetingMediaAccessChanged", MeetingMediaAccessChangedListener)	Unsubscribe function for mediaAccessChanged event
on("mediaAccessChanged", MediaAccessChangedListener)	Subscribe function for mediaAccessChanged event
on("meetingMediaAccessChanged", MeetingMediaAccessChangedListener)	Subscribe function for meeting mediaAccessChanged event
permitAudio(CommunicationIdentifier[])	enable audio for the attendees
permitOthersAudio()	Send request to enable audio for all attendees on the call
permitOthersVideo()	Send request to enable video for all attendees on the call
permitVideo(CommunicationIdentifier[])	enable video for the attendees

Inherited Methods

dispose()

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From CallFeature.name

Method Details

forbidAudio(CommunicationIdentifier[])

disable audio for the attendees

function forbidAudio(participants: CommunicationIdentifier[]): Promise<void>

Parameters

participants

CommunicationIdentifier[]

is list of participants to disable audio for attendees

Returns

Promise<void>

forbidOthersAudio()

Send request to disable audio for all attendees on the call

function forbidOthersAudio(): Promise<void>

Returns

Promise<void>

forbidOthersVideo()

Send request to disable video for all attendees on the call

function forbidOthersVideo(): Promise<void>

Returns

Promise<void>

forbidVideo(CommunicationIdentifier[])

disable video for the attendees

function forbidVideo(participants: CommunicationIdentifier[]): Promise<void>

Parameters

participants

CommunicationIdentifier[]

is list of participants to disable video for attendees

Returns

Promise<void>

getAllOthersMediaAccess()

Get the media access for all attendees

function getAllOthersMediaAccess(): MediaAccess[]

Returns

MediaAccess[]

getMeetingMediaAccess()

Get the meeting setting media access

function getMeetingMediaAccess(): MeetingMediaAccess

Returns

MeetingMediaAccess

off("mediaAccessChanged", MediaAccessChangedListener)

Unsubscribe function for mediaAccessChanged event

function off(event: "mediaAccessChanged", listener: MediaAccessChangedListener)

Parameters

event

"mediaAccessChanged"

event name

listener

MediaAccessChangedListener

callback fn that was used to unsubscribe to this event

off("meetingMediaAccessChanged", MeetingMediaAccessChangedListener)

Unsubscribe function for mediaAccessChanged event

function off(event: "meetingMediaAccessChanged", listener: MeetingMediaAccessChangedListener)

Parameters

event

"meetingMediaAccessChanged"

event name

listener

MeetingMediaAccessChangedListener

callback fn that was used to unsubscribe to this event

on("mediaAccessChanged", MediaAccessChangedListener)

Subscribe function for mediaAccessChanged event

function on(event: "mediaAccessChanged", listener: MediaAccessChangedListener)

Parameters

event

"mediaAccessChanged"

event name

listener

MediaAccessChangedListener

callback fn that was used to subscribe to this event

on("meetingMediaAccessChanged", MeetingMediaAccessChangedListener)

Subscribe function for meeting mediaAccessChanged event

function on(event: "meetingMediaAccessChanged", listener: MeetingMediaAccessChangedListener)

Parameters

event

"meetingMediaAccessChanged"

event name

listener

MeetingMediaAccessChangedListener

callback fn that was used to subscribe to this event

permitAudio(CommunicationIdentifier[])

enable audio for the attendees

function permitAudio(participants: CommunicationIdentifier[]): Promise<void>

Parameters

participants

CommunicationIdentifier[]

is list of participants to enable Audio for attendees

Returns

Promise<void>

permitOthersAudio()

Send request to enable audio for all attendees on the call

function permitOthersAudio(): Promise<void>

Returns

Promise<void>

permitOthersVideo()

Send request to enable video for all attendees on the call

function permitOthersVideo(): Promise<void>

Returns

Promise<void>

permitVideo(CommunicationIdentifier[])

enable video for the attendees

function permitVideo(participants: CommunicationIdentifier[]): Promise<void>

Parameters

participants

CommunicationIdentifier[]

is list of participants to enable video for attendees

Returns

Promise<void>

Inherited Method Details

dispose()

function dispose()

Inherited From CallFeature.dispose