Home > sip.js > WebAudioSessionDescriptionHandler
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
A WebAudioSessionDescriptionHandler uses the Web Audio API to enable local conferencing of audio streams.
Signature:
export declare class WebAudioSessionDescriptionHandler extends SessionDescriptionHandler Extends: SessionDescriptionHandler
This handler only works for one track of audio per peer connection. While the session description handler being extended supports both audio and video, attempting to utilize video with this handler is not defined.
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(logger, mediaStreamFactory, sessionDescriptionHandlerConfiguration) | (BETA) Constructs a new instance of the WebAudioSessionDescriptionHandler class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| audioContext | static |
AudioContext | undefined | (BETA) |
| Method | Modifiers | Description |
|---|---|---|
| enableSenderTracks(enable) | (BETA) Helper function to enable/disable media tracks. | |
| initLocalMediaStream(stream) | (BETA) Returns a WebRTC MediaStream proxying the provided audio media stream. This allows additional Web Audio media stream source nodes to be connected to the destination node assoicated with the returned stream so we can mix aditional audio sorces into the local media stream (ie for 3-way conferencing). | |
| joinWith(peer) | (BETA) Join (conference) media streams with another party. | |
| setRealLocalMediaStream(stream) | (BETA) Sets the original local media stream. |