UNPKG

1.11 kBMarkdownView Raw
1The Cyph SDK allows third-party services to initiate new cyph sessions
2from either a browser or a Node.js server.
3
4The following optional features are supported:
5
6* `Cyph.options.voice`: Goes directly into a voice call
7
8* `Cyph.options.video`: Goes directly into a video call
9
10* `Cyph.options.modestBranding`: Uses modest branding (greyscale UI with toned down Cyph branding)
11
12* `Cyph.options.disableP2P`: Disables P2P networking for voice/video calls, with traffic instead
13routed through Twilio's low-latency network traversal infrastructure
14
15* `Cyph.options.nativeCrypto`: Switches from our default cross-browser cryptographic primitives to a
16set of FIPS-approved primitives natively implemented by Google Chrome and Mozilla Firefox
17
18Example uses:
19
20 Cyph.initiateSession() // "https://cyph.im/#2D2gzbqggQxTaanHZYbDXb8fVr"
21
22 Cyph.initiateSession([Cyph.options.voice]) // "https://cyph.audio/#1nckgXAumVXWjmwrYdSjXaZGW"
23
24 Cyph.initiateSession([
25 Cyph.options.video,
26 Cyph.options.modestBranding,
27 Cyph.options.disableP2P,
28 Cyph.options.nativeCrypto
29 ]) // "https://cyph.video/#&$%1ro2HQ4q7wBbC7hHCF2oWggVGe"