Interface BrowserBehavior

interface BrowserBehavior {
    deviceName(): string;
    hasChromiumWebRTC(): boolean;
    hasFirefoxWebRTC(): boolean;
    isSupported(): boolean;
    majorVersion(): number;
    name(): string;
    osName(): string;
    osVersion(): string;
    requiresBundlePolicy(): RTCBundlePolicy;
    requiresCheckForSdpConnectionAttributes(): boolean;
    requiresIceCandidateGatheringTimeoutWorkaround(): boolean;
    requiresNoExactMediaStreamConstraints(): boolean;
    supportedVideoCodecs(): Promise<string[]>;
    supportsCanvasCapturedStreamPlayback(): boolean;
    supportsSetSinkId(): boolean;
    supportString(): string;
    updateWithHighEntropyValues(alwaysOverride: true): Promise<void>;
    version(): string;
}

Hierarchy (View Summary)

BrowserBehavior
- ExtendedBrowserBehavior

Implemented by

DefaultBrowserBehavior

Index

Methods

deviceName? hasChromiumWebRTC hasFirefoxWebRTC isSupported majorVersion name osName? osVersion? requiresBundlePolicy requiresCheckForSdpConnectionAttributes requiresIceCandidateGatheringTimeoutWorkaround requiresNoExactMediaStreamConstraints supportedVideoCodecs supportsCanvasCapturedStreamPlayback supportsSetSinkId supportString updateWithHighEntropyValues? version

Methods

`Optional`deviceName

deviceName(): string
Returns the device name/model. Returns empty string if not available.

Returns string
- Defined in src/browserbehavior/BrowserBehavior.ts:23

hasChromiumWebRTC

hasChromiumWebRTC(): boolean
Returns whether the browser has a Chromium WebRTC implementation

Returns boolean
- Defined in src/browserbehavior/BrowserBehavior.ts:38

hasFirefoxWebRTC

hasFirefoxWebRTC(): boolean
Returns whether the browser has a Firefox WebRTC implementation

Returns boolean
- Defined in src/browserbehavior/BrowserBehavior.ts:43

isSupported

isSupported(): boolean
Returns whether the browser is supported

Returns boolean
- Defined in src/browserbehavior/BrowserBehavior.ts:68

majorVersion

majorVersion(): number
Returns the major version of the detected browser

Returns number
- Defined in src/browserbehavior/BrowserBehavior.ts:13

name

name(): string
Returns the browser name

Returns string
- Defined in src/browserbehavior/BrowserBehavior.ts:18

`Optional`osName

osName(): string
Returns the operating system name. Returns empty string if not available.

Returns string
- Defined in src/browserbehavior/BrowserBehavior.ts:28

`Optional`osVersion

osVersion(): string
Returns the operating system version. Returns empty string if not available.

Returns string
- Defined in src/browserbehavior/BrowserBehavior.ts:33

requiresBundlePolicy

requiresBundlePolicy(): RTCBundlePolicy
Returns the bundle policy for the browser

Returns RTCBundlePolicy
- Defined in src/browserbehavior/BrowserBehavior.ts:53

requiresCheckForSdpConnectionAttributes

requiresCheckForSdpConnectionAttributes(): boolean
Returns whether it is needed to check connection attributes in SDP

Returns boolean
- Defined in src/browserbehavior/BrowserBehavior.ts:58

requiresIceCandidateGatheringTimeoutWorkaround

requiresIceCandidateGatheringTimeoutWorkaround(): boolean
Returns whether the browser requires an ICE connection gathering timeout workaround

Returns boolean
- Defined in src/browserbehavior/BrowserBehavior.ts:48

requiresNoExactMediaStreamConstraints

requiresNoExactMediaStreamConstraints(): boolean
Returns whether the keyword "exact" should be omitted in a MediaStreamConstraints object

Returns boolean
- Defined in src/browserbehavior/BrowserBehavior.ts:63

supportedVideoCodecs

supportedVideoCodecs(): Promise<string[]>
Returns the supported codecs

Returns Promise<string[]>
- Defined in src/browserbehavior/BrowserBehavior.ts:78

supportsCanvasCapturedStreamPlayback

supportsCanvasCapturedStreamPlayback(): boolean
Returns whether browser supports the playback of canvas-captured stream.

Returns boolean
- Defined in src/browserbehavior/BrowserBehavior.ts:88

supportsSetSinkId

supportsSetSinkId(): boolean
Returns whether browser supports setSinkId operation

Returns boolean
- Defined in src/browserbehavior/BrowserBehavior.ts:83

supportString

supportString(): string
Returns the browser support string

Returns string
- Defined in src/browserbehavior/BrowserBehavior.ts:73

`Optional`updateWithHighEntropyValues

updateWithHighEntropyValues(alwaysOverride: true): Promise<void>
Updates internal values using the User-Agent Client Hints API. If the API is not available, resolves without making changes.
Parameters
- alwaysOverride: true
  indicates if the values should be updated even if they were already set. Examples of value changes:
  
  osName: "Mac OS" → "macOS"
  
  osVersion: "10.15" → "15.7.1"
  
  browserName: "Chrome" → "Google Chrome"
  
  browserVersion: "120.0.0.0" → "120.0.6099.129"
Returns Promise<void>
Promise that resolves when update is complete
- Defined in src/browserbehavior/BrowserBehavior.ts:103

version

version(): string
Returns the version string of the detected browser

Returns string
- Defined in src/browserbehavior/BrowserBehavior.ts:8

Interface BrowserBehavior

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

OptionaldeviceName

Returns string

hasChromiumWebRTC

Returns boolean

hasFirefoxWebRTC

Returns boolean

isSupported

Returns boolean

majorVersion

Returns number

name

Returns string

OptionalosName

Returns string

OptionalosVersion

Returns string

requiresBundlePolicy

Returns RTCBundlePolicy

requiresCheckForSdpConnectionAttributes

Returns boolean

requiresIceCandidateGatheringTimeoutWorkaround

Returns boolean

requiresNoExactMediaStreamConstraints

Returns boolean

supportedVideoCodecs

Returns Promise<string[]>

supportsCanvasCapturedStreamPlayback

Returns boolean

supportsSetSinkId

Returns boolean

supportString

Returns string

OptionalupdateWithHighEntropyValues

Parameters

Returns Promise<void>

version

Returns string

Settings

On This Page

`Optional`deviceName

`Optional`osName

`Optional`osVersion

`Optional`updateWithHighEntropyValues