amazon-ivs-web-broadcast
Amazon Interactive Video Service (Amazon IVS) web broadcast SDK gives you the ability to capture live video from web browsers and send as an input to an Amazon IVS channel or stage. You can include it on new and existing websites, with support for both desktop and mobile web browsers.
Remarks
The SDK enables one to broadcast to a low-latency IVS channel (HLS) and/or broadcast and playback to a real-time IVS stage (WebRTC).
To get started, see the relevant getting started guides for low-latency and real-time streaming.
Namespaces
Enumerations
- ConnectionState
- LogLevels
- StageConnectionState
- StageErrorCategory
- StageErrorCode
- StageEvents
- StageParticipantPublishState
- StageParticipantSubscribeState
- StreamType
- SubscribeType
Classes
Interfaces
- BroadcastClientConfig
- BroadcastClientEventPayloads
- CanvasDimensions
- DefaultConfig
- Emitter
- ErrorLogParams
- LogParams
- Logger
- LoggerParams
- NetworkReconnectConfig
- ResolutionConfig
- SimulcastConfiguration
- StageAudioConfiguration
- StageError
- StageStrategy
- StageVideoConfiguration
- StreamConfig
- VideoComposition
- VideoDevice
Other Variables
Stream Config Variables
- BASIC_FULL_HD_LANDSCAPE
- BASIC_FULL_HD_PORTRAIT
- BASIC_LANDSCAPE
- BASIC_PORTRAIT
- STANDARD_LANDSCAPE
- STANDARD_PORTRAIT
References
LOG_LEVEL
Renames and re-exports LogLevels
Type Aliases
Callback
Ƭ Callback: () => unknown
Type declaration
▸ (): unknown
Returns
unknown
ConfigurationInstance
Ƭ ConfigurationInstance: Partial<BroadcastClientConfig> & DefaultConfig
ErrorFn
Ƭ ErrorFn: (args: ErrorLogParams) => void
Type declaration
▸ (args): void
Parameters
| Name | Type |
|---|---|
args | ErrorLogParams |
Returns
void
LogFn
Ƭ LogFn: (args: LogParams) => void
Type declaration
▸ (args): void
Parameters
| Name | Type |
|---|---|
args | LogParams |
Returns
void
Maybe
Ƭ Maybe<T>: T | undefined
Type parameters
| Name |
|---|
T |
StageParticipantInfo
Ƭ StageParticipantInfo: Object
Type declaration
| Name | Type |
|---|---|
attributes | Record<string, unknown> |
audioMuted | boolean |
capabilities | Set<StageParticipantCapabilities> |
id | string |
isLocal | boolean |
isPublishing | boolean |
userId | string |
userInfo | Record<string, unknown> |
videoStopped | boolean |
Other Variables
BroadcastClientEvents
• Const BroadcastClientEvents: Object
An enumeration describing the events emitted from the AmazonIVSBroadcastClient.
Type declaration
| Name | Type | Description |
|---|---|---|
ACTIVE_STATE_CHANGE | "activeStateChange" | Indicates that the broadcast start/stop state has changed. Param boolean activeStateChanged |
CONNECTION_STATE_CHANGE | "connectionStateChange" | Indicates that the webRTC connection state has changed. Param ConnectionState connectionStateChange |
ERROR | "clientError" | Indicates that the client has encountered an error. Param BroadcastClientError clientError |
__version
• Const __version: string
Stream Config Variables
BASIC_FULL_HD_LANDSCAPE
• Const BASIC_FULL_HD_LANDSCAPE: StreamConfig
A static landscape stream configuration for a Basic 1080p IVS account.
BASIC_FULL_HD_PORTRAIT
• Const BASIC_FULL_HD_PORTRAIT: StreamConfig
A static portrait stream configuration for a Basic 1080p IVS account.
BASIC_LANDSCAPE
• Const BASIC_LANDSCAPE: StreamConfig
A static landscape stream configuration for a Basic IVS account.
BASIC_PORTRAIT
• Const BASIC_PORTRAIT: StreamConfig
A static portrait stream configuration for a Basic IVS account.
STANDARD_LANDSCAPE
• Const STANDARD_LANDSCAPE: StreamConfig
A static landscape stream configuration for a Standard IVS account.
STANDARD_PORTRAIT
• Const STANDARD_PORTRAIT: StreamConfig
A static portrait stream configuration for a Standard IVS account.
Functions
create
▸ create(broadcastConfig): AmazonIVSBroadcastClient
Parameters
| Name | Type |
|---|---|
broadcastConfig | BroadcastClientConfig |
Returns
isSupported
▸ isSupported(): boolean
Check for feature support in current environment.
Returns
boolean