Expand description
Application-facing identities, station configuration, and call/media data.
These types sit above the raw message codec. Applications normally build a
DeviceDefinition, validate it, and pass it to
crate::server::Server::bind. Runtime events then refer to calls, lines,
conferences, and application transactions through the strongly typed IDs
in this module instead of interchangeable integers.
Structs§
- Addon
Module Definition - An expansion module and the station slot where it is attached.
- Appearance
Id - A stable identifier for one device’s appearance of a logical line.
- Application
Id - An SCCP application identifier.
- Audio
Processing Policy - Per-appearance station audio processing sent on the receive and transmit channel setup messages.
- BlfCaller
Info - Caller information that policy has permitted a monitored station to see.
- BlfSpeed
Dial Definition - A speed-dial button whose lamp and icon follow an external presence target.
- CallId
- Application-local call identifier.
- Call
Info - Party identity and redirection history presented for a call.
- Call
Reference - A device-visible call reference.
- Caller
IdOverride - Optional caller identity substitutions for one line appearance.
- Conference
Id - A conference identifier.
- Date
Template - Validated date and time display template advertised during registration.
- Device
Definition - Complete phone-facing configuration for one station.
- Device
Id - Exact SCCP station name, normally
SEPfollowed by twelve MAC digits. - Device
Registration - Negotiated identity and network metadata for a live station session.
- Feature
Definition - A programmable feature button and its station-visible label.
- Line
Appearance - One device’s configured presentation of a logical line.
- Line
Definition - A logical directory number and its default station label.
- Line
Instance - A line or button instance on a station.
- Media
Endpoint - RTP/RTCP endpoint and negotiated audio format for one media leg.
- Media
Traffic Class - ECN-zeroed traffic-class octet carried by station media commands.
- Participant
Id - A stable identifier for a participant in a conference.
- Passthrough
Party Id - A media passthrough-party identifier.
- Recording
Button Definition - A programmable feature button that controls handset-scoped call recording.
- Service
Definition - A programmable button that opens a phone-hosted HTTP service.
- Session
Generation - Monotonically allocated identity for one accepted station session.
- Signaling
Qos - Network-layer marking for station signaling traffic.
- Soft
KeyProfile - Ordered soft-key actions advertised for every known station key mode.
- Speed
Dial Definition - A programmable button that immediately dials a configured destination.
- Station
UiPolicy - Phone-facing behavior that can vary independently for each configured station without changing logical line ownership.
- Transaction
Id - An application transaction identifier.
Enums§
- Appearance
Ring Mode - Incoming-ring policy for a line appearance.
- BlfState
- Semantic state of a monitored speed-dial target.
- Button
Definition - One entry in a station’s ordered physical button layout.
- Call
Direction - Direction of a call relative to the station.
- Legacy
Code Page - Single-byte character set used for stations without native UTF-8 support. Characters outside the selected set are replaced during encoding.
- Station
Transport - Transport used by an accepted station session.
- Station
Transport Requirement - Transport admission policy configured for one station.
Constants§
- DEFAULT_
AUDIO_ MAX_ FRAMES_ PER_ PACKET - DEFAULT_
AUDIO_ PACKET_ MS - Default audio packetization interval, in milliseconds.