Alaznah

Index of Alaznah Calling public APIs — hooks, client, props, and UI.

API Overview

Public surface of @alaznah/calling.

Guides by concern

TopicPage
React hooksHooks
CallingClient methods & eventsClient Methods
Provider / screen propsProps
Component catalogUI Components

Concepts

ConceptDescription
CallingProviderReact context that owns the client lifecycle
CallingClientImperative API: connect, start/accept/end, media, push
ActiveCallSnapshot of an inbound or outbound call
CallingScreen / CallingUIBuilt-in UI entry points
Hosted SignalingDefault wss://signal.alaznah.com when signalingUrl omitted

Common imports

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

ts
import { IncomingCallScreen, ActiveCallScreen, CallControls } from '@alaznah/calling/ui';

Product guides

Prefer the narrative docs for workflows: Quick Start, Incoming Calls, Call UI.