Skip to main content

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:238

Returns

null | string

Set Signature

set AudioInputId(deviceId): void;

Defined in: sip-hass-card/src/sip-core.ts:242

Parameters
ParameterType
deviceIdnull | string
Returns

void


AudioOutputId

Get Signature

get AudioOutputId(): null | string;

Defined in: sip-hass-card/src/sip-core.ts:225

Returns

null | string

Set Signature

set AudioOutputId(deviceId): void;

Defined in: sip-hass-card/src/sip-core.ts:229

Parameters
ParameterType
deviceIdnull | string
Returns

void


callDuration

Get Signature

get callDuration(): string;

Defined in: sip-hass-card/src/sip-core.ts:215

Returns call duration in format 0:00

Returns

string


callState

Get Signature

get callState(): CALLSTATE;

Defined in: sip-hass-card/src/sip-core.ts:203

Returns

CALLSTATE


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:107

Returns

SIPCore

Methods

answerCall()

answerCall(): Promise<void>;

Defined in: sip-hass-card/src/sip-core.ts:349

Returns

Promise<void>


endCall()

endCall(): Promise<void>;

Defined in: sip-hass-card/src/sip-core.ts:358

Returns

Promise<void>


getAudioDevices()

getAudioDevices(audioKind): Promise<MediaDeviceInfo[]>;

Defined in: sip-hass-card/src/sip-core.ts:576

Returns a list of audio devices of the specified kind

Parameters

ParameterType
audioKindAUDIO_DEVICE_KIND

Returns

Promise<MediaDeviceInfo[]>


init()

init(): Promise<void>;

Defined in: sip-hass-card/src/sip-core.ts:279

Returns

Promise<void>


playIncomingRingtone()

playIncomingRingtone(): void;

Defined in: sip-hass-card/src/sip-core.ts:319

Returns

void


playOutgoingTone()

playOutgoingTone(): void;

Defined in: sip-hass-card/src/sip-core.ts:334

Returns

void


startCall()

startCall(extension): Promise<void>;

Defined in: sip-hass-card/src/sip-core.ts:363

Parameters

ParameterType
extensionstring

Returns

Promise<void>


stopIncomingRingtone()

stopIncomingRingtone(): void;

Defined in: sip-hass-card/src/sip-core.ts:327

Returns

void


stopOutgoingTone()

stopOutgoingTone(): void;

Defined in: sip-hass-card/src/sip-core.ts:342

Returns

void


triggerUpdate()

triggerUpdate(): void;

Defined in: sip-hass-card/src/sip-core.ts:368

Dispatches a sipcore-update event

Returns

void

Properties

PropertyTypeDescriptionDefined in
configSIPCoreConfig-sip-hass-card/src/sip-core.ts:91
hassany-sip-hass-card/src/sip-core.ts:89
incomingAudionull | HTMLAudioElement-sip-hass-card/src/sip-core.ts:104
outgoingAudionull | HTMLAudioElement-sip-hass-card/src/sip-core.ts:105
remoteAudioStreamnull | MediaStream-sip-hass-card/src/sip-core.ts:101
remoteVideoStreamnull | MediaStream-sip-hass-card/src/sip-core.ts:102
RTCSessionnull | RTCSessionThe current RTC session, if available See https://jssip.net/documentation/3.1.x/api/session/sip-hass-card/src/sip-core.ts:86
uaUAThe JSSIP User Agent instance See https://jssip.net/documentation/3.1.x/api/ua/sip-hass-card/src/sip-core.ts:80
userUser-sip-hass-card/src/sip-core.ts:90
versionstring-sip-hass-card/src/sip-core.ts:88