Web Express SDK - PhenixRTS Docs
Express Web SDK
Our Express APIs provide a simple, single-step API for the easiest integration of streaming into your application.
Common Use Cases
- Channel (one to many) -> Channel
- Group Broadcast (few to many) -> Room
- Group Chat (many to many) -> Room
- One to One Chat -> Room
Features
The list of features that you would like to support in order of preference. If a feature is not supported for playback on a device OR the published stream does not have that feature enabled (via capabilities), then the SDK will fall back to the next feature.
The Features pattern is only supported when using the RoomExpress or ChannelExpress APIs.
Default Features
By default, our SDK uses ['real-time', 'dash', 'hls'].
Supported Features
| Type | Description |
|---|---|
| real-time | Use Web RTC for delivery |
| rtmp | Use rtmp (flash player required) for delivery |
| dash | Use dash for delivery (requires MSE support) |
| hls | Use hls for delivery (requires MSE or Native HLS) |
Enabling only real-time playback
Pass ['real-time'] as the features to the ChannelExpress or RoomExpress constructor options.
const channelExpress = new sdk.express.ChannelExpress({
features: ['real-time'],
});