Home > @rainway/web > IClientCapabilities
IClientCapabilities interface
A client reports its capabilities to a peer.
The "supported" values indicate all configurations that will work for this client, but the "preferred" value will be chosen if possible (e.g. by a host in a 1:1 setting.)
Signature:
export interface IClientCapabilities
Properties
| Property | Type | Description |
|---|---|---|
| preferredAudioBitrate | number | The client's preferred audio bitrate. |
| preferredAudioChannels | AudioChannels | The client's preferred audio channels setting. |
| preferredAudioConfig | IAudioConfig | The client's preferred audio codec/container combination. |
| preferredFps | number | The client's preferred FPS. |
| preferredHeight | number | The client's preferred stream height in pixels. |
| preferredVideoBitrate | number | The client's preferred video bitrate. The rate controller may move up and down from this initial value. |
| preferredVideoConfig | IVideoConfig | The client's preferred video codec/container combination. |
| preferredWidth | number | The client's preferred stream width in pixels. |
| supportedAudioChannels | Array<AudioChannels> | List of supported audio channels settings. |
| supportedAudioConfigs | Array<IAudioConfig> | List of supported audio codec/container combinations. |
| supportedVideoConfigs | Array<IVideoConfig> | List of supported video codec/container combinations. |
| supportsAppIsolation | boolean | Whether this client supports app isolated stream sessions. |
| supportsOver1080P | boolean | Whether this client can handle >1080p video. |
| supportsTemporalScaling | boolean | Whether this client supports temporalScaleFactor != 1.0. |