Skip to main content
Version: v1.12.0

amazon-ivs-web-broadcast

Web Broadcasting SDK for Amazon Interactive Video Service

Namespaces

Enumerations

Classes

Interfaces

Other Variables

Stream Config Variables

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
NameType
argsErrorLogParams
Returns

void


LogFn

Ƭ LogFn: (args: LogParams) => void

Type declaration

▸ (args): void

Parameters
NameType
argsLogParams
Returns

void


Maybe

Ƭ Maybe<T>: T | undefined

Type parameters

Name
T

PublishResponse

Ƭ PublishResponse: Promise<{ peerConnection: RTCPeerConnection }>


StageParticipantInfo

Ƭ StageParticipantInfo: Object

Type declaration

NameType
attributesRecord<string, unknown>
audioMutedboolean
capabilitiesSet<StageParticipantCapabilities>
idstring
isLocalboolean
isPublishingboolean
userIdstring
userInfoRecord<string, unknown>
videoStoppedboolean

SubscribeRequest

Ƭ SubscribeRequest: Object

Type declaration

NameType
identifierstring
silentAudioTrack?MediaStreamTrack
token?string

SubscribeResponse

Ƭ SubscribeResponse: Promise<{ peerConnection: RTCPeerConnection }>


TraceRequest

Ƭ TraceRequest: Object

Type declaration

NameType
messagestring
remoteParticipantID?string
tokenstring

Other Variables

BroadcastClientEvents

Const BroadcastClientEvents: Object

An enumeration describing the events emitted from the AmazonIVSBroadcastClient.

Type declaration

NameTypeDescription
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

NameType
broadcastConfigBroadcastClientConfig

Returns

AmazonIVSBroadcastClient


isSupported

isSupported(): boolean

Check for feature support in current environment.

Returns

boolean