Index of Alaznah Calling public APIs — hooks, client, props, and UI.
API Overview
Public surface of @alaznah/calling.
Guides by concern
| Topic | Page |
|---|---|
| React hooks | Hooks |
CallingClient methods & events | Client Methods |
| Provider / screen props | Props |
| Component catalog | UI Components |
Concepts
| Concept | Description |
|---|---|
CallingProvider | React context that owns the client lifecycle |
CallingClient | Imperative API: connect, start/accept/end, media, push |
ActiveCall | Snapshot of an inbound or outbound call |
CallingScreen / CallingUI | Built-in UI entry points |
| Hosted Signaling | Default wss://signal.alaznah.com when signalingUrl omitted |
Common imports
import {
// App shell
CallingProvider,
CallingScreen,
CallingUI,
// Hooks
useCallingClient,
useCall,
useIncomingCall,
useCallingReady,
useCallQuality,
useWakingForCall,
// Client factory (non-React)
createCallingClient,
// Permissions & defaults
requestCallPermissions,
DEFAULT_HOSTED_SIGNALING_URL,
// Media views
LocalVideoView,
RemoteVideoView,
} from '@alaznah/calling';Optional UI barrel:
import { IncomingCallScreen, ActiveCallScreen, CallControls } from '@alaznah/calling/ui';Product guides
Prefer the narrative docs for workflows: Quick Start, Incoming Calls, Call UI.