@signalwire/js
Version:
87 lines • 4.53 kB
TypeScript
/**
* Welcome to the technical documentation for the JavaScript SDK.
*
* At the outer level, when you import the SignalWire JS library you get access
* to three different namespaces:
*
* - {@link Video}
* - {@link Chat}
* - {@link WebRTC}
*
* Video gives you access to the classes and methods that let you
* interface with the backend Video APIs. Chat gives you access to the classes and functions that you need to create a real-time chat application. WebRTC
* contains several functions that are useful for interacting with the hardware of the user's device.
*
*
* Don't know where to start? Create an instance of
* {@link Video.RoomSession} to join a room, use the {@link Chat.Client} constructor to start a chat application, or take a look at [Getting Started
* with the SignalWire Video
* API](https://developer.signalwire.com/apis/docs/getting-started-with-the-signalwire-video-api-1).
*
* @module
*/
import type { VideoRoomSessionEventNames, RoomStarted, RoomSubscribed, RoomUpdated, RoomEnded, VideoMemberEntity } from '@signalwire/core';
/** @ignore @deprecated */
export type RoomStartedEventName = RoomStarted;
/** @ignore @deprecated */
export type RoomEndedEventName = RoomEnded;
/** @ignore @deprecated */
export type RoomSubscribedEventName = RoomSubscribed;
/** @ignore @deprecated */
export type RoomUpdatedEventName = RoomUpdated;
/** @ignore @deprecated */
export type RoomEvent = VideoRoomSessionEventNames;
/** @ignore @deprecated */
export type RoomMember = VideoMemberEntity & {
type: 'member';
};
/** @ignore @deprecated */
export type RoomScreenShare = VideoMemberEntity & {
type: 'screen';
};
/** @ignore @deprecated */
export type RoomDevice = VideoMemberEntity & {
type: 'device';
};
/**
* The Chat namespace contains the classes and functions that you need to
* create a real-time chat application.
*/
export * as Chat from './chat';
export * as PubSub from './pubSub';
/**
* The Fabric namespace contains the classes and functions that you need to
* create a unified communication application that includes Audio/Video calling
* with Chat/Messaging capabilties.
*/
export * as Fabric from './fabric';
export { SignalWire } from './fabric';
export * from './fabric/interfaces';
/**
* The Video namespace contains the classes and functions that you need to
* create a video conferencing application.
*/
export * as Video from './video';
export { VideoRoomSession } from './video';
export { RoomSessionScreenShare } from './RoomSessionScreenShare';
export { RoomSessionDevice } from './RoomSessionDevice';
/**
* The WebRTC namespace includes functions that give you access to the input and
* output media devices available on the user's machine. For example, you can
* use these functions to request permission and get access to the media stream
* from a webcam, from a microphone, or from a screen sharing.
*/
export * as WebRTC from './webrtc';
export type { BaseComponentOptions, BaseConnectionState, ClientEvents, EmitterContract, RTCTrackEventName, UserOptions, SessionStatus, SessionEvents, VideoLayout, InternalVideoLayout, VideoLayoutEventNames, VideoLayoutChangedEventParams, VideoRoomSessionEventNames, VideoRoomEventParams, VideoRoomSubscribedEventParams, VideoMemberEntity, VideoMemberEventNames, MemberTalkingEventNames, VideoMemberTalkingEventParams, InternalVideoMemberEntity, InternalVideoLayoutLayer, VideoPosition, VideoPositions,
/**
* Call Fabric types
*/
CallUpdatedEventParams, CallLeftEventParams, CallStateEventParams, CallPlayEventParams, CallConnectEventParams, CallRoomEventParams, FabricRoomEventParams, FabricLayoutChangedEventParams, FabricMemberJoinedEventParams, FabricMemberUpdatedEventParams, FabricMemberLeftEventParams, FabricMemberTalkingEventParams, FabricMemberEventParams, FabricMemberEntity, InternalFabricMemberEntity, ConversationMessageEventName, ConversationMessageEvent, ConversationEventParams, ConversationEvent, } from '@signalwire/core';
export type { BaseConnectionOptions, ConnectionOptions, } from '@signalwire/webrtc';
export type { CallJoinedEventParams, RoomSessionObjectEventsHandlerMap, RoomSessionObjectEvents, RoomSessionObjectEventsHandlerMap as RoomObjectEventsHandlerMap, RoomSessionObjectEvents as RoomObjectEvents, RoomEventNames, StartScreenShareOptions, } from './utils/interfaces';
/**
* Build Video Element
*/
export { buildVideoElement } from './buildVideoElement';
export { LocalVideoOverlay, OverlayMap, UserOverlay } from './VideoOverlays';
//# sourceMappingURL=index.d.ts.map