amazon-ivs-web-broadcast
Web Broadcasting SDK for Amazon Interactive Video Service
Namespaces
Enumerations
Classes
Interfaces
- BroadcastClientConfig
- BroadcastClientEventPayloads
- CanvasDimensions
- DefaultConfig
- Emitter
- ErrorLogParams
- LogParams
- Logger
- LoggerParams
- ResolutionConfig
- StreamConfig
- VideoComposition
- VideoDevice
Other Variables
Stream Config Variables
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
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]] |
CONNECTION_STATE_CHANGE | "connectionStateChange" | Indicates that the webRTC connection state has changed. param ConnectionState |
ERROR | "clientError" | Indicates that the client has encountered an error. param [[BroadcastClientError]] |
Stream Config Variables
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.