CallAdapterCallManagement interface
Warning
This API is now deprecated.
CallAdapter interface will be flatten, consider using CallAdapter directly
Functionality for managing the current call or start a new call
- Extends
Methods
| join |
Join the call with microphone initially on/off. |
| start |
Start the call. |
Inherited Methods
| create |
Create the html view for a stream. |
| dispose |
Dispose the html view for a stream. |
| leave |
Leave the call |
| mute() | Mute the current user during the call or disable microphone locally |
| remove |
Remove a participant from the call. |
| start |
Start the camera This method will start rendering a local camera view when the call is not active |
| start |
Start sharing the screen during a call. |
| stop |
Stop the camera This method will stop rendering a local camera view when the call is not active |
| stop |
Stop sharing the screen |
| unmute() | Unmute the current user during the call or enable microphone locally |
Method Details
joinCall(boolean)
Join the call with microphone initially on/off.
function joinCall(microphoneOn?: boolean): undefined | CallParameters
- microphoneOn
-
boolean
Whether microphone is initially enabled
Returns
undefined | Call
startCall(string[], StartCallOptions)
Start the call.
function startCall(participants: string[], options?: StartCallOptions): undefined | CallParameters
- participants
-
string[]
An array of participant ids to join
- options
- StartCallOptions
Returns
undefined | Call
Inherited Method Details
createStreamView(string, VideoStreamOptions)
Create the html view for a stream.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>Parameters
- remoteUserId
-
string
Id of the participant to render, leave it undefined to create the local camera view
- options
- VideoStreamOptions
Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Returns
Promise<void | CreateVideoStreamViewResult>
Remarks
This method is implemented for composite
Inherited From CallAdapterCallOperations.createStreamView
disposeStreamView(string, VideoStreamOptions)
Dispose the html view for a stream.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>Parameters
- remoteUserId
-
string
Id of the participant to render, leave it undefined to dispose the local camera view
- options
- VideoStreamOptions
Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Returns
Promise<void>
Remarks
This method is implemented for composite
Inherited From CallAdapterCallOperations.disposeStreamView
leaveCall(boolean)
Leave the call
function leaveCall(forEveryone?: boolean): Promise<void>Parameters
- forEveryone
-
boolean
Whether to remove all participants when leaving
Returns
Promise<void>
Inherited From CallAdapterCallOperations.leaveCall
mute()
Mute the current user during the call or disable microphone locally
function mute(): Promise<void>Returns
Promise<void>
Inherited From CallAdapterCallOperations.mute
removeParticipant(string)
Remove a participant from the call.
function removeParticipant(userId: string): Promise<void>Parameters
- userId
-
string
Id of the participant to be removed
Returns
Promise<void>
Inherited From CallAdapterCallOperations.removeParticipant
startCamera(VideoStreamOptions)
Start the camera This method will start rendering a local camera view when the call is not active
function startCamera(options?: VideoStreamOptions): Promise<void>Parameters
- options
- VideoStreamOptions
Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Returns
Promise<void>
Inherited From CallAdapterCallOperations.startCamera
startScreenShare()
Start sharing the screen during a call.
function startScreenShare(): Promise<void>Returns
Promise<void>
Inherited From CallAdapterCallOperations.startScreenShare
stopCamera()
Stop the camera This method will stop rendering a local camera view when the call is not active
function stopCamera(): Promise<void>Returns
Promise<void>
Inherited From CallAdapterCallOperations.stopCamera
stopScreenShare()
Stop sharing the screen
function stopScreenShare(): Promise<void>Returns
Promise<void>
Inherited From CallAdapterCallOperations.stopScreenShare
unmute()
Unmute the current user during the call or enable microphone locally
function unmute(): Promise<void>Returns
Promise<void>
Inherited From CallAdapterCallOperations.unmute