SIPCore
Defined in: sip-hass-card/src/sip-core.ts:73
Main class for SIP Core functionality. Handles SIP registration, call management, and audio device management.
Accessors
callDuration
Get Signature
get callDuration(): string;
Defined in: sip-hass-card/src/sip-core.ts:174
Returns call duration in format 0:00
Returns
string
callState
Get Signature
get callState(): CALLSTATE;
Defined in: sip-hass-card/src/sip-core.ts:162
Returns
registered
Get Signature
get registered(): boolean;
Defined in: sip-hass-card/src/sip-core.ts:158
Returns
boolean
remoteExtension
Get Signature
get remoteExtension(): null | string;
Defined in: sip-hass-card/src/sip-core.ts:149
Returns the remote extension. Returns null if not in a call
Returns
null | string
remoteName
Get Signature
get remoteName(): null | string;
Defined in: sip-hass-card/src/sip-core.ts:154
Returns the remote display name if available, otherwise the extension. Returns null if not in a call
Returns
null | string
Constructors
Constructor
new SIPCore(): SIPCore;
Defined in: sip-hass-card/src/sip-core.ts:103
Returns
SIPCore
Methods
answerCall()
answerCall(): void;
Defined in: sip-hass-card/src/sip-core.ts:256
Returns
void
endCall()
endCall(): void;
Defined in: sip-hass-card/src/sip-core.ts:265
Returns
void
getAudioDevices()
getAudioDevices(audioKind): Promise<MediaDeviceInfo[]>;
Defined in: sip-hass-card/src/sip-core.ts:472
Returns a list of audio devices of the specified kind
Parameters
| Parameter | Type |
|---|---|
audioKind | AUDIO_DEVICE_KIND |
Returns
Promise<MediaDeviceInfo[]>
init()
init(): Promise<void>;
Defined in: sip-hass-card/src/sip-core.ts:218
Returns
Promise<void>
setAudioDevice()
setAudioDevice(deviceId, audioKind): Promise<void>;
Defined in: sip-hass-card/src/sip-core.ts:489
Sets the audio device for the specified kind
Parameters
| Parameter | Type |
|---|---|
deviceId | string |
audioKind | AUDIO_DEVICE_KIND |
Returns
Promise<void>
Example
const audio_devices = await sipCore.getAudioDevices(AUDIO_DEVICE_KIND.INPUT);
await sipCore.setAudioDevice(audio_devices[0].deviceId, AUDIO_DEVICE_KIND.INPUT);
startCall()
startCall(extension): void;
Defined in: sip-hass-card/src/sip-core.ts:270
Parameters
| Parameter | Type |
|---|---|
extension | string |
Returns
void
triggerUpdate()
triggerUpdate(): void;
Defined in: sip-hass-card/src/sip-core.ts:275
Dispatches a sipcore-update event
Returns
void
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
config | SIPCoreConfig | - | sip-hass-card/src/sip-core.ts:87 |
currentAudioInputId | null | string | - | sip-hass-card/src/sip-core.ts:98 |
currentAudioOutputId | null | string | - | sip-hass-card/src/sip-core.ts:99 |
hass | any | - | sip-hass-card/src/sip-core.ts:85 |
remoteAudioStream | null | MediaStream | - | sip-hass-card/src/sip-core.ts:100 |
remoteVideoStream | null | MediaStream | - | sip-hass-card/src/sip-core.ts:101 |
RTCSession | null | RTCSession | The current RTC session, if available See https://jssip.net/documentation/3.1.x/api/session/ | sip-hass-card/src/sip-core.ts:83 |
ua | UA | The JSSIP User Agent instance See https://jssip.net/documentation/3.1.x/api/ua/ | sip-hass-card/src/sip-core.ts:78 |
user | User | - | sip-hass-card/src/sip-core.ts:86 |
version | string | - | sip-hass-card/src/sip-core.ts:84 |