SIPCore
Defined in: sip-hass-card/src/sip-core.ts:75
Main class for SIP Core functionality. Handles SIP registration, call management, and audio device management.
Accessors
AudioInputId
Get Signature
get AudioInputId(): null | string;
Defined in: sip-hass-card/src/sip-core.ts:231
Returns
null | string
Set Signature
set AudioInputId(deviceId): void;
Defined in: sip-hass-card/src/sip-core.ts:235
Parameters
| Parameter | Type |
|---|---|
deviceId | null | string |
Returns
void
AudioOutputId
Get Signature
get AudioOutputId(): null | string;
Defined in: sip-hass-card/src/sip-core.ts:218
Returns
null | string
Set Signature
set AudioOutputId(deviceId): void;
Defined in: sip-hass-card/src/sip-core.ts:222
Parameters
| Parameter | Type |
|---|---|
deviceId | null | string |
Returns
void
callDuration
Get Signature
get callDuration(): string;
Defined in: sip-hass-card/src/sip-core.ts:208
Returns call duration in format 0:00
Returns
string
callState
Get Signature
get callState(): CALLSTATE;
Defined in: sip-hass-card/src/sip-core.ts:196
Returns
registered
Get Signature
get registered(): boolean;
Defined in: sip-hass-card/src/sip-core.ts:151
Returns
boolean
remoteExtension
Get Signature
get remoteExtension(): null | string;
Defined in: sip-hass-card/src/sip-core.ts:142
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:147
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:107
Returns
SIPCore
Methods
answerCall()
answerCall(): Promise<void>;
Defined in: sip-hass-card/src/sip-core.ts:356
Returns
Promise<void>
endCall()
endCall(): Promise<void>;
Defined in: sip-hass-card/src/sip-core.ts:365
Returns
Promise<void>
getAudioDevices()
getAudioDevices(audioKind): Promise<MediaDeviceInfo[]>;
Defined in: sip-hass-card/src/sip-core.ts:592
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:272
Returns
Promise<void>
playIncomingRingtone()
playIncomingRingtone(): void;
Defined in: sip-hass-card/src/sip-core.ts:326
Returns
void
playOutgoingTone()
playOutgoingTone(): void;
Defined in: sip-hass-card/src/sip-core.ts:341
Returns
void
startCall()
startCall(extension): Promise<void>;
Defined in: sip-hass-card/src/sip-core.ts:370
Parameters
| Parameter | Type |
|---|---|
extension | string |
Returns
Promise<void>
stopIncomingRingtone()
stopIncomingRingtone(): void;
Defined in: sip-hass-card/src/sip-core.ts:334
Returns
void
stopOutgoingTone()
stopOutgoingTone(): void;
Defined in: sip-hass-card/src/sip-core.ts:349
Returns
void
triggerUpdate()
triggerUpdate(): void;
Defined in: sip-hass-card/src/sip-core.ts:375
Dispatches a sipcore-update event
Returns
void
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
config | SIPCoreConfig | - | sip-hass-card/src/sip-core.ts:91 |
hass | any | - | sip-hass-card/src/sip-core.ts:89 |
incomingAudio | null | HTMLAudioElement | - | sip-hass-card/src/sip-core.ts:104 |
outgoingAudio | null | HTMLAudioElement | - | sip-hass-card/src/sip-core.ts:105 |
remoteAudioStream | null | MediaStream | - | sip-hass-card/src/sip-core.ts:101 |
remoteVideoStream | null | MediaStream | - | sip-hass-card/src/sip-core.ts:102 |
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:86 |
ua | UA | The JSSIP User Agent instance See https://jssip.net/documentation/3.1.x/api/ua/ | sip-hass-card/src/sip-core.ts:80 |
user | User | - | sip-hass-card/src/sip-core.ts:90 |
version | string | - | sip-hass-card/src/sip-core.ts:88 |